CloudFunctionObjectList.C
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-2017 OpenFOAM Foundation
9  Copyright (C) 2020 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 \*---------------------------------------------------------------------------*/
28 
30 #include "entry.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
34 template<class CloudType>
36 (
37  CloudType& owner
38 )
39 :
41  owner_(owner),
42  dict_(dictionary::null)
43 {}
44 
45 
46 template<class CloudType>
48 (
49  CloudType& owner,
50  const dictionary& dict,
51  const bool readFields
52 )
53 :
55  owner_(owner),
56  dict_(dict)
57 {
58  if (readFields)
59  {
60  wordList modelNames(dict.toc());
61 
62  Info<< "Constructing cloud functions" << endl;
63 
64  if (modelNames.size() > 0)
65  {
66  this->setSize(modelNames.size());
67 
68  forAll(modelNames, i)
69  {
70  const word& modelName = modelNames[i];
71 
72  const dictionary& modelDict(dict.subDict(modelName));
73 
74  this->set
75  (
76  i,
78  (
79  modelDict,
80  owner,
81  modelDict.get<word>("type"),
82  modelName
83  )
84  );
85  }
86  }
87  else
88  {
89  Info<< " none" << endl;
90  }
91  }
92 }
93 
94 
95 template<class CloudType>
97 (
98  const CloudFunctionObjectList& cfol
99 )
100 :
102  owner_(cfol.owner_),
103  dict_(cfol.dict_)
104 {}
105 
106 
107 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
108 
109 template<class CloudType>
111 (
112  const typename parcelType::trackingData& td
113 )
114 {
115  forAll(*this, i)
116  {
117  this->operator[](i).preEvolve(td);
118  }
119 }
120 
121 
122 template<class CloudType>
124 (
125  const typename parcelType::trackingData& td
126 )
127 {
128  forAll(*this, i)
129  {
130  this->operator[](i).postEvolve(td);
131  }
132 }
133 
134 
135 template<class CloudType>
137 (
138  parcelType& p,
139  const scalar dt,
140  const point& position0,
141  bool& keepParticle
142 )
143 {
144  forAll(*this, i)
145  {
146  if (!keepParticle)
147  {
148  return;
149  }
150 
151  this->operator[](i).postMove(p, dt, position0, keepParticle);
152  }
153 }
154 
155 
156 template<class CloudType>
158 (
159  const parcelType& p,
160  const polyPatch& pp,
161  bool& keepParticle
162 )
163 {
164  forAll(*this, i)
165  {
166  if (!keepParticle)
167  {
168  return;
169  }
170 
171  this->operator[](i).postPatch(p, pp, keepParticle);
172  }
173 }
174 
175 
176 template<class CloudType>
178 (
179  const parcelType& p,
180  bool& keepParticle
181 )
182 {
183  forAll(*this, i)
184  {
185  if (!keepParticle)
186  {
187  return;
188  }
189 
190  this->operator[](i).postFace(p, keepParticle);
191  }
192 }
193 
194 
195 // ************************************************************************* //
Foam::CloudFunctionObjectList::postEvolve
virtual void postEvolve(const typename parcelType::trackingData &td)
Post-evolve hook.
Definition: CloudFunctionObjectList.C:124
setSize
points setSize(newPointi)
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::CloudFunctionObjectList::postPatch
virtual void postPatch(const parcelType &p, const polyPatch &pp, bool &keepParticle)
Post-patch hook.
Definition: CloudFunctionObjectList.C:158
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:350
Foam::CloudFunctionObjectList::owner_
const CloudType & owner_
Reference to the owner cloud.
Definition: CloudFunctionObjectList.H:69
entry.H
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
CloudFunctionObjectList.H
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::polyPatch
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:68
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:62
Foam::DSMCCloud
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:71
Foam::CloudFunctionObjectList::postFace
virtual void postFace(const parcelType &p, bool &keepParticle)
Post-face hook.
Definition: CloudFunctionObjectList.C:178
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::CloudFunctionObjectList
List of cloud function objects.
Definition: CloudFunctionObjectList.H:54
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::Vector< scalar >
Foam::List< word >
Foam::CloudFunctionObject
Templated cloud function object base class.
Definition: CloudFunctionObject.H:62
Foam::CloudFunctionObjectList::dict_
const dictionary dict_
Dictionary.
Definition: CloudFunctionObjectList.H:72
Foam::CloudFunctionObjectList::CloudFunctionObjectList
CloudFunctionObjectList(CloudType &owner)
Null constructor.
Definition: CloudFunctionObjectList.C:36
Foam::CloudFunctionObjectList::postMove
virtual void postMove(parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
Post-move hook.
Definition: CloudFunctionObjectList.C:137
Foam::CloudFunctionObjectList::preEvolve
virtual void preEvolve(const typename parcelType::trackingData &td)
Pre-evolve hook.
Definition: CloudFunctionObjectList.C:111