Go to the documentation of this file.
168 virtual void setDeriv(
const scalar deriv);
180 virtual void reset();
196 virtual void updateStep(
const scalar newStep);
declareRunTimeSelectionTable(autoPtr, lineSearch, dictionary,(const dictionary &dict, const Time &time),(dict, time))
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
virtual void reset()
Reset step to initial value.
void setOldMeritValue(const scalar value)
Set old objective value.
scalar prevMeritDeriv_
Merit directional deriv from the previous opt cycle.
void setNewMeritValue(const scalar value)
Set new objective value.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
virtual ~lineSearch()=default
Destructor.
scalar step() const
Get current step.
scalar initialStep_
Correction multiplier at the first step of line search.
virtual void setDeriv(const scalar deriv)
Set objective derivative.
scalar directionalDeriv_
Directional derivative of the merit function.
virtual lineSearch & operator++()
label iter_
Inner line search iteration.
const dictionary dict_
Subdict within updateMethod.
label maxIters() const
Get max number of iterations.
scalar step_
Correction multiplier.
void setDirection(const scalarField &direction)
Set direction.
TypeName("lineSearch")
Runtime type information.
static autoPtr< lineSearch > New(const dictionary &dict, const Time &time)
Return a reference to the selected turbulence model.
IOdictionary lineSearchDict_
IOdictionary under time/uniform for continuation.
virtual bool converged()=0
Return the correction of the design variables.
scalarField direction_
Update direction.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
scalar newMeritValue_
New merit value from this opt cycle.
const dictionary & coeffsDict()
Optional coeffs dict.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
label maxIters_
Maximum line search iterations.
scalar oldMeritValue_
Old merit value from this opt cycle.
Macros to ease declaration of run-time selection tables.
scalar minStep_
Minimum allowed correction multiplier.
virtual void updateStep()=0
bool extrapolateInitialStep_
Abstract base class for line search methods.
autoPtr< stepUpdate > stepUpdate_
Mechanism to update method if line search conditions are not set.