steepestDescent.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 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 "steepestDescent.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(steepestDescent, 0);
39  (
40  updateMethod,
41  steepestDescent,
42  dictionary
43  );
44 }
45 
46 
47 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48 
49 Foam::steepestDescent::steepestDescent
50 (
51  const fvMesh& mesh,
52  const dictionary& dict,
53  autoPtr<designVariables>& designVars,
54  const label nConstraints,
55  const word& type
56 )
57 :
58  updateMethod(mesh, dict, designVars, nConstraints, type)
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
63 
65 {
66  for (const label varI : activeDesignVars_)
67  {
68  correction_[varI] = -eta_*objectiveDerivatives_[varI];
69  }
70 }
71 
72 
73 // ************************************************************************* //
dictionary dict
type
Types of root.
Definition: Roots.H:52
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
Macros for easy insertion into run-time selection tables.
scalar eta_
Step multiplying the correction.
Definition: updateMethod.H:118
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
defineTypeNameAndDebug(combustionModel, 0)
void computeCorrection()
Return the correction of the design variables.
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
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
Namespace for OpenFOAM.
addToRunTimeSelectionTable(functionObject, pointHistory, dictionary)