sensitivityBezierIncompressible.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-2020 PCOpt/NTUA
9  Copyright (C) 2013-2020 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::incompressible::sensitivityBezier
31 
32 Description
33  Calculation of adjoint based sensitivities for Bezier control points
34 
35 SourceFiles
36  sensitivityBezier.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef sensitivityBezierIncompressible_H
41 #define sensitivityBezierIncompressible_H
42 
43 #include "primitiveFieldsFwd.H"
44 #include "volFieldsFwd.H"
45 #include "pointFieldsFwd.H"
46 #include "surfaceFieldsFwd.H"
47 #include "volPointInterpolation.H"
48 #include "SIBaseIncompressible.H"
50 #include "PrimitivePatch.H"
51 #include "deltaBoundary.H"
52 #include "Bezier.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 namespace incompressible
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class sensitivityBezier Declaration
64 \*---------------------------------------------------------------------------*/
65 
67 :
68  public SIBase
69 {
70 protected:
71 
72  // Protected data
73 
75 
82 
84 
85 
86 private:
87 
88  // Private Member Functions
89 
90  //- No copy construct
91  sensitivityBezier(const sensitivityBezier&) = delete;
92 
93  //- No copy assignment
94  void operator=(const sensitivityBezier&) = delete;
95 
96 
97 public:
98 
99  //- Runtime type information
100  TypeName("Bezier");
101 
102 
103  // Constructors
104 
105  //- Construct from components
107  (
108  const fvMesh& mesh,
109  const dictionary& dict,
110  incompressibleVars& primalVars,
111  incompressibleAdjointVars& adjointVars,
113  );
114 
115 
116  //- Destructor
117  virtual ~sensitivityBezier() = default;
118 
119 
120  // Member Functions
121 
122  //- Assemble sensitivities
123  virtual void assembleSensitivities();
124 
125  //- Zero sensitivity fields and their constituents
126  virtual void clearSensitivities();
127 
128  //- Write sensitivities to file
129  virtual void write(const word& baseName = word::null);
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace incompressible
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
Foam::sensitivity::dict
const dictionary & dict() const
Return the construction dictionary.
Definition: sensitivity.C:57
volFieldsFwd.H
Foam::objectiveManager
class for managing incompressible objective functions.
Definition: objectiveManager.H:54
primitiveFieldsFwd.H
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
Foam::Bezier
Calculation of adjoint based sensitivities for Bezier control points.
Definition: Bezier.H:59
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::incompressible::sensitivityBezier::clearSensitivities
virtual void clearSensitivities()
Zero sensitivity fields and their constituents.
Definition: sensitivityBezierIncompressible.C:188
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
PrimitivePatchInterpolation.H
Foam::incompressible::sensitivityBezier
Calculation of adjoint based sensitivities for Bezier control points.
Definition: sensitivityBezierIncompressible.H:65
Foam::incompressible::SIBase
Base class for Surface Integral-based sensitivity derivatives.
Definition: SIBaseIncompressible.H:57
Foam::incompressible::sensitivityBezier::write
virtual void write(const word &baseName=word::null)
Write sensitivities to file.
Definition: sensitivityBezierIncompressible.C:201
Foam::incompressible::sensitivityBezier::dndbSens_
vectorField dndbSens_
Definition: sensitivityBezierIncompressible.H:78
Foam::incompressible::sensitivityBezier::Bezier_
Bezier Bezier_
Definition: sensitivityBezierIncompressible.H:73
Foam::incompressible::sensitivityBezier::dSdbSens_
vectorField dSdbSens_
Definition: sensitivityBezierIncompressible.H:77
Foam::incompressibleAdjointVars
Class including all adjoint fields for incompressible flows.
Definition: incompressibleAdjointVars.H:52
Foam::incompressible::sensitivityBezier::assembleSensitivities
virtual void assembleSensitivities()
Assemble sensitivities.
Definition: sensitivityBezierIncompressible.C:89
Bezier.H
Foam::Field< vector >
PrimitivePatch.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
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
volPointInterpolation.H
deltaBoundary.H
Foam::incompressible::sensitivityBezier::~sensitivityBezier
virtual ~sensitivityBezier()=default
Destructor.
pointFieldsFwd.H
Forwards and collection of common point field types.
surfaceFieldsFwd.H
Foam::word::null
static const word null
An empty word.
Definition: word.H:80
Foam::incompressible::sensitivityBezier::TypeName
TypeName("Bezier")
Runtime type information.
SIBaseIncompressible.H
Foam::incompressible::sensitivityBezier::flowSens_
vectorField flowSens_
Definition: sensitivityBezierIncompressible.H:76
Foam::incompressible::sensitivityBezier::sens_
vectorField sens_
Definition: sensitivityBezierIncompressible.H:75
Foam::incompressible::sensitivityBezier::bcSens_
vectorField bcSens_
Definition: sensitivityBezierIncompressible.H:80
Foam::incompressibleVars
Base class for solution control classes.
Definition: incompressibleVars.H:54
Foam::incompressible::sensitivityBezier::dxdbDirectSens_
vectorField dxdbDirectSens_
Definition: sensitivityBezierIncompressible.H:79
Foam::incompressible::sensitivityBezier::derivativesFolder_
fileName derivativesFolder_
Definition: sensitivityBezierIncompressible.H:82