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 -------------------------------------------------------------------------------
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 "ArmijoConditions.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(ArmijoConditions, 0);
39  (
40  lineSearch,
41  ArmijoConditions,
42  dictionary
43  );
44 }
45 
46 
47 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48 
49 Foam::ArmijoConditions::ArmijoConditions
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 "
69 }
70 
71 
73 {
74  stepUpdate_->updateStep(step_);
75  Info<< "Using step " << step_ << endl;
76 }
77 
78 
79 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
Foam::ArmijoConditions::updateStep
virtual void updateStep()
Definition: ArmijoConditions.C:72
Foam::lineSearch::directionalDeriv_
scalar directionalDeriv_
Directional derivative of the merit function.
Definition: lineSearch.H:69
ArmijoConditions.H
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::ArmijoConditions::converged
virtual bool converged()
Return the correction of the design variables.
Definition: ArmijoConditions.C:62
Foam::lineSearch::step_
scalar step_
Correction multiplier.
Definition: lineSearch.H:90
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
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::lineSearch::newMeritValue_
scalar newMeritValue_
New merit value from this opt cycle.
Definition: lineSearch.H:78
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::ArmijoConditions::c1_
scalar c1_
Definition: ArmijoConditions.H:62
Foam::lineSearch::oldMeritValue_
scalar oldMeritValue_
Old merit value from this opt cycle.
Definition: lineSearch.H:75
Foam::constant::electromagnetic::e
const dimensionedScalar e
Elementary charge.
Definition: createFields.H:11
Foam::lineSearch
Abstract base class for line search methods.
Definition: lineSearch.H:56
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)