PDRDragModel.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-2015 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::PDRDragModel
26 
27 Description
28  Base-class for sub-grid obstacle drag models. The available drag model is at
29  \link basic.H \endlink.
30 
31 SourceFiles
32  PDRDragModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef PDRDragModel_H
37 #define PDRDragModel_H
38 
39 #include "IOdictionary.H"
40 #include "psiuReactionThermo.H"
43 #include "runTimeSelectionTables.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class PDRDragModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class PDRDragModel
55 :
56  public regIOobject
57 {
58 
59 protected:
60 
61  // Protected data
62 
64 
68  const surfaceScalarField& phi_;
69 
70  Switch on_;
71 
72 
73 private:
74 
75  // Private Member Functions
76 
77  //- Disallow copy construct
78  PDRDragModel(const PDRDragModel&);
79 
80  //- Disallow default bitwise assignment
81  void operator=(const PDRDragModel&);
82 
83 
84 public:
85 
86  //- Runtime type information
87  TypeName("PDRDragModel");
88 
89 
90  // Declare run-time constructor selection table
91 
93  (
94  autoPtr,
96  dictionary,
97  (
98  const dictionary& PDRProperties,
100  const volScalarField& rho,
101  const volVectorField& U,
102  const surfaceScalarField& phi
103  ),
104  (
105  PDRProperties,
106  turbulence,
107  rho,
108  U,
109  phi
110  )
111  );
112 
113 
114  // Selectors
115 
116  //- Return a reference to the selected Xi model
118  (
119  const dictionary& PDRProperties,
120  const compressible::RASModel& turbulence,
121  const volScalarField& rho,
122  const volVectorField& U,
123  const surfaceScalarField& phi
124  );
125 
126 
127  // Constructors
128 
129  //- Construct from components
131  (
132  const dictionary& PDRProperties,
133  const compressible::RASModel& turbulence,
134  const volScalarField& rho,
135  const volVectorField& U,
136  const surfaceScalarField& phi
137  );
138 
139 
140  //- Destructor
141  virtual ~PDRDragModel();
142 
143 
144  // Member Functions
145 
146  //- Return true if the drag model is switched on
147  bool on() const
148  {
149  return on_;
150  }
151 
152  //- Return the momentum drag coefficient
153  virtual tmp<volSymmTensorField> Dcu() const = 0;
154 
155  //- Return the momentum drag turbulence generation rate
156  virtual tmp<volScalarField> Gk() const = 0;
157 
158  //- Inherit read from regIOobject
159  using regIOobject::read;
160 
161  //- Update properties from given dictionary
162  virtual bool read(const dictionary& PDRProperties) = 0;
164  virtual bool writeData(Ostream&) const
165  {
166  return true;
167  }
169  virtual void writeFields() const
170  {
172  }
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #endif
183 
184 // ************************************************************************* //
autoPtr< compressible::turbulenceModel > turbulence
Definition: createFields.H:23
surfaceScalarField & phi
U
Definition: pEqn.H:83
virtual ~PDRDragModel()
Destructor.
TypeName("PDRDragModel")
Runtime type information.
dictionary PDRDragModelCoeffs_
Definition: PDRDragModel.H:62
virtual bool read()
Read object.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: PDRDragModel.H:163
Base-class for sub-grid obstacle drag models. The available drag model is at basic.H.
Definition: PDRDragModel.H:53
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none.
Definition: Switch.H:60
const compressible::RASModel & turbulence_
Definition: PDRDragModel.H:64
const volScalarField & rho_
Definition: PDRDragModel.H:65
virtual void writeFields() const
Definition: PDRDragModel.H:168
const volVectorField & U_
Definition: PDRDragModel.H:66
const surfaceScalarField & phi_
Definition: PDRDragModel.H:67
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
bool on() const
Return true if the drag model is switched on.
Definition: PDRDragModel.H:146
RASModel< EddyDiffusivity< turbulenceModel > > RASModel
static autoPtr< PDRDragModel > New(const dictionary &PDRProperties, const compressible::RASModel &turbulence, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi)
Return a reference to the selected Xi model.
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
declareRunTimeSelectionTable(autoPtr, PDRDragModel, dictionary,(const dictionary &PDRProperties, const compressible::RASModel &turbulence, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi),(PDRProperties, turbulence, rho, U, phi))
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
virtual tmp< volScalarField > Gk() const =0
Return the momentum drag turbulence generation rate.
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:54
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
Namespace for OpenFOAM.
virtual tmp< volSymmTensorField > Dcu() const =0
Return the momentum drag coefficient.