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-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 
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 
38 namespace incompressible
39 {
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 defineTypeNameAndDebug(sensitivityMultiple, 0);
45 (
46  adjointSensitivity,
47  sensitivityMultiple,
48  dictionary
49 );
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
53 sensitivityMultiple::sensitivityMultiple
54 (
55  const fvMesh& mesh,
56  const dictionary& dict,
57  incompressibleVars& primalVars,
58  incompressibleAdjointVars& adjointVars,
61 )
62 :
64  (
65  mesh,
66  dict,
67  primalVars,
68  adjointVars,
71  ),
72  sensTypes_(dict.subDict("sensTypes").toc()),
73  sens_(sensTypes_.size())
74 {
75  forAll(sensTypes_, sI)
76  {
77  sens_.set
78  (
79  sI,
81  (
82  mesh,
83  dict.subDict("sensTypes").subDict(sensTypes_[sI]),
84  primalVars,
85  adjointVars,
88  )
89  );
90  }
91 }
92 
93 
94 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
95 
97 {
99  {
100  forAll(sens_, sI)
101  {
102  sens_[sI].readDict
103  (
104  dict.subDict("sensTypes").subDict(sensTypes_[sI])
105  );
106  }
107 
108  return true;
109  }
110 
111  return false;
112 }
113 
114 
116 {
117  forAll(sens_, sI)
118  {
119  sens_[sI].accumulateIntegrand(dt);
120  }
121 }
122 
123 
125 {
126  forAll(sens_, sI)
127  {
128  sens_[sI].assembleSensitivities();
129  }
130 }
131 
132 
134 {
135  forAll(sens_, sI)
136  {
137  Info<< "Computing sensitivities " << sensTypes_[sI] << endl;
138  derivatives_ = sens_[sI].calculateSensitivities();
139  }
140  write(type());
141 
142  return derivatives_;
143 }
144 
145 
147 {
148  forAll(sens_, sI)
149  {
150  sens_[sI].clearSensitivities();
151  }
152 }
153 
154 
155 void sensitivityMultiple::write(const word& baseName)
156 {
157  forAll(sens_, sI)
158  {
159  sens_[sI].write(sensTypes_[sI]);
160  }
161 }
162 
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 } // End namespace incompressible
167 } // End namespace Foam
168 
169 // ************************************************************************* //
Foam::sensitivity::dict
const dictionary & dict() const
Return the construction dictionary.
Definition: sensitivity.C:57
Foam::incompressible::adjointSensitivity::derivatives_
scalarField derivatives_
Definition: adjointSensitivityIncompressible.H:84
Foam::objectiveManager
class for managing incompressible objective functions.
Definition: objectiveManager.H:54
Foam::incompressible::sensitivityMultiple::write
virtual void write(const word &baseName=word::null)
Write sensitivities to file.
Definition: sensitivityMultipleIncompressible.C:155
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::incompressible::defineTypeNameAndDebug
defineTypeNameAndDebug(adjointEikonalSolver, 0)
Foam::incompressible::sensitivityMultiple::accumulateIntegrand
virtual void accumulateIntegrand(const scalar dt)
Accumulate sensitivity integrands.
Definition: sensitivityMultipleIncompressible.C:115
Foam::incompressible::sensitivityMultiple::sens_
PtrList< adjointSensitivity > sens_
Definition: sensitivityMultipleIncompressible.H:65
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:337
Foam::incompressibleAdjointVars
Class including all adjoint fields for incompressible flows.
Definition: incompressibleAdjointVars.H:52
Foam::fv::optionAdjointList
Definition: fvOptionAdjointList.H:59
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:290
Foam::incompressible::addToRunTimeSelectionTable
addToRunTimeSelectionTable(adjointSensitivity, sensitivityBezier, dictionary)
Foam::incompressible::adjointSensitivity
Abstract base class for adjoint-based sensitivities in incompressible flows.
Definition: adjointSensitivityIncompressible.H:76
Foam::Field< scalar >
Foam::sensitivity::readDict
virtual bool readDict(const dictionary &dict)
Read dictionary if changed.
Definition: sensitivity.C:63
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::dictionary::subDict
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary.
Definition: dictionary.C:523
Foam::incompressible::adjointSensitivity::New
static autoPtr< adjointSensitivity > New(const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
Return a reference to the selected turbulence model.
Definition: adjointSensitivityIncompressible.C:73
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:121
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:84
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::incompressible::sensitivityMultiple::clearSensitivities
virtual void clearSensitivities()
Zero sensitivity fields and their constituents.
Definition: sensitivityMultipleIncompressible.C:146
Foam::incompressible::sensitivityMultiple::readDict
virtual bool readDict(const dictionary &dict)
Read dict if changed.
Definition: sensitivityMultipleIncompressible.C:96
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
sensitivityMultipleIncompressible.H
fvOptionsAdjoint
fv::IOoptionListAdjoint fvOptionsAdjoint(mesh)
Foam::incompressibleVars
Base class for solution control classes.
Definition: incompressibleVars.H:54
Foam::incompressible::sensitivityMultiple::sensTypes_
wordList sensTypes_
Definition: sensitivityMultipleIncompressible.H:63
Foam::incompressible::sensitivityMultiple::assembleSensitivities
virtual void assembleSensitivities()
Assemble sensitivities.
Definition: sensitivityMultipleIncompressible.C:124
Foam::incompressible::sensitivityMultiple::calculateSensitivities
const scalarField & calculateSensitivities()
Calculates sensitivities at wall surface points.
Definition: sensitivityMultipleIncompressible.C:133