steepestDescent.H
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-------------------------------------------------------------------------------
12License
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
29Class
30 Foam::steepestDescent
31
32Description
33 Update design variables using steepest descent
34
35SourceFiles
36 steepestDescent.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef steepestDescent_H
41#define steepestDescent_H
42
43#include "updateMethod.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49
50/*---------------------------------------------------------------------------*\
51 Class steepestDescent Declaration
52\*---------------------------------------------------------------------------*/
55:
56 public updateMethod
57{
58private:
59
60 // Private Member Functions
61
62 //- No copy construct
64
65 //- No copy assignment
66 void operator=(const steepestDescent&);
67
68public:
69
70 //- Runtime type information
71 TypeName("steepestDescent");
72
73
74 // Constructors
75
76 //- Construct from components
78
79
80 //- Destructor
81 virtual ~steepestDescent() = default;
82
83
84 // Member Functions
85
86 // compute design variables correction
87 void computeCorrection();
88};
89
90
91// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92
93} // End namespace Foam
94
95// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97#endif
98
99// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Update design variables using steepest descent.
void computeCorrection()
Return the correction of the design variables.
TypeName("steepestDescent")
Runtime type information.
virtual ~steepestDescent()=default
Destructor.
Abstract base class for optimisation methods.
Definition: updateMethod.H:55
dynamicFvMesh & mesh
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73