objectiveForce.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::objectives::objectiveForce
31 
32 Description
33 
34 SourceFiles
35  objectiveForce.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef objectiveForce_H
40 #define objectiveForce_H
41 
43 #include "wallFvPatch.H"
44 #include "createZeroField.H"
45 
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 namespace objectives
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class objectiveForce Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 class objectiveForce
60 :
62 {
63 protected:
64 
65  // Protected Data
66 
69  scalar Aref_;
70  scalar rhoInf_;
71  scalar UInf_;
72 
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("force");
82 
83 
84  // Constructors
85 
86  //- Construct from components
88  (
89  const fvMesh& mesh,
90  const dictionary& dict,
91  const word& adjointSolverName,
92  const word& primalSolverName
93  );
94 
95 
96  //- Destructor
97  virtual ~objectiveForce() = default;
98 
99 
100  // Member Functions
101 
102  //- Return the objective function value
103  scalar J();
104 
105  //- Update values to be added to the adjoint wall velocity
106  void update_boundarydJdp();
107 
108  //- Update delta(n dS)/delta b multiplier
109  void update_dSdbMultiplier();
110 
111  //- Update delta(x)/delta b multiplier
112  void update_dxdbMultiplier();
113 
114  //- Update dJ/dStress multiplier
116 
117  //- Return denominator, without density
118  virtual scalar denom() const;
119 
120  //- Return force direction
121  const vector& forceDirection() const;
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace objectives
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::objectives::objectiveForce::TypeName
TypeName("force")
Runtime type information.
Foam::objectives::objectiveForce::Aref_
scalar Aref_
Definition: objectiveForce.H:68
Foam::objectives::objectiveForce::~objectiveForce
virtual ~objectiveForce()=default
Destructor.
Foam::objectives::objectiveForce::update_dxdbMultiplier
void update_dxdbMultiplier()
Update delta(x)/delta b multiplier.
Definition: objectiveForce.C:201
wallFvPatch.H
Foam::objectives::objectiveForce
Definition: objectiveForce.H:58
Foam::objectives::objectiveForce::stressZPtr_
autoPtr< volVectorField > stressZPtr_
Definition: objectiveForce.H:74
Foam::HashSet< label, Hash< label > >
Foam::objectives::objectiveForce::update_dSdbMultiplier
void update_dSdbMultiplier()
Update delta(n dS)/delta b multiplier.
Definition: objectiveForce.C:175
createZeroField.H
Foam::objectives::objectiveForce::UInf_
scalar UInf_
Definition: objectiveForce.H:70
Foam::objectives::objectiveForce::rhoInf_
scalar rhoInf_
Definition: objectiveForce.H:69
Foam::objectiveIncompressible
Abstract base class for objective functions in incompressible flows.
Definition: objectiveIncompressible.H:54
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::objectives::objectiveForce::stressXPtr_
autoPtr< volVectorField > stressXPtr_
Definition: objectiveForce.H:72
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
objectiveIncompressible.H
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::objectives::objectiveForce::forcePatches_
labelHashSet forcePatches_
Definition: objectiveForce.H:66
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::objectives::objectiveForce::forceDirection
const vector & forceDirection() const
Return force direction.
Definition: objectiveForce.C:289
Foam::objectives::objectiveForce::objectiveForce
objectiveForce(const fvMesh &mesh, const dictionary &dict, const word &adjointSolverName, const word &primalSolverName)
Construct from components.
Definition: objectiveForce.C:55
Foam::objectives::objectiveForce::update_boundarydJdp
void update_boundarydJdp()
Update values to be added to the adjoint wall velocity.
Definition: objectiveForce.C:166
Foam::objectives::objectiveForce::J
scalar J()
Return the objective function value.
Definition: objectiveForce.C:122
Foam::Vector< scalar >
Foam::objectives::objectiveForce::denom
virtual scalar denom() const
Return denominator, without density.
Definition: objectiveForce.C:283
Foam::objectives::objectiveForce::update_dJdStressMultiplier
void update_dJdStressMultiplier()
Update dJ/dStress multiplier.
Definition: objectiveForce.C:271
Foam::objectives::objectiveForce::stressYPtr_
autoPtr< volVectorField > stressYPtr_
Definition: objectiveForce.H:73
Foam::objectives::objectiveForce::forceDirection_
vector forceDirection_
Definition: objectiveForce.H:67