objectiveManagerIncompressible.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 
29 Class
30  Foam::objectiveManagerIncompressible
31 
32 Description
33  class for managing incompressible objective functions.
34 
35 SourceFiles
36  objectiveManagerIncompressible.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef objectiveManagerIncompressible_H
41 #define objectiveManagerIncompressible_H
42 
43 #include "objectiveManager.H"
45 #include "runTimeSelectionTables.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class objectiveManagerIncompressible Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public objectiveManager
59 {
60 private:
61 
62  // Private Member Functions
63 
64  //- No copy construct
66  (
68  ) = delete;
69 
70  //- No copy assignment
71  void operator=(const objectiveManagerIncompressible&) = delete;
72 
73 
74 public:
75 
76  TypeName("objectiveManagerIncompressible");
77 
78  // Constructors
79 
80  //- Construct from components
82  (
83  const fvMesh& mesh,
84  const dictionary& dict,
85  const word& adjointSolverName,
86  const word& primalSolverName
87  );
88 
89 
90  //- Destructor
91  virtual ~objectiveManagerIncompressible() = default;
92 
93 
94  // Member Functions
95 
96  //- Add contribution to adjoint momentum PDEs
97  virtual void addUaEqnSource(fvVectorMatrix& UaEqn);
98 
99  //- Add contribution to adjoint momentum PDEs
100  virtual void addPaEqnSource(fvScalarMatrix& paEqn);
101 
102  //- Add contribution to adjoint turbulence model PDE
103  virtual void addTMEqn1Source(fvScalarMatrix& adjTMEqn1);
104 
105  //- Add contribution to adjoint turbulence model PDE
106  virtual void addTMEqn2Source(fvScalarMatrix& adjTMEqn2);
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
Foam::objectiveManager
class for managing incompressible objective functions.
Definition: objectiveManager.H:54
Foam::objectiveManager::primalSolverName
const word & primalSolverName() const
Return name of the primalSolver.
Definition: objectiveManager.C:314
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::objectiveManagerIncompressible::addUaEqnSource
virtual void addUaEqnSource(fvVectorMatrix &UaEqn)
Add contribution to adjoint momentum PDEs.
Definition: objectiveManagerIncompressible.C:64
objectiveManager.H
Foam::objectiveManagerIncompressible
class for managing incompressible objective functions.
Definition: objectiveManagerIncompressible.H:55
Foam::objectiveManagerIncompressible::addTMEqn1Source
virtual void addTMEqn1Source(fvScalarMatrix &adjTMEqn1)
Add contribution to adjoint turbulence model PDE.
Definition: objectiveManagerIncompressible.C:96
paEqn
fvScalarMatrix paEqn(fvm::d2dt2(pa) - sqr(c0) *fvc::laplacian(pa))
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
objectiveIncompressible.H
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::objectiveManagerIncompressible::TypeName
TypeName("objectiveManagerIncompressible")
Foam::objectiveManagerIncompressible::~objectiveManagerIncompressible
virtual ~objectiveManagerIncompressible()=default
Destructor.
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
Foam::objectiveManagerIncompressible::addPaEqnSource
virtual void addPaEqnSource(fvScalarMatrix &paEqn)
Add contribution to adjoint momentum PDEs.
Definition: objectiveManagerIncompressible.C:80
Foam::objectiveManagerIncompressible::addTMEqn2Source
virtual void addTMEqn2Source(fvScalarMatrix &adjTMEqn2)
Add contribution to adjoint turbulence model PDE.
Definition: objectiveManagerIncompressible.C:112
Foam::fvMatrix
A special matrix type and solver, designed for finite volume solutions of scalar equations....
Definition: fvPatchField.H:68
Foam::objectiveManager::adjointSolverName
const word & adjointSolverName() const
Return name of the adjointSolver.
Definition: objectiveManager.C:308