wallBoundedStreamLineParticleCloud.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-2016 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 
27 Class
28  Foam::wallBoundedStreamLineParticleCloud
29 
30 Description
31  A Cloud of streamLine particles
32 
33 SourceFiles
34  streamLineCloud.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef wallBoundedStreamLineParticleCloud_H
39 #define wallBoundedStreamLineParticleCloud_H
40 
41 #include "Cloud.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class streamLineCloud Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public Cloud<wallBoundedStreamLineParticle>
56 {
57  // Private Member Functions
58 
59  //- No copy construct
61  (
63  ) = delete;
64 
65  //- No copy assignment
66  void operator=(const wallBoundedStreamLineParticleCloud&) = delete;
67 
68 
69 public:
70 
71  //- Type of parcel the cloud was instantiated for
73 
74 
75  // Constructors
76 
77  //- Construct given mesh
79  (
80  const polyMesh& mesh,
82  bool readFields = true
83  );
84 
85  //- Construct from mesh, cloud name, and a list of particles
87  (
88  const polyMesh& mesh,
89  const word& cloudName,
91  );
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
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::wallBoundedStreamLineParticleCloud
A Cloud of streamLine particles.
Definition: wallBoundedStreamLineParticleCloud.H:52
Foam::wallBoundedStreamLineParticle
Particle class that samples fields as it passes through. Used in streamline calculation.
Definition: wallBoundedStreamLineParticle.H:66
Foam::ILList
Template class for intrusive linked lists.
Definition: ILList.H:52
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
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::Cloud
Base cloud calls templated on particle type.
Definition: Cloud.H:55
wallBoundedStreamLineParticle.H
Foam::wallBoundedStreamLineParticleCloud::parcelType
wallBoundedStreamLineParticle parcelType
Type of parcel the cloud was instantiated for.
Definition: wallBoundedStreamLineParticleCloud.H:71