indexedParticleCloud.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::indexedParticleCloud
26 
27 Description
28  A Cloud of particles carrying an additional index.
29 
30 SourceFiles
31  indexedParticleCloud.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef indexedParticleCloud_H
36 #define indexedParticleCloud_H
37 
38 #include "Cloud.H"
39 #include "indexedParticle.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class indexedParticleCloud Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public Cloud<indexedParticle>
53 {
54 public:
55 
56  //- Runtime type information
57  TypeName("indexedParticleCloud");
58 
59 
60  // Constructors
61 
62  //- Construct given mesh
64  (
65  const polyMesh&,
66  const word& cloudName = "defaultCloud",
67  bool readFields = true
68  );
69 
70  //- Disallow default bitwise copy construction
72 
73 
74  // Member Operators
75 
76  //- Disallow default bitwise assignment
77  void operator=(const indexedParticleCloud&) = delete;
78 };
79 
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 } // End namespace Foam
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 #endif
88 
89 // ************************************************************************* //
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const HashSet< word > &selectedFields, LIFOStack< regIOobject *> &storedObjects)
Read the selected GeometricFields of the specified type.
Definition: ReadFields.C:244
A Cloud of particles carrying an additional index.
void operator=(const indexedParticleCloud &)=delete
Disallow default bitwise assignment.
indexedParticleCloud(const polyMesh &, const word &cloudName="defaultCloud", bool readFields=true)
Construct given mesh.
A class for handling words, derived from string.
Definition: word.H:59
Base cloud calls templated on particle type.
Definition: Cloud.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:76
const word cloudName(propsDict.lookup("cloudName"))
TypeName("indexedParticleCloud")
Runtime type information.
Namespace for OpenFOAM.