NonlinearSolverParameters Class Reference

#include <SolverParameters.h>

Inheritance diagram for NonlinearSolverParameters:

Public Member Functions
void	setMaxIterations (unsigned int _max_iterations)
double	getMaxIterations ()
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)

Private Attributes
unsigned int	max_iterations
std::vector< bool >	backtrack_damping_flag_list
std::vector< double >	backtrack_step_modifier_list
std::vector< double >	backtrack_residual_decrease_coeff_list
std::vector< double >	default_damping_coefficient_list
std::vector< bool >	laplace_for_initial_guess_list

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.

Definition at line 74 of file SolverParameters.h.

Member Function Documentation

getBacktrackDampingFlag()

bool getBacktrackDampingFlag

(

unsigned int

index

)

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

Definition at line 58 of file SolverParameters.cc.

getBacktrackResidualDecreaseCoeff()

double getBacktrackResidualDecreaseCoeff

(

unsigned int

index

)

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

Definition at line 66 of file SolverParameters.cc.

getBacktrackStepModifier()

double getBacktrackStepModifier

(

unsigned int

index

)

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

Definition at line 62 of file SolverParameters.cc.

getDefaultDampingCoefficient()

double getDefaultDampingCoefficient

(

unsigned int

index

)

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

Definition at line 70 of file SolverParameters.cc.

getLaplaceInitializationFlag()

bool 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.

Definition at line 74 of file SolverParameters.cc.

getMaxIterations()

double getMaxIterations

(

)

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

Definition at line 82 of file SolverParameters.cc.

loadParameters()

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
	)

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

Definition at line 39 of file SolverParameters.cc.

setMaxIterations()

void setMaxIterations

(

unsigned int

_max_iterations

)

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

Definition at line 78 of file SolverParameters.cc.

Member Data Documentation

backtrack_damping_flag_list

std::vector<bool> backtrack_damping_flag_list

private

Definition at line 130 of file SolverParameters.h.

backtrack_residual_decrease_coeff_list

std::vector<double> backtrack_residual_decrease_coeff_list

private

Definition at line 132 of file SolverParameters.h.

backtrack_step_modifier_list

std::vector<double> backtrack_step_modifier_list

private

Definition at line 131 of file SolverParameters.h.

default_damping_coefficient_list

std::vector<double> default_damping_coefficient_list

private

Definition at line 133 of file SolverParameters.h.

laplace_for_initial_guess_list

std::vector<bool> laplace_for_initial_guess_list

private

Definition at line 134 of file SolverParameters.h.

max_iterations

unsigned int max_iterations

private

Definition at line 128 of file SolverParameters.h.

---

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

• include/SolverParameters.h
• src/SolverParameters/SolverParameters.cc