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 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::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  autoPtr<volVectorField> stressXPtr_;
72  autoPtr<volVectorField> stressYPtr_;
73  autoPtr<volVectorField> stressZPtr_;
74 
75  // Store this in order to computed only once per objective call
76  volSymmTensorField devReff_;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("moment");
83 
84 
85  // Constructors
86 
87  //- from components
89  (
90  const fvMesh& mesh,
91  const dictionary& dict,
92  const word& adjointSolverName,
93  const word& primalSolverName
94  );
95 
96 
97  //- Destructor
98  virtual ~objectiveMoment() = default;
99 
100 
101  // Member Functions
102 
103  //- Return the objective function value
104  scalar J();
105 
106  //- Update mean drag and lift values
107  void update_meanValues();
108 
109  //- Update values to be added to the adjoint wall velocity
110  void update_boundarydJdp();
111 
112  //- Update delta(n dS)/delta b multiplier
113  void update_dSdbMultiplier();
114 
115  //- Update delta(x)/delta b multiplier
116  void update_dxdbMultiplier();
117 
118  //- Update delta(x)/delta b multiplier coming directly from the
119  //- objective
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace objectiveMoment
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::objectives::objectiveMoment::update_dxdbMultiplier
void update_dxdbMultiplier()
Update delta(x)/delta b multiplier.
Definition: objectiveMoment.C:217
Foam::HashSet< label, Hash< label > >
Foam::objectives::objectiveMoment::TypeName
TypeName("moment")
Runtime type information.
Foam::objectives::objectiveMoment
Definition: objectiveMoment.H:55
Foam::objectiveIncompressible
Abstract base class for objective functions in incompressible flows.
Definition: objectiveIncompressible.H:54
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::objectives::objectiveMoment::update_dSdbMultiplier
void update_dSdbMultiplier()
Update delta(n dS)/delta b multiplier.
Definition: objectiveMoment.C:191
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
objectiveIncompressible.H
Foam::objectives::objectiveMoment::objectiveMoment
objectiveMoment(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
from components
Definition: objectiveMoment.C:57
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::objectives::objectiveMoment::~objectiveMoment
virtual ~objectiveMoment()=default
Destructor.
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::objectives::objectiveMoment::update_meanValues
void update_meanValues()
Update mean drag and lift values.
Definition: objectiveMoment.C:166
Foam::objectives::objectiveMoment::update_dxdbDirectMultiplier
void update_dxdbDirectMultiplier()
Definition: objectiveMoment.C:285
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::Vector< scalar >
Foam::objectives::objectiveMoment::J
scalar J()
Return the objective function value.
Definition: objectiveMoment.C:128
Foam::objectives::objectiveMoment::update_boundarydJdp
void update_boundarydJdp()
Update values to be added to the adjoint wall velocity.
Definition: objectiveMoment.C:180
Foam::GeometricField< symmTensor, fvPatchField, volMesh >