dummyTurbulenceModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2 
3  DAFoam : Discrete Adjoint with OpenFOAM
4  Version : v3
5 
6  Description:
7  A dummy turbulence model that mimics the option for RAS-laminar flow
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef dummyTurbulenceModel_H
12 #define dummyTurbulenceModel_H
13 
14 #include "RASModel.H"
15 #include "eddyViscosity.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 namespace RASModels
22 {
23 
24 /*---------------------------------------------------------------------------*\
25  Class dummyTurbulenceModel Declaration
26 \*---------------------------------------------------------------------------*/
27 
28 template<class BasicTurbulenceModel>
30  : public eddyViscosity<RASModel<BasicTurbulenceModel>>
31 {
32  // Private Member Functions
33 
34  // Disallow default bitwise copy construct and assignment
36  void operator=(const dummyTurbulenceModel&);
37 
38 protected:
39  virtual void correctNut();
40 
41 public:
42  typedef typename BasicTurbulenceModel::alphaField alphaField;
43  typedef typename BasicTurbulenceModel::rhoField rhoField;
44  typedef typename BasicTurbulenceModel::transportModel transportModel;
45 
46  //- Runtime type information
47  TypeName("dummy");
48 
49  // Constructors
50 
51  //- Construct from components
53  const alphaField& alpha,
54  const rhoField& rho,
55  const volVectorField& U,
56  const surfaceScalarField& alphaRhoPhi,
57  const surfaceScalarField& phi,
58  const transportModel& transport,
59  const word& propertiesName = turbulenceModel::propertiesName,
60  const word& type = typeName);
61 
62  //- Destructor
64  {
65  }
66 
67  // Member Functions
68 
69  //- Re-read model coefficients if they have changed
70  virtual bool read();
71 
72  //- Return the turbulence kinetic energy
73  virtual tmp<volScalarField> k() const;
74 
75  //- Return the turbulence kinetic energy dissipation rate
76  virtual tmp<volScalarField> epsilon() const;
77 
78  //- Solve the turbulence equations and correct the turbulence viscosity
79  virtual void correct();
80 };
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace RASModels
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #ifdef NoRepository
90 #include "dummyTurbulenceModel.C"
91 #endif
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
U
U
Definition: pEqnPimpleDyM.H:60
dummyTurbulenceModel.C
Foam::RASModels::dummyTurbulenceModel::correct
virtual void correct()
Definition: dummyTurbulenceModel.C:82
Foam::RASModels::dummyTurbulenceModel
Definition: dummyTurbulenceModel.H:29
phi
surfaceScalarField & phi
Definition: createRefsPimple.H:8
Foam::RASModels::dummyTurbulenceModel::rhoField
BasicTurbulenceModel::rhoField rhoField
Definition: dummyTurbulenceModel.H:43
Foam::RASModels::dummyTurbulenceModel::k
virtual tmp< volScalarField > k() const
Definition: dummyTurbulenceModel.C:70
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::RASModels::dummyTurbulenceModel::transportModel
BasicTurbulenceModel::transportModel transportModel
Definition: dummyTurbulenceModel.H:44
Foam::RASModels::dummyTurbulenceModel::correctNut
virtual void correctNut()
Definition: dummyTurbulenceModel.C:23
Foam::RASModels::dummyTurbulenceModel::TypeName
TypeName("dummy")
Foam::RASModels::dummyTurbulenceModel::epsilon
virtual tmp< volScalarField > epsilon() const
Definition: dummyTurbulenceModel.C:76
Foam::RASModels::dummyTurbulenceModel::~dummyTurbulenceModel
virtual ~dummyTurbulenceModel()
Definition: dummyTurbulenceModel.H:63
Foam::RASModels::dummyTurbulenceModel::alphaField
BasicTurbulenceModel::alphaField alphaField
Definition: dummyTurbulenceModel.H:42
Foam::RASModels::dummyTurbulenceModel::read
virtual bool read()
Definition: dummyTurbulenceModel.C:63
rho
volScalarField & rho
Definition: createRefsRhoSimpleC.H:8