DADummyTurbulenceModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2 
3  DAFoam : Discrete Adjoint with OpenFOAM
4  Version : v4
5 
6  Description:
7  Child class for the DummyTurbulenceModel model
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DADummyTurbulenceModel_H
12 #define DADummyTurbulenceModel_H
13 
14 #include "DATurbulenceModel.H"
15 #include "addToRunTimeSelectionTable.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 
22 /*---------------------------------------------------------------------------*\
23  Class DADummyTurbulenceModel Declaration
24 \*---------------------------------------------------------------------------*/
25 
27  : public DATurbulenceModel
28 {
29 
30 protected:
31 public:
32  TypeName("dummy");
33  // Constructors
34 
35  //- Construct from components
37  const word modelType,
38  const fvMesh& mesh,
39  const DAOption& daOption);
40 
41  //- Destructor
43  {
44  }
45 
46  // Member functions
47 
49  virtual void correctModelStates(wordList& modelStates) const;
50 
52  virtual void correctNut();
53 
55  virtual void correctBoundaryConditions();
56 
58  virtual void updateIntermediateVariables();
59 
61  virtual void correctStateResidualModelCon(List<List<word>>& stateCon) const;
62 
64  virtual void addModelResidualCon(HashTable<List<List<word>>>& allCon) const;
65 
67  virtual void calcResiduals(const dictionary& options);
68 
70  virtual void correct(label printToScreen);
71 };
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 } // End namespace Foam
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 #endif
80 
81 // ************************************************************************* //
Foam::DADummyTurbulenceModel
Definition: DADummyTurbulenceModel.H:26
Foam::DADummyTurbulenceModel::updateIntermediateVariables
virtual void updateIntermediateVariables()
update any intermediate variables that are dependent on state variables and are used in calcResiduals
Definition: DADummyTurbulenceModel.C:61
Foam::DADummyTurbulenceModel::correct
virtual void correct(label printToScreen)
solve the residual equations and update the state
Definition: DADummyTurbulenceModel.C:105
Foam::DAOption
Definition: DAOption.H:29
Foam::DADummyTurbulenceModel::~DADummyTurbulenceModel
virtual ~DADummyTurbulenceModel()
Definition: DADummyTurbulenceModel.H:42
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DADummyTurbulenceModel::correctModelStates
virtual void correctModelStates(wordList &modelStates) const
update the turbulence state for DAStateInfo::regStates_
Definition: DADummyTurbulenceModel.C:29
Foam::DADummyTurbulenceModel::addModelResidualCon
virtual void addModelResidualCon(HashTable< List< List< word >>> &allCon) const
add the model residual connectivity to stateCon
Definition: DADummyTurbulenceModel.C:100
Foam::DADummyTurbulenceModel::correctNut
virtual void correctNut()
update nut based on other turbulence variables and update the BCs
Definition: DADummyTurbulenceModel.C:51
Foam
Definition: checkGeometry.C:32
Foam::DADummyTurbulenceModel::correctStateResidualModelCon
virtual void correctStateResidualModelCon(List< List< word >> &stateCon) const
update the original variable connectivity for the adjoint state residuals in stateCon
Definition: DADummyTurbulenceModel.C:66
Foam::DADummyTurbulenceModel::DADummyTurbulenceModel
DADummyTurbulenceModel(const word modelType, const fvMesh &mesh, const DAOption &daOption)
Definition: DADummyTurbulenceModel.C:19
Foam::DATurbulenceModel
Definition: DATurbulenceModel.H:52
Foam::DADummyTurbulenceModel::correctBoundaryConditions
virtual void correctBoundaryConditions()
update turbulence variable boundary values
Definition: DADummyTurbulenceModel.C:56
Foam::DADummyTurbulenceModel::TypeName
TypeName("dummy")
Foam::DADummyTurbulenceModel::calcResiduals
virtual void calcResiduals(const dictionary &options)
compute the turbulence residuals
Definition: DADummyTurbulenceModel.C:110
DATurbulenceModel.H