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-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 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 )
60 :
62  useCorrection_
63  (
64  coeffsDict().getOrDefault<bool>("useCorrection", true)
65  )
66 {}
67 
68 
69 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
70 
72 {
73  // Reset to zero
74  const label n = objectiveDerivatives_.size();
75  const label m = constraintDerivatives_.size();
77 
78  // Matrix with constraint derivatives and its inverse
79  scalarSquareMatrix MMT(m, Zero);
81  {
83  {
84  MMT[cI][cJ] =
85  globalSum
86  (
88  );
89  }
90  }
91  scalarSquareMatrix invM(inv(MMT));
92 
93  // Contribution from constraints
94  scalarField constraintContribution(n, Zero);
95  scalarField nonLinearContribution(n, Zero);
97  {
99  {
100  constraintContribution +=
102  *invM[cI][cJ]
104 
105  // Correction to take non-linearities into consideration
106  if (useCorrection_)
107  {
108  nonLinearContribution +=
110  *invM[cI][cJ]
111  *cValues_[cJ];
112  }
113  }
114  }
115 
116  // Final correction
117  correction_ = objectiveDerivatives_ - constraintContribution;
118  correction_ *= -eta_;
119  if (useCorrection_)
120  {
121  correction_ -= nonLinearContribution;
122  }
123 }
124 
125 
126 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:52
Foam::updateMethod::cValues_
scalarField cValues_
Constraint values.
Definition: updateMethod.H:77
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
Foam::updateMethod::constraintDerivatives_
PtrList< scalarField > constraintDerivatives_
Derivatives of the constraints.
Definition: updateMethod.H:71
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::constrainedOptimisationMethod
Abstract base class for optimisation methods supporting constraints. Does not add functionality to up...
Definition: constrainedOptimisationMethod.H:55
n
label n
Definition: TABSMDCalcMethod2.H:31
Foam::constraintProjection::useCorrection_
bool useCorrection_
Correct for non-linearities.
Definition: constraintProjection.H:65
Foam::Field< scalar >
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:123
Foam::updateMethod::correction_
scalarField correction_
Design variables correction.
Definition: updateMethod.H:80
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:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::SquareMatrix< scalar >
constraintProjection.H
Foam::updateMethod::globalSum
scalar globalSum(const scalarField &field)
Compute either global or local sum, based on globalSum flag.
Definition: updateMethod.C:175
Foam::updateMethod::eta_
scalar eta_
Step multiplying the correction.
Definition: updateMethod.H:87
Foam::updateMethod::inv
SquareMatrix< scalar > inv(SquareMatrix< scalar > A)
Definition: updateMethod.C:125
Foam::constraintProjection::computeCorrection
void computeCorrection()
Compute design variables correction.
Definition: constraintProjection.C:71
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::updateMethod::objectiveDerivatives_
scalarField objectiveDerivatives_
Derivatives of the objective functions.
Definition: updateMethod.H:68