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