sensitivityVolBSplinesIncompressible.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 Class
29  Foam::incompressible::sensitivityVolBSplines
30 
31 Description
32  Calculation of adjoint based sensitivities at vol B-Splines control points
33  using the SI or e-SI approach (determined by surface sensitivities)
34 
35 SourceFiles
36  sensitivityVolBSplines.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef sensitivityVolBSplinesIncompressible_H
41 #define sensitivityVolBSplinesIncompressible_H
42 
43 #include "SIBaseIncompressible.H"
44 #include "volBSplinesBase.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 namespace incompressible
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class sensitivityVolBSplines Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  public SIBase
61 {
62 protected:
63 
64  // Protected data
65 
66  //- Reference to underlaying volumetric B-Splines morpher
68 
69  //- Flow related term
71 
72  //- Term depending on delta(n dS)/delta b
74 
75  //- Term depending on delta (n)/delta b
77 
78  //- Term depending on dxdb for objective functions directly depending
79  //- on x
81 
82  //- Term dependng on the differentiation of boundary conditions
84 
86 
87 
88  // Protected Member Functions
89 
92 
93 
94 private:
95 
96  // Private Member Functions
97 
98  //- No copy construct
100 
101  //- No copy assignment
102  void operator=(const sensitivityVolBSplines&) = delete;
103 
104 
105 public:
106 
107  //- Runtime type information
108  TypeName("volumetricBSplines");
109 
110 
111  // Constructors
112 
113  //- Construct from components
115  (
116  const fvMesh& mesh,
117  const dictionary& dict,
118  incompressibleVars& primalVars,
119  incompressibleAdjointVars& adjointVars,
121  );
122 
123 
124  //- Destructor
125  virtual ~sensitivityVolBSplines() = default;
126 
127 
128  // Member Functions
129 
130  //- Assemble sensitivities
131  virtual void assembleSensitivities();
132 
133  //- Zero sensitivity fields and their constituents
134  virtual void clearSensitivities();
135 
136  //- Write sensitivities to file
137  virtual void write(const word& baseName = word::null);
138 };
139 
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 } // End namespace incompressible
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
Foam::sensitivity::dict
const dictionary & dict() const
Return the construction dictionary.
Definition: sensitivity.C:57
Foam::incompressible::sensitivityVolBSplines::assembleSensitivities
virtual void assembleSensitivities()
Assemble sensitivities.
Definition: sensitivityVolBSplinesIncompressible.C:188
Foam::objectiveManager
class for managing incompressible objective functions.
Definition: objectiveManager.H:54
Foam::incompressible::sensitivityVolBSplines::TypeName
TypeName("volumetricBSplines")
Runtime type information.
Foam::incompressible::sensitivityVolBSplines::computeBCContributions
void computeBCContributions()
Definition: sensitivityVolBSplinesIncompressible.C:116
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
Foam::incompressible::sensitivityVolBSplines::write
virtual void write(const word &baseName=word::null)
Write sensitivities to file.
Definition: sensitivityVolBSplinesIncompressible.C:266
Foam::volBSplinesBase
Class constructing a number of volumetric B-Splines boxes, read from dynamicMeshDict....
Definition: volBSplinesBase.H:59
Foam::incompressible::sensitivityVolBSplines::clearSensitivities
virtual void clearSensitivities()
Zero sensitivity fields and their constituents.
Definition: sensitivityVolBSplinesIncompressible.C:254
Foam::incompressible::sensitivityVolBSplines::volBSplinesBase_
volBSplinesBase & volBSplinesBase_
Reference to underlaying volumetric B-Splines morpher.
Definition: sensitivityVolBSplinesIncompressible.H:66
Foam::incompressible::SIBase
Base class for Surface Integral-based sensitivity derivatives.
Definition: SIBaseIncompressible.H:57
Foam::incompressible::sensitivityVolBSplines::computeObjectiveContributions
void computeObjectiveContributions()
Definition: sensitivityVolBSplinesIncompressible.C:54
Foam::incompressibleAdjointVars
Class including all adjoint fields for incompressible flows.
Definition: incompressibleAdjointVars.H:52
Foam::incompressible::sensitivityVolBSplines::flowSens_
vectorField flowSens_
Flow related term.
Definition: sensitivityVolBSplinesIncompressible.H:69
Foam::incompressible::sensitivityVolBSplines::derivativesFolder_
fileName derivativesFolder_
Definition: sensitivityVolBSplinesIncompressible.H:84
Foam::incompressible::sensitivityVolBSplines::bcSens_
vectorField bcSens_
Term dependng on the differentiation of boundary conditions.
Definition: sensitivityVolBSplinesIncompressible.H:82
Foam::incompressible::sensitivityVolBSplines::dxdbDirectSens_
vectorField dxdbDirectSens_
Definition: sensitivityVolBSplinesIncompressible.H:79
Foam::Field< vector >
Foam::incompressible::sensitivityVolBSplines::dndbSens_
vectorField dndbSens_
Term depending on delta (n)/delta b.
Definition: sensitivityVolBSplinesIncompressible.H:75
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
volBSplinesBase.H
Foam::incompressible::sensitivityVolBSplines::dSdbSens_
vectorField dSdbSens_
Term depending on delta(n dS)/delta b.
Definition: sensitivityVolBSplinesIncompressible.H:72
Foam::incompressible::sensitivityVolBSplines
Calculation of adjoint based sensitivities at vol B-Splines control points using the SI or e-SI appro...
Definition: sensitivityVolBSplinesIncompressible.H:57
Foam::word::null
static const word null
An empty word.
Definition: word.H:80
SIBaseIncompressible.H
Foam::incompressible::sensitivityVolBSplines::~sensitivityVolBSplines
virtual ~sensitivityVolBSplines()=default
Destructor.
Foam::incompressibleVars
Base class for solution control classes.
Definition: incompressibleVars.H:54