Newer
Older
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::Cloud
Description
SourceFiles
Cloud.C
CloudIO.C
\*---------------------------------------------------------------------------*/
#ifndef Cloud_H
#define Cloud_H
#include "cloud.H"
#include "IDLList.H"
#include "IOField.H"
#include "polyMeshInfo.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
template<class ParticleType>
class Cloud;
template<class ParticleType>
Ostream& operator<<
(
Ostream&,
const Cloud<ParticleType>&
);
/*---------------------------------------------------------------------------*\
Class Cloud Declaration
\*---------------------------------------------------------------------------*/
template<class ParticleType>
class Cloud
:
public cloud,
public IDLList<ParticleType>
{
// Private data
const polyMesh& polyMesh_;
const faceList& allFaces_;
const vectorField& points_;
const cellList& cellFaces_;
const vectorField& allFaceCentres_;
const unallocLabelList& owner_;
const unallocLabelList& neighbour_;
//- Mesh information object
const polyMeshInfo meshInfo_;
// Private member functions
//- Initialise cloud on IO constructor
void initCloud(const bool checkClass);
public:
template<class ParticleT>
friend class Particle;
typedef ParticleType particleType;
typedef typename IDLList<ParticleType>::iterator iterator;
typedef typename IDLList<ParticleType>::const_iterator const_iterator;
//-Runtime type information
TypeName("Cloud");
// Constructors
//- Construct from mesh and a list of particles
Cloud
(
const polyMesh& mesh,
const IDLList<ParticleType>& particles
);
//- Construct from mesh, cloud name, and a list of particles
Cloud
(
const polyMesh& mesh,
const word& cloudName,
const IDLList<ParticleType>& particles
);
//- Construct from mesh by reading from file
// Optionally disable checking of class name for post-processing
Cloud
(
const polyMesh& mesh,
const bool checkClass = true
);
//- Construct from mesh by reading from file with given cloud instance
// Optionally disable checking of class name for post-processing
Cloud
(
const polyMesh& pMesh,
const word& cloudName,
const bool checkClass = true
);
// Member Functions
// Access
//- Return the polyMesh reference
const polyMesh& pMesh() const
{
return polyMesh_;
}
//- Is this global face an internal face?
bool internalFace(const label facei) const
{
return polyMesh_.isInternalFace(facei);
}
//- Is this global face a boundary face?
bool boundaryFace(const label facei) const
{
return !internalFace(facei);
}
//- Which patch is this global face on
label facePatch(const label facei) const
{
return polyMesh_.boundaryMesh().whichPatch(facei);
}
//- Which face of this patch is this global face
label patchFace(const label patchi, const label facei) const
{
return polyMesh_.boundaryMesh()[patchi].whichFace(facei);
}
//- Return reference to the mesh information object
const polyMeshInfo& meshInfo() const
{
return meshInfo_;
}
{
return IDLList<ParticleType>::size();
};
const const_iterator begin() const
{
return IDLList<ParticleType>::begin();
};
const const_iterator cbegin() const
{
return IDLList<ParticleType>::cbegin();
};
const const_iterator end() const
{
return IDLList<ParticleType>::end();
};
const const_iterator cend() const
{
return IDLList<ParticleType>::cend();
};
iterator begin()
{
return IDLList<ParticleType>::begin();
};
iterator end()
{
return IDLList<ParticleType>::end();
};
void clear()
{
return IDLList<ParticleType>::clear();
};
// Edit
//- Transfer particle to cloud
void addParticle(ParticleType* pPtr);
//- Remove particle from cloud and delete
void deleteParticle(ParticleType&);
//- Move the particles
// passing the TrackingData to the track function
template<class TrackingData>
void move(TrackingData& td);
//- Remap the cells of particles corresponding to the
// mesh topology change
virtual void autoMap(const mapPolyMesh&);
// Read
//- Helper to construct IOobject for field and current time.
IOobject fieldIOobject
(
const word& fieldName,
const IOobject::readOption r
) const;
//- Check lagrangian data field
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
template<class DataType>
void checkFieldIOobject
(
const Cloud<ParticleType>& c,
const IOField<DataType>& data
) const;
//- Read the field data for the cloud of particles
void readFields();
// Write
//- Write the field data for the cloud of particles
virtual void writeFields() const;
//- Write using given format, version and compression.
// Only writes the cloud file if the Cloud isn't empty
virtual bool writeObject
(
IOstream::streamFormat fmt,
IOstream::versionNumber ver,
IOstream::compressionType cmp
) const;
// Ostream Operator
friend Ostream& operator<< <ParticleType>
(
Ostream&,
const Cloud<ParticleType>&
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
# include "Cloud.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //