sensitivityMultipleIncompressible.C
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 
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 
38 namespace incompressible
39 {
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 defineTypeNameAndDebug(sensitivityMultiple, 0);
45 (
46  adjointSensitivity,
49 );
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
53 sensitivityMultiple::sensitivityMultiple
54 (
55  const fvMesh& mesh,
56  const dictionary& dict,
57  incompressibleVars& primalVars,
58  incompressibleAdjointVars& adjointVars,
60 )
61 :
63  (
64  mesh,
65  dict,
66  primalVars,
67  adjointVars,
69  ),
70  sensTypes_(dict.subDict("sensTypes").toc()),
71  sens_(sensTypes_.size())
72 {
73  forAll(sensTypes_, sI)
74  {
75  sens_.set
76  (
77  sI,
79  (
80  mesh,
81  dict.subDict("sensTypes").subDict(sensTypes_[sI]),
82  primalVars,
83  adjointVars,
85  )
86  );
87  }
88 }
89 
90 
91 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
92 
94 {
96  {
97  forAll(sens_, sI)
98  {
99  sens_[sI].readDict
100  (
101  dict.subDict("sensTypes").subDict(sensTypes_[sI])
102  );
103  }
104 
105  return true;
106  }
107 
108  return false;
109 }
110 
111 
112 void sensitivityMultiple::accumulateIntegrand(const scalar dt)
113 {
115  {
116  sens_[sI].accumulateIntegrand(dt);
117  }
118 }
119 
120 
122 {
124  {
125  sens_[sI].assembleSensitivities();
126  }
127 }
128 
129 
131 {
132  forAll(sens_, sI)
133  {
134  Info<< "Computing sensitivities " << sensTypes_[sI] << endl;
135  derivatives_ = sens_[sI].calculateSensitivities();
136  }
137  write(type());
138 
139  return derivatives_;
140 }
141 
142 
144 {
146  {
147  sens_[sI].clearSensitivities();
148  }
149 }
150 
151 
152 void sensitivityMultiple::write(const word& baseName)
153 {
154  forAll(sens_, sI)
155  {
156  sens_[sI].write(sensTypes_[sI]);
157  }
158 }
159 
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 } // End namespace incompressible
164 } // End namespace Foam
165 
166 // ************************************************************************* //
Foam::sensitivity::dict
const dictionary & dict() const
Definition: sensitivity.C:50
Foam::incompressible::adjointSensitivity::derivatives_
scalarField derivatives_
Definition: adjointSensitivityIncompressible.H:79
Foam::objectiveManager
class for managing incompressible objective functions.
Definition: objectiveManager.H:50
Foam::incompressible::sensitivityMultiple::write
virtual void write(const word &baseName=word::null)
Definition: sensitivityMultipleIncompressible.C:145
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:63
Foam::incompressible::defineTypeNameAndDebug
defineTypeNameAndDebug(adjointEikonalSolver, 0)
Foam::incompressible::sensitivityMultiple::accumulateIntegrand
virtual void accumulateIntegrand(const scalar dt)
Definition: sensitivityMultipleIncompressible.C:105
Foam::incompressible::sensitivityMultiple::sens_
PtrList< adjointSensitivity > sens_
Definition: sensitivityMultipleIncompressible.H:61
Foam::endl
Ostream & endl(Ostream &os)
Definition: Ostream.H:381
Foam::incompressibleAdjointVars
Class including all adjoint fields for incompressible flows.
Definition: incompressibleAdjointVars.H:46
forAll
#define forAll(list, i)
Definition: stdFoam.H:349
Foam::incompressible::addToRunTimeSelectionTable
addToRunTimeSelectionTable(adjointSensitivity, sensitivityBezier, dictionary)
Foam::incompressible::adjointSensitivity
Abstract base class for adjoint-based sensitivities in incompressible flows.
Definition: adjointSensitivityIncompressible.H:71
Foam::Field
Generic templated field type.
Definition: Field.H:59
Foam::sensitivity::readDict
virtual bool readDict(const dictionary &dict)
Definition: sensitivity.C:56
Foam::Info
messageStream Info
Foam::incompressible::adjointSensitivity::New
static autoPtr< adjointSensitivity > New(const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager)
Definition: adjointSensitivityIncompressible.C:65
Foam::dictionary::subDict
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionary.C:453
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:119
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:81
Foam
Definition: atmBoundaryLayer.C:26
Foam::incompressible::sensitivityMultiple::clearSensitivities
virtual void clearSensitivities()
Definition: sensitivityMultipleIncompressible.C:136
Foam::incompressible::sensitivityMultiple::readDict
virtual bool readDict(const dictionary &dict)
Definition: sensitivityMultipleIncompressible.C:86
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Definition: POSIX.C:717
sensitivityMultipleIncompressible.H
Foam::incompressibleVars
Base class for solution control classes.
Definition: incompressibleVars.H:48
Foam::incompressible::sensitivityMultiple
Calculation of adjoint based sensitivities of multiple types.
Definition: sensitivityMultipleIncompressible.H:51
Foam::incompressible::sensitivityMultiple::sensTypes_
wordList sensTypes_
Definition: sensitivityMultipleIncompressible.H:59
Foam::incompressible::sensitivityMultiple::assembleSensitivities
virtual void assembleSensitivities()
Definition: sensitivityMultipleIncompressible.C:114
Foam::incompressible::sensitivityMultiple::calculateSensitivities
const scalarField & calculateSensitivities()
Definition: sensitivityMultipleIncompressible.C:123