#include <ElectricBC.h>

Inheritance diagram for ElectricModelOptions< T >:

Collaboration diagram for ElectricModelOptions< T >:

Public Member Functions
	ElectricModelOptions ()

LinearSolver &	getElectroStaticsLinearSolver ()

LinearSolver &	getChargeTransportLinearSolver ()

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
bool	printNormalizedResiduals

double	electrostaticsTolerance

double	chargetransportTolerance

double	tunnelingtransportTolerance

bool	ibm_enable

bool	transient_enable

bool	tunneling_enable

bool	emission_enable

bool	electrostatics_enable

bool	chargetransport_enable

bool	capture_enable

bool	injection_enable

bool	drift_enable

bool	diffusion_enable

bool	trapbandtunneling_enable

bool	ButlerVolmer

int	timeDiscretizationOrder

LinearSolver *	electrostaticsLinearSolver

LinearSolver *	chargetransportLinearSolver

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

Definition at line 82 of file ElectricBC.h.

Constructor & Destructor Documentation

template<class T>

ElectricModelOptions< T >::ElectricModelOptions ( )

inline

Definition at line 84 of file ElectricBC.h.

   {
     this->defineVar("initialCharge",T(0));
     this->defineVar("initialPotential",T(0.0));
     this->defineVar("initialTotalCharge", T(0.0));
     this->defineVar("initialTunnelingCharge", T(1.0));
     this->defineVar("timeStep",T(0.1));
     this->defineVar("Interface_A_coeff",T(1.0));
     this->defineVar("Interface_B_coeff",T(0.0));
     this->defineVar("ButlerVolmerRRConstant",T(5.0e-7));
     this->defineVar("ButlerVolmerAnodeShellMeshID", int(-1));
     this->defineVar("ButlerVolmerCathodeShellMeshID", int(-1));
     this->defineVar("BatteryElectrolyteMeshID", int(-1));
     this->ButlerVolmer = false;
     this->electrostaticsTolerance=1e-8;
     this->chargetransportTolerance=1e-8;
     this->electrostaticsLinearSolver = 0;
     this->chargetransportLinearSolver = 0;
     this->timeDiscretizationOrder = 1;
     this->transient_enable = true;
     this->ibm_enable = false;
     this->electrostatics_enable = true;
     this->chargetransport_enable = true;
     this->tunneling_enable = false;
     this->emission_enable = false;
     this->capture_enable = false;
     this->injection_enable = false;
     this->drift_enable = false;
     this->diffusion_enable = false;
     this->trapbandtunneling_enable = false;
     this->printNormalizedResiduals = true;
   }

Member Function Documentation

template<class T>

LinearSolver& ElectricModelOptions< T >::getChargeTransportLinearSolver ( )

inline

Definition at line 153 of file ElectricBC.h.

References ElectricModelOptions< T >::chargetransportLinearSolver, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

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

template<class T>

LinearSolver& ElectricModelOptions< T >::getElectroStaticsLinearSolver ( )

inline

Definition at line 140 of file ElectricBC.h.

References ElectricModelOptions< T >::electrostaticsLinearSolver, LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

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