The open source CFD toolbox
ArmijoConditions.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-------------------------------------------------------------------------------
9 Copyright (C) 2013-2019 FOSS GP
10 Copyright (C) 2019-2020 OpenCFD Ltd.
11-------------------------------------------------------------------------------
13 This file is part of OpenFOAM.
14
15 OpenFOAM is free software: you can redistribute it and/or modify it
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 "ArmijoConditions.H"
32
33// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35namespace Foam
36{
39 (
43 );
44}
45
46
47// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48
50(
51 const dictionary& dict,
52 const Time& time
53)
54:
55 lineSearch(dict, time),
56 c1_(coeffsDict().getOrDefault<scalar>("c1", 1.e-4))
57{}
58
59
60// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * //
61
63{
64 Info<< "New merit function value " << newMeritValue_ << endl;
65 Info<< "Old merit function value " << oldMeritValue_ << endl;
66 Info<< "Extrapolated merit function value "
67 << oldMeritValue_ + c1_*step_*directionalDeriv_ << endl;
68 return newMeritValue_ < oldMeritValue_ + c1_*step_*directionalDeriv_;
69}
70
71
73{
75 Info<< "Using step " << step_ << endl;
76}
77
78
79// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Add to construction table with typeName as the key.
Class satisfying the Armijo line search conditions.
virtual bool converged()
Return the correction of the design variables.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Abstract base class for line search methods.
Definition: lineSearch.H:57
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)