ATCUaGradU.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::ATCUaGradU
31 
32 Description
33  The ATC formualtion resulting by differentiating the
34  Conservative form of the Momentum equations.
35 
36 SourceFiles
37  ATCUaGradU.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef ATCUaGradU_H
42 #define ATCUaGradU_H
43 
44 #include "ATCModel.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class ATCUaGradU Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class ATCUaGradU
56 :
57  public ATCModel
58 {
59 private:
60 
61  // Private Member Functions
62 
63  //- No copy construct
64  ATCUaGradU(const ATCUaGradU&) = delete;
65 
66  //- No copy assignment
67  void operator=(const ATCUaGradU&) = delete;
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("UaGradU");
74 
75 
76  // Constructors
77 
78  //- Construct from components
80  (
81  const fvMesh& mesh,
82  const incompressibleVars& primalVars,
83  const incompressibleAdjointVars& adjointVars,
84  const dictionary& dict
85  );
86 
87 
88  //- Destructor
89  virtual ~ATCUaGradU() = default;
90 
91 
92  // Member Functions
93 
94  //- Add ATC
95  virtual void addATC(fvVectorMatrix& UaEqn);
96 
97  //- Get the FI sensitivity derivatives term coming from the ATC
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
TypeName("UaGradU")
Runtime type information.
virtual tmp< volTensorField > getFISensitivityTerm() const
Get the FI sensitivity derivatives term coming from the ATC.
Definition: ATCUaGradU.C:96
Class including all adjoint fields for incompressible flows.
virtual ~ATCUaGradU()=default
Destructor.
Base class for solution control classes.
dynamicFvMesh & mesh
Base class for selecting the adjoint transpose convection model. Inherits from regIOobject to add loo...
Definition: ATCModel.H:56
A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: fvPatchField.H:64
The ATC formualtion resulting by differentiating the Conservative form of the Momentum equations...
Definition: ATCUaGradU.H:50
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual void addATC(fvVectorMatrix &UaEqn)
Add ATC.
Definition: ATCUaGradU.C:58
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Namespace for OpenFOAM.