#include <BatteryBC.h>

Inheritance diagram for BatteryModelOptions< T >:

Collaboration diagram for BatteryModelOptions< T >:

Public Member Functions
	BatteryModelOptions ()

LinearSolver &	getLinearSolver ()

LinearSolver &	getLinearSolverSpecies ()

LinearSolver &	getLinearSolverPotential ()

LinearSolver &	getLinearSolverThermal ()

LinearSolver &	getLinearSolverPC ()

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

double	relativeSpeciesTolerance

double	absoluteSpeciesTolerance

double	relativePotentialTolerance

double	absolutePotentialTolerance

double	relativeThermalTolerance

double	absoluteThermalTolerance

double	relativePCTolerance

double	absolutePCTolerance

bool	useCentralDifference

LinearSolver *	linearSolver

LinearSolver *	linearSolverSpecies

LinearSolver *	linearSolverPotential

LinearSolver *	linearSolverThermal

LinearSolver *	linearSolverPC

bool	transient

bool	ButlerVolmer

bool	thermalModelPC

int	timeDiscretizationOrder

int	advanceVerbosity

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 BatteryModelOptions< T >

Definition at line 78 of file BatteryBC.h.

Constructor & Destructor Documentation

template<class T>

BatteryModelOptions< T >::BatteryModelOptions ( )

inline

Definition at line 80 of file BatteryBC.h.

   {
     this->defineVar("ButlerVolmerRRConstant",T(5.0e-7));
     this->defineVar("ButlerVolmerAnodeShellMeshID", int(-1));
     this->defineVar("ButlerVolmerCathodeShellMeshID", int(-1));
     this->defineVar("BatteryElectrolyteMeshID", int(-1));
     this->defineVar("timeStep",T(0.1));
     this->defineVar("interfaceSpeciesUnderRelax",T(1.0));
     this->relativeTolerance=1e-8;
     this->absoluteTolerance=1e-16;
     this->relativeSpeciesTolerance=1e-8;
     this->absoluteSpeciesTolerance=1e-16;
     this->relativePotentialTolerance=1e-8;
     this->absolutePotentialTolerance=1e-16;
     this->relativeThermalTolerance=1e-8;
     this->absoluteThermalTolerance=1e-16;
     this->relativePCTolerance=1e-8;
     this->absolutePCTolerance=1e-16;
     this->linearSolver = 0;
     this->linearSolverSpecies = 0;
     this->linearSolverPotential = 0;
     this->linearSolverThermal = 0;
     this->linearSolverPC = 0;
     this->useCentralDifference=false;
     this->transient = true;
     this->ButlerVolmer = false;
     this->thermalModelPC = true;
     this->timeDiscretizationOrder=2;
     this->advanceVerbosity=1;
   }

Member Function Documentation

template<class T>

LinearSolver& BatteryModelOptions< T >::getLinearSolver ( )

inline

Definition at line 133 of file BatteryBC.h.

References BatteryModelOptions< 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 ;
   }

template<class T>

LinearSolver& BatteryModelOptions< T >::getLinearSolverPC ( )

inline

Definition at line 184 of file BatteryBC.h.

References BatteryModelOptions< T >::linearSolverPC, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

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

template<class T>

LinearSolver& BatteryModelOptions< T >::getLinearSolverPotential ( )

inline

Definition at line 158 of file BatteryBC.h.

References BatteryModelOptions< T >::linearSolverPotential, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

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

template<class T>

LinearSolver& BatteryModelOptions< T >::getLinearSolverSpecies ( )

inline

Definition at line 146 of file BatteryBC.h.

References BatteryModelOptions< T >::linearSolverSpecies, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

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

template<class T>

LinearSolver& BatteryModelOptions< T >::getLinearSolverThermal ( )

inline

Definition at line 171 of file BatteryBC.h.

References BatteryModelOptions< T >::linearSolverThermal, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

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