DADummyTurbulenceModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2 
3  DAFoam : Discrete Adjoint with OpenFOAM
4  Version : v3
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 
32 public:
33  TypeName("dummy");
34  // Constructors
35 
36  //- Construct from components
38  const word modelType,
39  const fvMesh& mesh,
40  const DAOption& daOption);
41 
42  //- Destructor
44  {
45  }
46 
47  // Member functions
48 
50  virtual void correctModelStates(wordList& modelStates) const;
51 
53  virtual void correctNut();
54 
56  virtual void correctBoundaryConditions();
57 
59  virtual void updateIntermediateVariables();
60 
62  virtual void correctStateResidualModelCon(List<List<word>>& stateCon) const;
63 
65  virtual void addModelResidualCon(HashTable<List<List<word>>>& allCon) const;
66 
68  virtual void calcResiduals(const dictionary& options);
69 
71  virtual void correct();
72 };
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 } // End namespace Foam
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 #endif
81 
82 // ************************************************************************* //
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::DAOption
Definition: DAOption.H:29
daOption
DAOption daOption(mesh, pyOptions_)
Foam::DADummyTurbulenceModel::~DADummyTurbulenceModel
virtual ~DADummyTurbulenceModel()
Definition: DADummyTurbulenceModel.H:43
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: multiFreqScalarFvPatchField.C:144
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::correct
virtual void correct()
solve the residual equations and update the state
Definition: DADummyTurbulenceModel.C:105
Foam::DADummyTurbulenceModel::DADummyTurbulenceModel
DADummyTurbulenceModel(const word modelType, const fvMesh &mesh, const DAOption &daOption)
Definition: DADummyTurbulenceModel.C:19
Foam::DATurbulenceModel
Definition: DATurbulenceModel.H:61
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