Inheritance diagram for geos::NonlinearSolverParameters:

Classes
struct	viewKeysStruct

Public Types
enum class	LineSearchAction : integer { None , Attempt , Require }
	Indicates the handling of line search in a Newton loop. More...

enum class	LineSearchInterpolationType : integer { Linear , Parabolic }
	Indicates the handling of line each interpolation strategy. More...

enum class	CouplingType : integer { FullyImplicit , Sequential }
	Coupling type. More...

enum class	SequentialConvergenceCriterion : integer { ResidualNorm , NumberOfNonlinearIterations , SolutionIncrements }
	Sequential convergence criterion. More...

enum class	NonlinearAccelerationType : integer { None , Aitken }
	Nonlinear acceleration type. More...

Public Types inherited from geos::dataRepository::Group
using	subGroupMap = MappedVector< Group, Group *, keyType, indexType >
	The template specialization of MappedVector to use for the collection of sub-Group objects.

using	wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
	The template specialization of MappedVector to use for the collection wrappers objects.

using	CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Public Member Functions
	NonlinearSolverParameters ()=delete
	Default constructor.

	NonlinearSolverParameters (string const &name, Group *const parent)
	Constructor. More...

virtual	~NonlinearSolverParameters ()=default
	Default destructor.

	NonlinearSolverParameters (NonlinearSolverParameters &&)=default
	Default Move Constructor. More...

NonlinearSolverParameters &	operator= (const NonlinearSolverParameters &params)
	Copy Constructor. More...

virtual void	postInputInitialization () override

void	print () const

integer	timeStepDecreaseIterLimit () const
	Calculates the upper limit for the number of iterations to allow a decrease to the next time step. More...

integer	timeStepIncreaseIterLimit () const
	Calculates the lower limit for the number of iterations to force an increase to the next time step. More...

real64	timeStepDecreaseFactor () const
	Getter for the factor used to decrease the time step size. More...

real64	timeStepIncreaseFactor () const
	Getter for the factor used to increase the time step size. More...

integer	minTimeStepIncreaseInterval () const
	Getter for the minimum interval for increasing the time-step. More...

physicsSolverBaseKernels::NormType	normType () const
	Getter for the norm type used to check convergence in the flow/well solvers. More...

CouplingType	couplingType () const
	Getter for the coupling type. More...

SequentialConvergenceCriterion	sequentialConvergenceCriterion () const
	Getter for the sequential convergence criterion. More...

Public Member Functions inherited from geos::dataRepository::Group
template<typename LOG_LEVEL_INFO >
std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void >	addLogLevel ()
	Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More...

virtual bool	registerCallback (void *func, const std::type_info &funcType)
	Register a callback function on the group. More...

virtual void	reinit ()
	Performs re-initialization of certain variable depending on the solver being used.

	Group (string const &name, Group *const parent)
	Constructor. More...

	Group (string const &name, conduit::Node &rootNode)
	Constructor. More...

	Group (Group &&source)=default
	Move constructor. More...

virtual	~Group ()
	Destructor, deletes all Groups and Wrappers owned by this Group.

	Group ()=delete
	Deleted default constructor.

	Group (Group const &)=delete
	Deleted copy constructor.

Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...

Group &	operator= (Group &&)=delete
	Deleted move assignment operator. More...

void	printDataHierarchy (integer indent=0) const
	Prints the data hierarchy recursively. More...

string	dumpInputOptions () const

string	dumpSubGroupsNames () const

string	dumpWrappersNames () const

template<typename T = Group>
T &	registerGroup (string const &name, std::unique_ptr< T > newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (string const &name)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (subGroupMap::KeyIndex const &keyIndex)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group, typename TBASE = Group>
T &	registerGroup (string const &name, string const &catalogName)
	Register a new Group as a sub-group of current Group. More...

void	deregisterGroup (string const &name)
	Removes a child group from this group. More...

virtual Group *	createChild (string const &childKey, string const &childName)
	Creates a new sub-Group using the ObjectCatalog functionality. More...

template<typename T = Group, typename KEY = void>
T *	getGroupPointer (KEY const &key)
	Return a pointer to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T const *	getGroupPointer (KEY const &key) const
	Return a pointer to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T &	getGroup (KEY const &key)
	Return a reference to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T const &	getGroup (KEY const &key) const
	Return a reference to a sub-group of the current Group. More...

template<typename T = Group>
T &	getGroupByPath (string const &path)
	Retrieve a group from the hierarchy using a path. More...

template<typename T = Group>
T const &	getGroupByPath (string const &path) const
	Retrieve a group from the hierarchy using a path. More...

subGroupMap &	getSubGroups ()
	Get the subgroups object. More...

subGroupMap const &	getSubGroups () const
	Get the subgroups object. More...

localIndex	numSubGroups () const
	return the number of sub groups in this Group More...

std::vector< string >	getSubGroupsNames () const

template<typename T = Group>
bool	hasGroup (string const &name) const
	Check whether a sub-group exists. More...

template<typename T >
bool	hasSubGroupOfType () const
	Check whether a sub-group exists by type. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroupsIndex (LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroupsIndex (LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename LAMBDA >
void	forWrappers (LAMBDA &&lambda)
	Apply the given functor to wrappers. More...

template<typename LAMBDA >
void	forWrappers (LAMBDA &&lambda) const
	Apply the given functor to wrappers. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA &&lambda)
	Apply the given functor to wrappers that can be cast to one of specified types. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA &&lambda) const
	Apply the given functor to wrappers that can be cast to one of specified types. More...

virtual void	initialize_postMeshGeneration ()
	initialization post generation of the mesh.

void	initialize ()
	Run initialization functions on this and all subgroups. More...

virtual void	initializationOrder (string_array &order)
	Sets the initialization order for sub-Groups. More...

void	initializePostInitialConditions ()
	Initialization routine to be called after calling ApplyInitialConditions(). More...

void	postRestartInitializationRecursive ()
	Initialization routine to be called after calling reading a restart file. More...

void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when `Include` nodes are encountered. More...

void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
	Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...

void	postInputInitializationRecursive ()
	Recursively call postInputInitialization() to apply post processing after reading input values.

template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
	Create and register a Wrapper around a new object. More...

template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
	Create and register a Wrapper around a new object. More...

template<typename T >
Wrapper< T > &	registerWrapper (string const &name, std::unique_ptr< T > newObject)
	Register a Wrapper around a given object and take ownership. More...

template<typename T >
Wrapper< T > &	registerWrapper (string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...

WrapperBase &	registerWrapper (std::unique_ptr< WrapperBase > wrapper)
	Register and take ownership of an existing Wrapper. More...

void	deregisterWrapper (string const &name)
	Removes a Wrapper from this group. More...

void	generateDataStructureSkeleton (integer const level)
	Build a complete datastructure for schema generation. More...

virtual void	expandObjectCatalogs ()
	Expand any catalogs in the data structure.

virtual void	setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
	Inform the schema generator of any deviations between the xml and GEOS data structures. More...

virtual void	registerDataOnMeshRecursive (Group &meshBodies)
	Calls RegisterDataOnMesh() recursively. More...

virtual void	registerDataOnMesh (Group &meshBodies)
	Register data on mesh entities. More...

virtual localIndex	packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of wrappers. More...

virtual localIndex	packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices within a list of wrappers. More...

localIndex	packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices for all registered wrappers. More...

virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of wrappers to a buffer. More...

virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices within a list of wrappers. More...

localIndex	pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices for all registered wrappers. More...

virtual localIndex	unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
	Unpack a buffer. More...

template<typename KEY >
WrapperBase const &	getWrapperBase (KEY const &key) const
	Return a reference to a WrapperBase stored in this group. More...

template<typename KEY >
WrapperBase &	getWrapperBase (KEY const &key)
	Return a reference to a WrapperBase stored in this group. More...

indexType	getWrapperIndex (string const &name) const

wrapperMap const &	wrappers () const
	Get access to the internal wrapper storage. More...

wrapperMap &	wrappers ()
	Get access to the internal wrapper storage. More...

indexType	numWrappers () const
	Return the number of wrappers. More...

std::vector< string >	getWrappersNames () const

template<typename LOOKUP_TYPE >
bool	hasWrapper (LOOKUP_TYPE const &lookup) const
	Check if a wrapper exists. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const &	getWrapper (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > &	getWrapper (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const *	getWrapperPointer (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > *	getWrapperPointer (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
GEOS_DECLTYPE_AUTO_RETURN	getReference (LOOKUP_TYPE const &lookup) const
	Look up a wrapper and get reference to wrapped object. More...

template<typename T , typename LOOKUP_TYPE >
T &	getReference (LOOKUP_TYPE const &lookup)
	Look up a wrapper and get reference to wrapped object. More...

virtual void	resize (localIndex const newSize)
	Resize the group and all contained wrappers that resize with parent. More...

virtual void	reserve (indexType const newsize)
	Set the new capacity and reserve it in all wrappers that resize with parent. More...

localIndex	capacity () const
	Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...

localIndex	size () const
	Get the "size" of the group, which determines the number of elements in resizable wrappers. More...

string const &	getName () const
	Get group name. More...

string	getPath () const
	Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...

DataContext const &	getDataContext () const

template<typename KEY >
DataContext const &	getWrapperDataContext (KEY key) const

Group &	getParent ()
	Access the group's parent. More...

Group const &	getParent () const
	Access the group's parent. More...

bool	hasParent () const

localIndex	getIndexInParent () const
	Get the group's index within its parent group. More...

localIndex	getSubGroupIndex (keyType const &key) const
	Get the index of a sub-Group within this group. More...

int	sizedFromParent () const
	Check whether this Group is resized when its parent is resized. More...

Group &	setSizedFromParent (int val)
	Set whether this wrapper is resized when its parent is resized. More...

RestartFlags	getRestartFlags () const
	Get flags that control restart output of this group. More...

void	setRestartFlags (RestartFlags flags)
	Set flags that control restart output of this group. More...

InputFlags	getInputFlags () const
	Get input flags for schema generation. More...

void	setInputFlags (InputFlags flags)
	Set input flags for schema generation. More...

conduit::Node &	getConduitNode ()
	Return the Conduit node object associated with this group. More...

conduit::Node const &	getConduitNode () const
	Return the Conduit node object associated with this group. More...

void	prepareToWrite ()
	Register the group and its wrappers with Conduit.

void	finishWriting ()
	Write the group and its wrappers into Conduit.

void	loadFromConduit ()
	Read the group and its wrappers from Conduit.

void	enableLogLevelInput ()

void	setLogLevel (integer const logLevel)
	Set verbosity level. More...

integer	getLogLevel () const

Static Public Member Functions
static string	catalogName ()
	The name of this object in the catalog. More...

Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool	applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
	Apply a given functor to a container if the container can be cast to one of the specified types. More...

static CatalogInterface::CatalogType &	getCatalog ()
	Get the singleton catalog for this Group. More...

Public Attributes
struct geos::NonlinearSolverParameters::viewKeysStruct	viewKeys

LineSearchAction	m_lineSearchAction
	Flag to apply a line search.

LineSearchInterpolationType	m_lineSearchInterpType
	Flag to pick the type of line search.

integer	m_lineSearchMaxCuts
	The maximum number of line search cuts to attempt.

real64	m_lineSearchCutFactor
	The reduction factor for each line search cut.

integer	m_lineSearchStartingIteration
	Iteration when line search starts.

real64	m_lineSearchResidualFactor
	Factor to determine residual increase.

physicsSolverBaseKernels::NormType	m_normType
	Norm used to check the nonlinear loop convergence.

real64	m_newtonTol
	The tolerance for the nonlinear convergence check.

integer	m_maxIterNewton
	The maximum number of nonlinear iterations that are allowed.

integer	m_minIterNewton
	The minimum number of nonlinear iterations that may be applied.

integer	m_numNewtonIterations
	The number of nonlinear iterations that have been exectued.

real64	m_maxAllowedResidualNorm
	The maximum value of residual norm that we allow (otherwise, we cut the time step)

integer	m_allowNonConverged
	Flag to allow for a non-converged nonlinear solution and continue with the problem.

real64	m_timeStepDecreaseIterLimit
	Fraction of the max Newton iterations above which the solver asks for the time-step to be decreased for the next timeStep.

real64	m_timeStepIncreaseIterLimit
	Fraction of the max Newton iterations below which the solver asks for the time-step to be increased for the next timeStep.

real64	m_timeStepDecreaseFactor
	Factor used to decrease the time step size.

real64	m_timeStepIncreaseFactor
	Factor used to increase the time step size.

integer	m_minTimeStepIncreaseInterval
	Minimum interval, since the last time-step cut, for increasing the time-step.

integer	m_maxSubSteps
	Maximum number of time sub-steps allowed for the solver.

integer	m_maxTimeStepCuts
	Max number of time step cuts.

real64	m_timeStepCutFactor
	Factor by which the time step will be cut if a timestep cut is required.

integer	m_numTimeStepAttempts
	Number of times that the time-step had to be cut.

integer	m_numConfigurationAttempts
	Number of times that the configuration had to be changed.

integer	m_maxNumConfigurationAttempts
	Max number of times that the configuration can be changed.

double	m_configurationTolerance
	Configuration tolerance.

CouplingType	m_couplingType
	Type of coupling.

SequentialConvergenceCriterion	m_sequentialConvergenceCriterion
	Criterion used to check outer-loop convergence in sequential schemes.

integer	m_subcyclingOption
	Flag to specify whether subcycling is allowed or not in sequential schemes.

NonlinearAccelerationType	m_nonlinearAccelerationType
	Type of nonlinear acceleration for sequential solver.

real64	m_minNormalizer = 1e-12
	Value used to make sure that residual normalizers are not too small when computing residual norm.

Additional Inherited Members
Protected Member Functions inherited from geos::dataRepository::Group
virtual void	initializePreSubGroups ()
	Called by Initialize() prior to initializing sub-Groups.

virtual void	initializePostSubGroups ()
	Called by Initialize() after to initializing sub-Groups.

virtual void	initializePostInitialConditionsPreSubGroups ()
	Called by InitializePostInitialConditions() prior to initializing sub-Groups.

virtual void	initializePostInitialConditionsPostSubGroups ()
	Called by InitializePostInitialConditions() after to initializing sub-Groups.

virtual void	postRestartInitialization ()
	Performs initialization required after reading from a restart file.

Detailed Description

Definition at line 29 of file NonlinearSolverParameters.hpp.

Member Enumeration Documentation

◆ CouplingType

enum geos::NonlinearSolverParameters::CouplingType : integer

strong

Coupling type.

Enumerator
FullyImplicit	Fully-implicit coupling.
Sequential	Sequential coupling.

Definition at line 167 of file NonlinearSolverParameters.hpp.

◆ LineSearchAction

enum geos::NonlinearSolverParameters::LineSearchAction : integer

strong

Indicates the handling of line search in a Newton loop.

Enumerator
None	Do not use line search.
Attempt	Use line search. Allow exit from line search without achieving smaller residual than starting residual.
Require	Use line search. If smaller residual than starting residual is not achieved, cut time step.

Definition at line 148 of file NonlinearSolverParameters.hpp.

◆ LineSearchInterpolationType

enum geos::NonlinearSolverParameters::LineSearchInterpolationType : integer

strong

Indicates the handling of line each interpolation strategy.

Enumerator
Linear	linear decrease of line search scaling factor.
Parabolic	use parabolic interpolation to define line search scaling factor.

Definition at line 158 of file NonlinearSolverParameters.hpp.

◆ NonlinearAccelerationType

enum geos::NonlinearSolverParameters::NonlinearAccelerationType : integer

strong

Nonlinear acceleration type.

Enumerator
None	no acceleration
Aitken	Aitken acceleration.

Definition at line 186 of file NonlinearSolverParameters.hpp.

◆ SequentialConvergenceCriterion

enum geos::NonlinearSolverParameters::SequentialConvergenceCriterion : integer

strong

Sequential convergence criterion.

Enumerator
ResidualNorm	convergence achieved when the residual drops below a given norm
NumberOfNonlinearIterations	convergence achieved when the subproblems convergence is achieved in less than minNewtonIteration
SolutionIncrements	convergence achieved when the solution increments are small enough

Definition at line 176 of file NonlinearSolverParameters.hpp.

Constructor & Destructor Documentation

◆ NonlinearSolverParameters() [1/2]

geos::NonlinearSolverParameters::NonlinearSolverParameters	(	string const &	name,
		Group *const	parent
	)

Constructor.

Parameters

[in]	name	The name of the new instantiation of this Group.
[in]	parent	A pointer to the parent of this Group.

◆ NonlinearSolverParameters() [2/2]

geos::NonlinearSolverParameters::NonlinearSolverParameters ( NonlinearSolverParameters && )

default

Default Move Constructor.

Parameters

The	source object of the move.

Member Function Documentation

◆ catalogName()

static string geos::NonlinearSolverParameters::catalogName ( )

inlinestatic

The name of this object in the catalog.

Returns: A string containing the name of this object in the catalog. The CatalogName is the string that will result in the creation of a new NonlinearSolverParameters object when calling Group::getCatalog()::Allocate().

Definition at line 101 of file NonlinearSolverParameters.hpp.

◆ couplingType()

CouplingType geos::NonlinearSolverParameters::couplingType ( ) const

inline

Getter for the coupling type.

Returns: the coupling type

Definition at line 253 of file NonlinearSolverParameters.hpp.

◆ minTimeStepIncreaseInterval()

integer geos::NonlinearSolverParameters::minTimeStepIncreaseInterval ( ) const

inline

Getter for the minimum interval for increasing the time-step.

Returns: the minimum interval for increasing the time-step

Definition at line 235 of file NonlinearSolverParameters.hpp.

◆ normType()

physicsSolverBaseKernels::NormType geos::NonlinearSolverParameters::normType ( ) const

inline

Getter for the norm type used to check convergence in the flow/well solvers.

Returns: the norm type

Definition at line 244 of file NonlinearSolverParameters.hpp.

◆ operator=()

NonlinearSolverParameters& geos::NonlinearSolverParameters::operator= ( const NonlinearSolverParameters & params )

inline

Copy Constructor.

Parameters

The	source object.

Definition at line 61 of file NonlinearSolverParameters.hpp.

◆ postInputInitialization()

virtual void geos::NonlinearSolverParameters::postInputInitialization ( )

overridevirtual

This function provides capability to post process input values prior to any other initialization operations.

Reimplemented from geos::dataRepository::Group.

◆ sequentialConvergenceCriterion()

SequentialConvergenceCriterion geos::NonlinearSolverParameters::sequentialConvergenceCriterion ( ) const

inline

Getter for the sequential convergence criterion.

Returns: the sequential convergence criterion

Definition at line 262 of file NonlinearSolverParameters.hpp.

◆ timeStepDecreaseFactor()

real64 geos::NonlinearSolverParameters::timeStepDecreaseFactor ( ) const

inline

Getter for the factor used to decrease the time step size.

Returns: the factor used to decrease the time step size

Definition at line 217 of file NonlinearSolverParameters.hpp.

◆ timeStepDecreaseIterLimit()

integer geos::NonlinearSolverParameters::timeStepDecreaseIterLimit ( ) const

inline

Calculates the upper limit for the number of iterations to allow a decrease to the next time step.

Returns: The scaled value of the limit (m_timeStepDecreaseIterLimit * m_maxIterNewton)

Definition at line 197 of file NonlinearSolverParameters.hpp.

◆ timeStepIncreaseFactor()

real64 geos::NonlinearSolverParameters::timeStepIncreaseFactor ( ) const

inline

Getter for the factor used to increase the time step size.

Returns: the factor used to increase the time step size

Definition at line 226 of file NonlinearSolverParameters.hpp.

◆ timeStepIncreaseIterLimit()

integer geos::NonlinearSolverParameters::timeStepIncreaseIterLimit ( ) const

inline

Calculates the lower limit for the number of iterations to force an increase to the next time step.

Returns: The scaled value of the limit (m_timeStepIncreaseIterLimit * m_maxIterNewton)

Definition at line 208 of file NonlinearSolverParameters.hpp.

The documentation for this class was generated from the following file:

coreComponents/physicsSolvers/NonlinearSolverParameters.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CouplingType

◆ LineSearchAction

◆ LineSearchInterpolationType

◆ NonlinearAccelerationType

◆ SequentialConvergenceCriterion

Constructor & Destructor Documentation

◆ NonlinearSolverParameters() [1/2]

◆ NonlinearSolverParameters() [2/2]

Member Function Documentation

◆ catalogName()

◆ couplingType()

◆ minTimeStepIncreaseInterval()

◆ normType()

◆ operator=()

◆ postInputInitialization()

◆ sequentialConvergenceCriterion()

◆ timeStepDecreaseFactor()

◆ timeStepDecreaseIterLimit()

◆ timeStepIncreaseFactor()

◆ timeStepIncreaseIterLimit()