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