DARadiationModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2 
3  DAFoam : Discrete Adjoint with OpenFOAM
4  Version : v3
5 
6  Description:
7  Augmented radiation model for the adjoint method, including residual
8  calculation functions, etc
9 
10 \*---------------------------------------------------------------------------*/
11 
12 #ifndef DARadiationModel_H
13 #define DARadiationModel_H
14 
15 #include "runTimeSelectionTables.H"
16 #include "DAOption.H"
17 
18 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
19 
20 namespace Foam
21 {
22 
23 /*---------------------------------------------------------------------------*\
24  Class DARadiationModel Declaration
25 \*---------------------------------------------------------------------------*/
26 
28  : public regIOobject
29 {
30 
31 private:
32  //- Disallow default bitwise copy construct
34 
35  //- Disallow default bitwise assignment
36  void operator=(const DARadiationModel&);
37 
38 protected:
39  const fvMesh& mesh_;
40 
42 
43 public:
44  //- Runtime type information
45  TypeName("DARadiationModel");
46 
47  // Declare run-time constructor selection table
49  autoPtr,
51  dictionary,
52  (const word modelType,
53  const fvMesh& mesh,
54  const DAOption& daOption),
55  (modelType, mesh, daOption));
56 
57  // Constructors
58 
59  //- Construct from components
61  const word modelType,
62  const fvMesh& mesh,
63  const DAOption& daOption);
64 
65  // Selectors
66 
67  //- Return a reference to the selected model
68  static autoPtr<DARadiationModel> New(
69  const word modelType,
70  const fvMesh& mesh,
71  const DAOption& daOption);
72 
73  //- Destructor
75  {
76  }
77 
78  // Members
79 
81  bool writeData(Ostream& os) const;
82 
83  virtual void addModelResidualCon(HashTable<List<List<word>>>& allCon) const = 0;
84 };
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Foam::DARadiationModel::addModelResidualCon
virtual void addModelResidualCon(HashTable< List< List< word >>> &allCon) const =0
DAOption.H
Foam::DAOption
Definition: DAOption.H:29
Foam::DARadiationModel::~DARadiationModel
virtual ~DARadiationModel()
Definition: DARadiationModel.H:74
Foam::DARadiationModel::daOption_
const DAOption & daOption_
Definition: DARadiationModel.H:41
daOption
DAOption daOption(mesh, pyOptions_)
Foam::DARadiationModel::mesh_
const fvMesh & mesh_
Definition: DARadiationModel.H:39
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DARadiationModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, DARadiationModel, dictionary,(const word modelType, const fvMesh &mesh, const DAOption &daOption),(modelType, mesh, daOption))
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::DARadiationModel::New
static autoPtr< DARadiationModel > New(const word modelType, const fvMesh &mesh, const DAOption &daOption)
Definition: DARadiationModel.C:42
Foam::DARadiationModel::TypeName
TypeName("DARadiationModel")
Foam::DARadiationModel::writeData
bool writeData(Ostream &os) const
this is a virtual function for regIOobject
Definition: DARadiationModel.C:78
Foam::DARadiationModel
Definition: DARadiationModel.H:27