#include <SpeciesBC.h>

Inheritance diagram for SpeciesModelOptions< T >:

Collaboration diagram for SpeciesModelOptions< T >:

Public Member Functions
	SpeciesModelOptions ()

LinearSolver &	getLinearSolver ()

Public Member Functions inherited from FloatVarDict< T >
bool	hasVar (const string varName) const

T	operator[] (const string varName) const

bool	isField (const string varName) const

Field &	getField (const string varName) const

FloatVal< T >	getVal (const string varName) const

Public Attributes
double	relativeTolerance

double	absoluteTolerance

bool	useCentralDifference

LinearSolver *	linearSolver

bool	transient

bool	ButlerVolmer

int	timeDiscretizationOrder

Additional Inherited Members
Public Types inherited from FloatVarDict< T >
typedef map< string, FloatVal < T > >	T_Parent

Protected Member Functions inherited from FloatVarDict< T >
void	defineVar (const string varName, const T defaultValue)

Detailed Description

template<class T>
struct SpeciesModelOptions< T >

Definition at line 32 of file SpeciesBC.h.

Constructor & Destructor Documentation

template<class T>

SpeciesModelOptions< T >::SpeciesModelOptions ( )

inline

Definition at line 34 of file SpeciesBC.h.

References SpeciesModelOptions< T >::absoluteTolerance, SpeciesModelOptions< T >::ButlerVolmer, FloatVarDict< T >::defineVar(), SpeciesModelOptions< T >::linearSolver, SpeciesModelOptions< T >::relativeTolerance, SpeciesModelOptions< T >::timeDiscretizationOrder, and SpeciesModelOptions< T >::useCentralDifference.

   {
     this->defineVar("A_coeff",T(1.0));
     this->defineVar("B_coeff",T(0.0));
     this->defineVar("ButlerVolmerRRConstant",T(5.0e-7));
     this->defineVar("ButlerVolmerAnodeShellMeshID", int(-1));
     this->defineVar("ButlerVolmerCathodeShellMeshID", int(-1));
     this->defineVar("timeStep",T(0.1));
     this->defineVar("interfaceUnderRelax",T(1.0));
     this->relativeTolerance=1e-8;
     this->absoluteTolerance=1e-16;
     this->linearSolver = 0;
     this->useCentralDifference=false;
     this->transient = false;
     this->ButlerVolmer = false;
     this->timeDiscretizationOrder=1;
   }

Member Function Documentation

template<class T>

LinearSolver& SpeciesModelOptions< T >::getLinearSolver ( )

inline

Definition at line 60 of file SpeciesBC.h.

References SpeciesModelOptions< T >::linearSolver, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

   {
     if (this->linearSolver == 0)
     {
         LinearSolver* ls(new  AMG());
         ls->relativeTolerance = 1e-1;
         ls->nMaxIterations = 20;
         ls->verbosity=0;
         this->linearSolver = ls;
     }
     return *this->linearSolver ;
   }