SolverParametersBase Class Reference

#include <SolverParameters.h>

Inheritance diagram for SolverParametersBase:

Public Member Functions
SolverToleranceType	getToleranceType (unsigned int index)
double	getToleranceValue (unsigned int index)

Protected Member Functions
unsigned int	getEquationIndex (unsigned int global_index)

Protected Attributes
std::vector< unsigned int >	var_index_list
std::vector< SolverToleranceType >	tolerance_type_list
std::vector< double >	tolerance_value_list

Detailed Description

This is a base class that holds parameters related to a numerical solver (either linear or nonlinear) As in many other PRISMS-PF classes, access to the parameters for the separate governing equations is specified via the global variable index. Requests for solver parameters for inappropriate governing equations return errors.

Member Function Documentation

getEquationIndex()

unsigned int SolverParametersBase::getEquationIndex ( unsigned int  global_index )

protected

Method to get the internal nonlinearSolverParameters index from the global variable index.

getToleranceType()

SolverToleranceType SolverParametersBase::getToleranceType

(

unsigned int

index

)

Method to get the tolerance type for one of the governing equations.

getToleranceValue()

double SolverParametersBase::getToleranceValue

(

unsigned int

index

)

Method to get the tolerance value for one of the governing equations.

---

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