regionModelFunctionObjectList.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) 2012-2018 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::regionModels::regionModelFunctionObjectList
26 
27 Description
28  List of cloud function objects
29 
30 SourceFiles
31  regionModelFunctionObjectListI.H
32  regionModelFunctionObjectList.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef regionModelFunctionObjectList_H
37 #define regionModelFunctionObjectList_H
38 
39 #include "PtrList.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 
49 class regionModel;
50 
51 /*---------------------------------------------------------------------------*\
52  Class regionModelFunctionObjectList Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public PtrList<regionModelFunctionObject>
58 {
59 protected:
60 
61  // Protected Data
62 
63  //- Reference to the region region model
65 
66  //- Dictionary
67  const dictionary dict_;
68 
69 
70 public:
71 
72  // Constructors
73 
74  //- Null constructor
76 
77  //- Construct from mesh
79  (
81  const dictionary& dict,
82  const bool readFields = true
83  );
84 
85  //- Construct copy
87  (
89  );
90 
91 
92  //- Destructor
94 
95 
96  // Member Functions
97 
98  // Access
99 
100  //- Return const access to the cloud region
101  inline const regionModel& region() const;
102 
103  //- Return references to the cloud region
104  inline regionModel& region();
105 
106  //- Return the forces dictionary
107  inline const dictionary& dict() const;
108 
109 
110  // Evaluation
111 
112  //- Pre-evolve hook
113  virtual void preEvolveRegion();
114 
115  //- Post-evolve hook
116  virtual void postEvolveRegion();
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace regionModels
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const dictionary & dict() const
Return the forces dictionary.
const regionModel & region() const
Return const access to the cloud region.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:63
Base class for region models.
Definition: regionModel.H:57
regionModel & regionModel_
Reference to the region region model.
Namespace for OpenFOAM.
regionModelFunctionObjectList(regionModel &region)
Null constructor.