LinearSolverParameters Class Reference

#include <SolverParameters.h>

Inheritance diagram for LinearSolverParameters:

Public Member Functions
void	loadParameters (unsigned int _var_index, SolverToleranceType _tolerance_type, double _tolerance_value, unsigned int _max_iterations)
unsigned int	getMaxIterations (unsigned int index)
Public Member Functions inherited from SolverParametersBase
SolverToleranceType	getToleranceType (unsigned int index)
double	getToleranceValue (unsigned int index)

Protected Attributes
std::vector< unsigned int >	max_iterations_list
Protected Attributes inherited from SolverParametersBase
std::vector< unsigned int >	var_index_list
std::vector< SolverToleranceType >	tolerance_type_list
std::vector< double >	tolerance_value_list

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

Detailed Description

This class holds all of the parameters for the linear solver. Requests for linear solver parameters for governing equations without a matrix inversion return errors.

Member Function Documentation

getMaxIterations()

unsigned int LinearSolverParameters::getMaxIterations

(

unsigned int

index

)

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

loadParameters()

void LinearSolverParameters::loadParameters	(	unsigned int	_var_index,
		SolverToleranceType	_tolerance_type,
		double	_tolerance_value,
		unsigned int	_max_iterations
	)

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

---

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

• /home/runner/work/phaseField/phaseField/include/core/solvers/SolverParameters.h
• /home/runner/work/phaseField/phaseField/src/core/solvers/SolverParameters.cc