objectiveMoment.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, 2022 PCOpt/NTUA
9  Copyright (C) 2013-2019, 2022 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::objectives::objectiveMoment
31 
32 Description
33 
34 SourceFiles
35  objectiveMoment.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef objectiveMoment_H
40 #define objectiveMoment_H
41 
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 namespace objectives
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class objectiveMoment Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class objectiveMoment
57 :
59 {
60  // Private data
61 
62  labelHashSet momentPatches_;
63  vector momentDirection_;
64  vector rotationCentre_;
65  scalar Aref_;
66  scalar lRef_;
67  scalar rhoInf_;
68  scalar UInf_;
69  scalar invDenom_;
70 
71  // Store this in order to computed only once per objective call
72  volSymmTensorField devReff_;
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("moment");
79 
80 
81  // Constructors
82 
83  //- from components
85  (
86  const fvMesh& mesh,
87  const dictionary& dict,
88  const word& adjointSolverName,
89  const word& primalSolverName
90  );
91 
92 
93  //- Destructor
94  virtual ~objectiveMoment() = default;
95 
96 
97  // Member Functions
98 
99  //- Return the objective function value
100  virtual scalar J();
101 
102  //- Update mean drag and lift values
103  virtual void update_meanValues();
104 
105  //- Update values to be added to the adjoint wall velocity
106  virtual void update_boundarydJdp();
107 
108  //- Update delta(n dS)/delta b multiplier
109  virtual void update_dSdbMultiplier();
110 
111  //- Update delta(x)/delta b multiplier
112  virtual void update_dxdbMultiplier();
113 
114  //- Update delta(x)/delta b multiplier coming directly from the
115  //- objective
116  virtual void update_dxdbDirectMultiplier();
117 
118  //- Update dJ/dnut multiplier
119  virtual void update_boundarydJdnut();
120 
121  //- Update dJ/dGradU multiplier
122  /* WIP
123  virtual void update_boundarydJdGradU();
124  */
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace objectiveMoment
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
virtual void update_dxdbMultiplier()
Update delta(x)/delta b multiplier.
const dictionary & dict() const
Return objective dictionary.
Definition: objective.C:91
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
virtual void update_dSdbMultiplier()
Update delta(n dS)/delta b multiplier.
objectiveMoment(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
from components
dynamicFvMesh & mesh
A class for handling words, derived from Foam::string.
Definition: word.H:63
virtual void update_boundarydJdp()
Update values to be added to the adjoint wall velocity.
TypeName("moment")
Runtime type information.
virtual ~objectiveMoment()=default
Destructor.
A Vector of values with scalar precision, where scalar is float/double depending on the compilation f...
virtual void update_boundarydJdnut()
Update dJ/dnut multiplier.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual void update_dxdbDirectMultiplier()
Update delta(x)/delta b multiplier coming directly from the objective.
virtual void update_meanValues()
Update mean drag and lift values.
Abstract base class for objective functions in incompressible flows.
virtual scalar J()
Return the objective function value.
Namespace for OpenFOAM.