#include <SolverParameters.h>

Inheritance diagram for NonlinearSolverParameters:

Public Member Functions
void	setMaxIterations (unsigned int _max_iterations)

double	getMaxIterations () const

void	loadParameters (unsigned int _var_index, SolverToleranceType _tolerance_type, double _tolerance_value, bool _backtrack_damping_flag, double _backtrack_step_modifier, double _backtrack_residual_decrease_coeff, double _default_dampling_coefficient, bool _laplace_for_initial_guess)

bool	getBacktrackDampingFlag (unsigned int index)

double	getBacktrackStepModifier (unsigned int index)

double	getBacktrackResidualDecreaseCoeff (unsigned int index)

double	getDefaultDampingCoefficient (unsigned int index)

bool	getLaplaceInitializationFlag (unsigned int index)

Public Member Functions inherited from SolverParametersBase
SolverToleranceType	getToleranceType (unsigned int index)

double	getToleranceValue (unsigned int index)

Additional Inherited Members
Protected Member Functions inherited from SolverParametersBase
unsigned int	getEquationIndex (unsigned int global_index)

Protected Attributes inherited from SolverParametersBase
std::vector< unsigned int >	var_index_list

std::vector< SolverToleranceType >	tolerance_type_list

std::vector< double >	tolerance_value_list

Detailed Description

This class holds all of the parameters for the nonlinear solver. Requests for nonlinear solver parameters for non-nonlinear governing equations return errors.

Member Function Documentation

◆ getBacktrackDampingFlag()

bool NonlinearSolverParameters::getBacktrackDampingFlag ( unsigned int index )

Method to get the backtrack line-search damping flag for one of the governing equations.

◆ getBacktrackResidualDecreaseCoeff()

double NonlinearSolverParameters::getBacktrackResidualDecreaseCoeff ( unsigned int index )

Method to get the backtrack line-search damping residual decrease coefficient for one of the governing equations.

◆ getBacktrackStepModifier()

double NonlinearSolverParameters::getBacktrackStepModifier ( unsigned int index )

Method to get the backtrack line-search damping step size modifier for one of the governing equations.

◆ getDefaultDampingCoefficient()

double NonlinearSolverParameters::getDefaultDampingCoefficient ( unsigned int index )

Method to get the default damping coefficient for one of the governing equations.

◆ getLaplaceInitializationFlag()

bool NonlinearSolverParameters::getLaplaceInitializationFlag ( unsigned int index )

Method to get the flag determining if the solution to Laplace's equation should be used as the initial guess for one of the governing equations.

◆ getMaxIterations()

double NonlinearSolverParameters::getMaxIterations ( ) const

Method to get the maximum number of allowed iterations for the nonlinear solver.

◆ loadParameters()

void NonlinearSolverParameters::loadParameters	(	unsigned int	_var_index,
		SolverToleranceType	_tolerance_type,
		double	_tolerance_value,
		bool	_backtrack_damping_flag,
		double	_backtrack_step_modifier,
		double	_backtrack_residual_decrease_coeff,
		double	_default_dampling_coefficient,
		bool	_laplace_for_initial_guess
	)

Method to load the parameters for one governing equation into the class. This must be defined for all classes derived from SolverParametersBase.

◆ setMaxIterations()

void NonlinearSolverParameters::setMaxIterations ( unsigned int _max_iterations )