DAResidualLaplacianFoam.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 DALaplacianFoam
8 
9 \*---------------------------------------------------------------------------*/
10 
11 #ifndef DAResidualLaplacianFoam_H
12 #define DAResidualLaplacianFoam_H
13 
14 #include "DAResidual.H"
15 #include "addToRunTimeSelectionTable.H"
16 
17 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 
19 namespace Foam
20 {
21 
22 /*---------------------------------------------------------------------------*\
23  Class DAResidualLaplacianFoam Declaration
24 \*---------------------------------------------------------------------------*/
25 
27  : public DAResidual
28 {
29 
30 protected:
32 
33  volScalarField& T_;
34  volScalarField TRes_;
36 
37  scalar DT_;
38 
39 public:
40  TypeName("DALaplacianFoam");
41  // Constructors
42 
43  //- Construct from components
45  const word modelType,
46  const fvMesh& mesh,
47  const DAOption& daOption,
48  const DAModel& daModel,
49  const DAIndex& daIndex);
50 
51  //- Destructor
53  {
54  }
55 
56  // Members
57 
59  virtual void clear();
60 
62  virtual void calcResiduals(const dictionary& options);
63 
65  virtual void updateIntermediateVariables();
66 
68  virtual void correctBoundaryConditions();
69 };
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 } // End namespace Foam
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 #endif
78 
79 // ************************************************************************* //
Foam::DAResidualLaplacianFoam::correctBoundaryConditions
virtual void correctBoundaryConditions()
update the boundary condition for all the states in the selected solver
Definition: DAResidualLaplacianFoam.C:90
Foam::DAResidualLaplacianFoam::clear
virtual void clear()
clear the members
Definition: DAResidualLaplacianFoam.C:44
Foam::DAResidualLaplacianFoam
Definition: DAResidualLaplacianFoam.H:26
Foam::DAResidualLaplacianFoam::T_
volScalarField & T_
Definition: DAResidualLaplacianFoam.H:33
Foam::DAOption
Definition: DAOption.H:29
daOption
DAOption daOption(mesh, pyOptions_)
Foam::DAResidualLaplacianFoam::TRes_
volScalarField TRes_
Definition: DAResidualLaplacianFoam.H:34
Foam::DAResidualLaplacianFoam::updateIntermediateVariables
virtual void updateIntermediateVariables()
update any intermediate variables that are dependent on state variables and are used in calcResiduals
Definition: DAResidualLaplacianFoam.C:81
Foam::DAResidualLaplacianFoam::DAResidualLaplacianFoam
DAResidualLaplacianFoam(const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
Definition: DAResidualLaplacianFoam.C:19
DAResidual.H
Foam::DAResidualLaplacianFoam::calcResiduals
virtual void calcResiduals(const dictionary &options)
compute residual
Definition: DAResidualLaplacianFoam.C:55
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DAResidualLaplacianFoam::TypeName
TypeName("DALaplacianFoam")
Foam::DAIndex
Definition: DAIndex.H:32
Foam::DAModel
Definition: DAModel.H:59
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::DAResidual
Definition: DAResidual.H:35
Foam::DAResidualLaplacianFoam::DT_
scalar DT_
Definition: DAResidualLaplacianFoam.H:37
daModel
DAModel daModel(mesh, daOption)
Foam::DAResidualLaplacianFoam::~DAResidualLaplacianFoam
virtual ~DAResidualLaplacianFoam()
Definition: DAResidualLaplacianFoam.H:52
daIndex
DAIndex daIndex(mesh, daOption, daModel)