streamLineParticleCloud.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 | Copyright (C) 2011 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::streamLineParticleCloud
26 
27 Description
28  A Cloud of streamLine particles
29 
30 SourceFiles
31  streamLineCloud.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef streamLineCloud_H
36 #define streamLineCloud_H
37 
38 #include "Cloud.H"
39 #include "streamLineParticle.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class streamLineCloud Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public Cloud<streamLineParticle>
53 {
54  // Private Member Functions
55 
56  //- Disallow default bitwise copy construct
58 
59  //- Disallow default bitwise assignment
60  void operator=(const streamLineParticleCloud&);
61 
62 
63 public:
64 
65  //- Type of parcel the cloud was instantiated for
67 
68  // Constructors
69 
70  //- Construct given mesh
72  (
73  const polyMesh&,
74  const word& cloudName = "defaultCloud",
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<streamLineParticle>& particles
84  );
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
const word cloudName(propsDict.lookup("cloudName"))
A class for handling words, derived from string.
Definition: word.H:59
Particle class that samples fields as it passes through. Used in streamline calculation.
dynamicFvMesh & mesh
Namespace for OpenFOAM.
A Cloud of streamLine particles.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Base cloud calls templated on particle type.
Definition: Cloud.H:52
This function object reads fields from the time directories and adds them to the mesh database for fu...
Definition: readFields.H:102
streamLineParticle parcelType
Type of parcel the cloud was instantiated for.