DAJacConDummy.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 dummy Jacobian connectivity. This is for initializing
8  a DAPartDeriv child class that does not need coloring, e.g., dRdBC
9  Basically, we implement nothing here because DAPartDeriv-dRdBC will
10  call none of the methods from this dummy child class.
11 
12 \*---------------------------------------------------------------------------*/
13 
14 #ifndef DAJacConDummy_H
15 #define DAJacConDummy_H
16 
17 #include "DAJacCon.H"
18 #include "addToRunTimeSelectionTable.H"
19 
20 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
21 
22 namespace Foam
23 {
24 
25 /*---------------------------------------------------------------------------*\
26  Class DAJacConDummy Declaration
27 \*---------------------------------------------------------------------------*/
28 
30  : public DAJacCon
31 {
32 
33 protected:
34 
35 public:
36  TypeName("dummy");
37  // Constructors
38 
39  //- Construct from components
41  const word modelType,
42  const fvMesh& mesh,
43  const DAOption& daOption,
44  const DAModel& daModel,
45  const DAIndex& daIndex);
46 
47  //- Destructor
48  virtual ~DAJacConDummy()
49  {
50  }
51 
52  // Member functions
53 
55  virtual void initializeJacCon(const dictionary& options);
56 
58  virtual void setupJacCon(const dictionary& options);
59 
61  virtual void clear();
62 
63 };
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 } // End namespace Foam
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 #endif
72 
73 // ************************************************************************* //
Foam::DAJacCon
Definition: DAJacCon.H:34
Foam::DAJacConDummy
Definition: DAJacConDummy.H:29
Foam::DAJacConDummy::~DAJacConDummy
virtual ~DAJacConDummy()
Definition: DAJacConDummy.H:48
Foam::DAOption
Definition: DAOption.H:29
daOption
DAOption daOption(mesh, pyOptions_)
DAJacCon.H
mesh
fvMesh & mesh
Definition: createRefsHeatTransfer.H:4
Foam::DAJacConDummy::clear
virtual void clear()
clear members in parent and child objects
Definition: DAJacConDummy.C:42
Foam::DAIndex
Definition: DAIndex.H:32
Foam::DAJacConDummy::setupJacCon
virtual void setupJacCon(const dictionary &options)
assign 1 to all non-zero elements for the Jacobian connecitivyt matrix
Definition: DAJacConDummy.C:32
Foam::DAModel
Definition: DAModel.H:59
Foam
Definition: multiFreqScalarFvPatchField.C:144
Foam::DAJacConDummy::TypeName
TypeName("dummy")
daModel
DAModel daModel(mesh, daOption)
Foam::DAJacConDummy::DAJacConDummy
DAJacConDummy(const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
Definition: DAJacConDummy.C:19
daIndex
DAIndex daIndex(mesh, daOption, daModel)
Foam::DAJacConDummy::initializeJacCon
virtual void initializeJacCon(const dictionary &options)
initialize the state Jacobian connectivity matrix
Definition: DAJacConDummy.C:37