streamlinesCloud.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-2021 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::streamlinesCloud
26 
27 Description
28  A Cloud of streamlines particles
29 
30 SourceFiles
31  streamlinesCloud.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef streamlinesCloud_H
36 #define streamlinesCloud_H
37 
38 #include "Cloud.H"
39 #include "streamlinesParticle.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class streamlinesCloud Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class streamlinesCloud
51 :
52  public Cloud<streamlinesParticle>
53 {
54 public:
55 
56  //- Type of parcel the cloud was instantiated for
58 
59 
60  //- Runtime type information
61  TypeName("streamlinesCloud");
62 
63 
64  // Constructors
65 
66  //- Construct given mesh
68  (
69  const polyMesh&,
70  const word& cloudName = "defaultCloud",
71  bool readFields = true
72  );
73 
74  //- Construct from mesh, cloud name, and a list of particles
76  (
77  const polyMesh& mesh,
78  const word& cloudName,
79  const IDLList<streamlinesParticle>& particles
80  );
81 
82  //- Disallow default bitwise copy construction
83  streamlinesCloud(const streamlinesCloud&) = delete;
84 
85 
86  // Member Operators
87 
88  //- Disallow default bitwise assignment
89  void operator=(const streamlinesCloud&) = delete;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
Template class for intrusive linked lists.
Definition: ILList.H:50
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
TypeName("streamlinesCloud")
Runtime type information.
void operator=(const streamlinesCloud &)=delete
Disallow default bitwise assignment.
fvMesh & mesh
streamlinesCloud(const polyMesh &, const word &cloudName="defaultCloud", bool readFields=true)
Construct given mesh.
A class for handling words, derived from string.
Definition: word.H:59
A Cloud of streamlines particles.
Particle class that samples fields as it passes through. Used in streamlines calculation.
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"))
streamlinesParticle parcelType
Type of parcel the cloud was instantiated for.
Namespace for OpenFOAM.