OpenFOAM: API Guide
v2112
The open source CFD toolbox
bisection.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 "
bisection.H
"
31
#include "
addToRunTimeSelectionTable.H
"
32
33
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35
namespace
Foam
36
{
37
defineTypeNameAndDebug
(bisection, 0);
38
addToRunTimeSelectionTable
39
(
40
stepUpdate,
41
bisection,
42
dictionary
43
);
44
}
45
46
47
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48
49
Foam::bisection::bisection(
const
dictionary
&
dict
)
50
:
51
stepUpdate
(
dict
),
52
ratio_(coeffsDict().getOrDefault<scalar>(
"ratio"
, 0.7))
53
{}
54
55
56
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * //
57
58
void
Foam::bisection::updateStep
(scalar& step)
59
{
60
step *= ratio_;
61
}
62
63
64
// ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::bisection::updateStep
virtual void updateStep(scalar &step)
Update the line search step.
Definition:
bisection.C:58
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
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
bisection.H
Foam::stepUpdate
Abstract base class for step update methods used in line search.
Definition:
stepUpdate.H:54
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
src
optimisation
adjointOptimisation
adjoint
optimisation
lineSearch
stepUpdate
bisection
bisection.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.