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.

Definition at line 15 of file SolverParameters.h.

Member Function Documentation

getEquationIndex()

unsigned int getEquationIndex ( unsigned int  global_index )

protected

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

Definition at line 14 of file SolverParameters.cc.

getToleranceType()

SolverToleranceType getToleranceType

(

unsigned int

index

)

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

Definition at line 4 of file SolverParameters.cc.

getToleranceValue()

double getToleranceValue

(

unsigned int

index

)

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

Definition at line 8 of file SolverParameters.cc.

Member Data Documentation

tolerance_type_list

std::vector<SolverToleranceType> tolerance_type_list

protected

Definition at line 32 of file SolverParameters.h.

tolerance_value_list

std::vector<double> tolerance_value_list

protected

Definition at line 33 of file SolverParameters.h.

var_index_list

std::vector<unsigned int> var_index_list

protected

Definition at line 30 of file SolverParameters.h.

---

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

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