constraintProjection.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-2021 PCOpt/NTUA
9  Copyright (C) 2013-2021 FOSS GP
10  Copyright (C) 2019-2020 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 
30 #include "constraintProjection.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(constraintProjection, 0);
39  (
40  updateMethod,
41  constraintProjection,
42  dictionary
43  );
45  (
46  constrainedOptimisationMethod,
47  constraintProjection,
48  dictionary
49  );
50 }
51 
52 
53 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
54 
55 Foam::constraintProjection::constraintProjection
56 (
57  const fvMesh& mesh,
58  const dictionary& dict,
59  autoPtr<designVariables>& designVars,
60  const label nConstraints,
61  const word& type
62 )
63 :
64  constrainedOptimisationMethod(mesh, dict, designVars, nConstraints, type),
65  updateMethod(mesh, dict, designVars, nConstraints, type),
66  useCorrection_(coeffsDict(type).getOrDefault<bool>("useCorrection", true)),
67  delta_(coeffsDict(type).getOrDefault<scalar>("delta", 0.1))
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
72 
74 {
75  // Reset to zero
76  const label n = objectiveDerivatives_.size();
77  const label m = constraintDerivatives_.size();
78 
79  // Matrix with constraint derivatives and its inverse
80  scalarSquareMatrix MMT(m, Zero);
82  {
84  {
85  MMT[cI][cJ] =
86  globalSum
87  (
89  );
90  }
91  }
92  scalarSquareMatrix invM(inv(MMT));
93 
94  // Contribution from constraints
95  scalarField constraintContribution(n, Zero);
96  scalarField nonLinearContribution(n, Zero);
98  {
100  {
101  constraintContribution +=
103  *invM[cI][cJ]
105 
106  // Correction to take non-linearities into consideration
107  if (useCorrection_)
108  {
109  nonLinearContribution +=
111  *invM[cI][cJ]
112  *cValues_[cJ];
113  }
114  }
115  }
116 
117  // Final correction
118  scalarField correction(objectiveDerivatives_ - constraintContribution);
119  correction *= -eta_;
120  if (useCorrection_)
121  {
122  correction -= nonLinearContribution;
123  }
124 
125  for (const label varI : activeDesignVars_)
126  {
127  correction_[varI] = correction[varI];
128  }
129 }
130 
131 
133 {
134  return objectiveValue_ + delta_*sum(mag(cValues_));
135 }
136 
137 
138 // ************************************************************************* //
bool useCorrection_
Correct for non-linearities.
tmp< fvMatrix< Type > > correction(const fvMatrix< Type > &)
Return the correction form of the given matrix by subtracting the matrix multiplied by the current fi...
dictionary dict
void size(const label n)
Older name for setAddressableSize.
Definition: UList.H:116
virtual scalar computeMeritFunction()
Compute merit function. Could be different than the objective in the presence of constraints.
dimensioned< Type > sum(const DimensionedField< Type, GeoMesh > &f1)
type
Types of root.
Definition: Roots.H:52
scalarField cValues_
Constraint values.
Definition: updateMethod.H:102
Abstract base class for optimisation methods supporting constraints. Does not add functionality to up...
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
Abstract base class for optimisation methods.
Definition: updateMethod.H:50
void computeCorrection()
Compute design variables correction.
Macros for easy insertion into run-time selection tables.
PtrList< scalarField > constraintDerivatives_
Derivatives of the constraints.
Definition: updateMethod.H:85
scalar eta_
Step multiplying the correction.
Definition: updateMethod.H:118
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:421
const labelList & activeDesignVars_
Map to active design variables.
Definition: updateMethod.H:75
dynamicFvMesh & mesh
A class for handling words, derived from Foam::string.
Definition: word.H:63
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
SquareMatrix< scalar > inv(SquareMatrix< scalar > A)
Definition: updateMethod.C:118
scalar globalSum(const scalarField &field)
Compute either global or local sum, based on globalSum flag.
Definition: updateMethod.C:168
defineTypeNameAndDebug(combustionModel, 0)
scalarField objectiveDerivatives_
Derivatives of the objective functions.
Definition: updateMethod.H:80
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
scalarField correction_
Design variables correction.
Definition: updateMethod.H:107
label n
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
SquareMatrix< scalar > scalarSquareMatrix
Namespace for OpenFOAM.
addToRunTimeSelectionTable(functionObject, pointHistory, dictionary)
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:127