passivePositionParticleCloud.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017-2019 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::passivePositionParticleCloud
28 
29 Description
30  A Cloud of passive position particles
31 
32 SourceFiles
33  passivePositionParticleCloud.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef passivePositionParticleCloud_H
38 #define passivePositionParticleCloud_H
39 
40 #include "Cloud.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class passivePositionParticleCloud Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public Cloud<passivePositionParticle>
55 {
56  // Private Member Functions
57 
58  //- No copy construct
60  (
62  ) = delete;
63 
64  //- No copy assignment
65  void operator=(const passivePositionParticleCloud&) = delete;
66 
67 
68 public:
69 
70  // Constructors
71 
72  //- Construct given mesh
74  (
75  const polyMesh& mesh,
77  bool readFields = true
78  );
79 
80  //- Construct from mesh, cloud name, and a list of particles
82  (
83  const polyMesh& mesh,
84  const word& cloudName,
85  const IDLList<passivePositionParticle>& particles
86  );
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
cloudName
const word cloudName(propsDict.get< word >("cloud"))
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Cloud.H
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
Foam::ILList
Template class for intrusive linked lists.
Definition: ILList.H:52
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
passivePositionParticle.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::cloud::defaultName
static word defaultName
The default cloud name: defaultCloud.
Definition: cloud.H:90
Foam::readFields
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const wordHashSet &selectedFields, LIFOStack< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type.
Definition: ReadFieldsTemplates.C:312
Foam::passivePositionParticleCloud
A Cloud of passive position particles.
Definition: passivePositionParticleCloud.H:51
Foam::Cloud
Base cloud calls templated on particle type.
Definition: Cloud.H:55