BatteryModel< T > Class Template Reference

#include <BatteryModel.h>

Inheritance diagram for BatteryModel< T >:

Collaboration diagram for BatteryModel< T >:

Classes
class	Impl

Public Types
typedef std::map< int, BatterySpeciesBC< T > * >	BatterySpeciesBCMap
typedef std::map< int, BatterySpeciesVC< T > * >	BatterySpeciesVCMap
typedef std::map< int, BatteryPotentialBC< T > * >	BatteryPotentialBCMap
typedef std::map< int, BatteryPotentialVC< T > * >	BatteryPotentialVCMap
typedef std::map< int, BatteryThermalBC< T > * >	BatteryThermalBCMap
typedef std::map< int, BatteryThermalVC< T > * >	BatteryThermalVCMap

Public Member Functions
	BatteryModel (GeomFields &geomFields, const MeshList &realMeshes, const MeshList &meshes, const int nSpecies)
virtual	~BatteryModel ()
virtual void	init ()
BatterySpeciesFields &	getBatterySpeciesFields (const int speciesId)
BatteryModelFields &	getBatteryModelFields ()
BatterySpeciesBCMap &	getSpeciesBCMap (const int speciesId)
BatteryPotentialBCMap &	getPotentialBCMap ()
BatteryThermalBCMap &	getThermalBCMap ()
BatterySpeciesVCMap &	getSpeciesVCMap (const int speciesId)
BatteryPotentialVCMap &	getPotentialVCMap ()
BatteryThermalVCMap &	getThermalVCMap ()
BatteryModelOptions< T > &	getOptions ()
T	getMassFluxIntegral (const Mesh &mesh, const int faceGroupId, const int m)
T	getPotentialFluxIntegral (const Mesh &mesh, const int faceGroupId)
T	getHeatFluxIntegral (const Mesh &mesh, const int faceGroupId)
T	getAverageConcentration (const Mesh &mesh, const int m)
T	getFaceGroupArea (const Mesh &mesh, const int fgID)
T	getFaceGroupVoltage (const Mesh &mesh, const int fgID)
T	getMeshVolume (const Mesh &mesh)
T	getSpeciesResidual (const int speciesId)
T	getPotentialResidual ()
T	getThermalResidual ()
T	getPCResidual (const int v)
void	updateTime ()
void	recoverLastTimestep ()
void	advanceSpecies (const int niter)
void	advancePotential (const int niter)
void	advanceThermal (const int niter)
void	advanceCoupled (const int niter)
void	copySeparateToCoupled ()
void	copyCoupledToSeparate ()
Public Member Functions inherited from Model
	Model (const MeshList &meshes)
virtual	~Model ()
	DEFINE_TYPENAME ("Model")
virtual map< string, shared_ptr< ArrayBase > > &	getPersistenceData ()
virtual void	restart ()

Private Attributes
shared_ptr< Impl >	_impl

Additional Inherited Members
Protected Attributes inherited from Model
const MeshList	_meshes
StorageSiteList	_varSites
StorageSiteList	_fluxSites
map< string, shared_ptr < ArrayBase > >	_persistenceData

Detailed Description

template<class T>
class BatteryModel< T >

Definition at line 19 of file BatteryModel.h.

Member Typedef Documentation

template<class T>

typedef std::map<int,BatteryPotentialBC<T>*> BatteryModel< T >::BatteryPotentialBCMap

Definition at line 25 of file BatteryModel.h.

template<class T>

typedef std::map<int,BatteryPotentialVC<T>*> BatteryModel< T >::BatteryPotentialVCMap

Definition at line 26 of file BatteryModel.h.

template<class T>

typedef std::map<int,BatterySpeciesBC<T>*> BatteryModel< T >::BatterySpeciesBCMap

Definition at line 23 of file BatteryModel.h.

template<class T>

typedef std::map<int,BatterySpeciesVC<T>*> BatteryModel< T >::BatterySpeciesVCMap

Definition at line 24 of file BatteryModel.h.

template<class T>

typedef std::map<int,BatteryThermalBC<T>*> BatteryModel< T >::BatteryThermalBCMap

Definition at line 27 of file BatteryModel.h.

template<class T>

typedef std::map<int,BatteryThermalVC<T>*> BatteryModel< T >::BatteryThermalVCMap

Definition at line 28 of file BatteryModel.h.

Constructor & Destructor Documentation

template<class T >

BatteryModel< T >::BatteryModel	(	GeomFields &	geomFields,
		const MeshList &	realMeshes,
		const MeshList &	meshes,
		const int	nSpecies
	)

Definition at line 3478 of file BatteryModel_impl.h.

References logCtor.

                                                  :
  Model(meshes),
    _impl(new Impl(geomFields,realMeshes,meshes,nSpecies))
{
  logCtor();
}

template<class T >

BatteryModel< T >::~BatteryModel ( )

virtual

Definition at line 3489 of file BatteryModel_impl.h.

References logDtor.

{
  logDtor();
}

Member Function Documentation

template<class T >

void BatteryModel< T >::advanceCoupled

(

const int

niter

)

Definition at line 3559 of file BatteryModel_impl.h.

{
  _impl->advanceCoupled(niter);
}

template<class T >

void BatteryModel< T >::advancePotential

(

const int

niter

)

Definition at line 3545 of file BatteryModel_impl.h.

{
  _impl->advancePotential(niter);
}

template<class T >

void BatteryModel< T >::advanceSpecies

(

const int

niter

)

Definition at line 3538 of file BatteryModel_impl.h.

{
  _impl->advanceSpecies(niter);
}

template<class T >

void BatteryModel< T >::advanceThermal

(

const int

niter

)

Definition at line 3552 of file BatteryModel_impl.h.

{
  _impl->advanceThermal(niter);
}

template<class T >

void BatteryModel< T >::copyCoupledToSeparate

(

)

Definition at line 3637 of file BatteryModel_impl.h.

{
  _impl->copyCoupledToSeparate();
}

template<class T >

void BatteryModel< T >::copySeparateToCoupled

(

)

Definition at line 3644 of file BatteryModel_impl.h.

{
  _impl->copySeparateToCoupled();
}

template<class T >

T BatteryModel< T >::getAverageConcentration	(	const Mesh &	mesh,
		const int	m
	)

Definition at line 3602 of file BatteryModel_impl.h.

{
  return _impl->getAverageConcentration(mesh, m);
}

template<class T >

BatteryModelFields & BatteryModel< T >::getBatteryModelFields

(

)

Definition at line 3514 of file BatteryModel_impl.h.

{return _impl->getBatteryModelFields();}

template<class T >

BatterySpeciesFields & BatteryModel< T >::getBatterySpeciesFields

(

const int

speciesId

)

Definition at line 3502 of file BatteryModel_impl.h.

{return _impl->getBatterySpeciesFields(speciesId);}

template<class T >

T BatteryModel< T >::getFaceGroupArea	(	const Mesh &	mesh,
		const int	fgID
	)

Definition at line 3651 of file BatteryModel_impl.h.

{
  return _impl->getFaceGroupArea(mesh, fgID);
}

template<class T >

T BatteryModel< T >::getFaceGroupVoltage	(	const Mesh &	mesh,
		const int	fgID
	)

Definition at line 3658 of file BatteryModel_impl.h.

{
  return _impl->getFaceGroupVoltage(mesh, fgID);
}

template<class T >

T BatteryModel< T >::getHeatFluxIntegral	(	const Mesh &	mesh,
		const int	faceGroupId
	)

Definition at line 3595 of file BatteryModel_impl.h.

{
  return _impl->getHeatFluxIntegral(mesh, faceGroupId);
}

template<class T >

T BatteryModel< T >::getMassFluxIntegral	(	const Mesh &	mesh,
		const int	faceGroupId,
		const int	m
	)

Definition at line 3581 of file BatteryModel_impl.h.

{
  return _impl->getMassFluxIntegral(mesh, faceGroupId, m);
}

template<class T >

T BatteryModel< T >::getMeshVolume

(

const Mesh &

mesh

)

Definition at line 3665 of file BatteryModel_impl.h.

{
  return _impl->getMeshVolume(mesh);
}

template<class T >

BatteryModelOptions< T > & BatteryModel< T >::getOptions

(

)

Definition at line 3534 of file BatteryModel_impl.h.

{return _impl->getOptions();}

template<class T >

T BatteryModel< T >::getPCResidual

(

const int

v

)

Definition at line 3630 of file BatteryModel_impl.h.

{
  return _impl->getPCResidual(v);
}

template<class T >

BatteryModel< T >::BatteryPotentialBCMap & BatteryModel< T >::getPotentialBCMap

(

)

Definition at line 3518 of file BatteryModel_impl.h.

{return _impl->getPotentialBCMap();}

template<class T >

T BatteryModel< T >::getPotentialFluxIntegral	(	const Mesh &	mesh,
		const int	faceGroupId
	)

Definition at line 3588 of file BatteryModel_impl.h.

{
  return _impl->getPotentialFluxIntegral(mesh, faceGroupId);
}

template<class T >

T BatteryModel< T >::getPotentialResidual

(

)

Definition at line 3616 of file BatteryModel_impl.h.

{
  return _impl->getPotentialResidual();
}

template<class T >

BatteryModel< T >::BatteryPotentialVCMap & BatteryModel< T >::getPotentialVCMap

(

)

Definition at line 3522 of file BatteryModel_impl.h.

{return _impl->getPotentialVCMap();}

template<class T >

BatteryModel< T >::BatterySpeciesBCMap & BatteryModel< T >::getSpeciesBCMap

(

const int

speciesId

)

Definition at line 3506 of file BatteryModel_impl.h.

{return _impl->getSpeciesBCMap(speciesId);}

template<class T >

T BatteryModel< T >::getSpeciesResidual

(

const int

speciesId

)

Definition at line 3609 of file BatteryModel_impl.h.

{
  return _impl->getSpeciesResidual(speciesId);
}

template<class T >

BatteryModel< T >::BatterySpeciesVCMap & BatteryModel< T >::getSpeciesVCMap

(

const int

speciesId

)

Definition at line 3510 of file BatteryModel_impl.h.

{return _impl->getSpeciesVCMap(speciesId);}

template<class T >

BatteryModel< T >::BatteryThermalBCMap & BatteryModel< T >::getThermalBCMap

(

)

Definition at line 3526 of file BatteryModel_impl.h.

{return _impl->getThermalBCMap();}

template<class T >

T BatteryModel< T >::getThermalResidual

(

)

Definition at line 3623 of file BatteryModel_impl.h.

{
  return _impl->getThermalResidual();
}

template<class T >

BatteryModel< T >::BatteryThermalVCMap & BatteryModel< T >::getThermalVCMap

(

)

Definition at line 3530 of file BatteryModel_impl.h.

{return _impl->getThermalVCMap();}

template<class T >

void BatteryModel< T >::init ( )

virtual

Implements Model.

Definition at line 3496 of file BatteryModel_impl.h.

{
  _impl->init();
}

template<class T >

void BatteryModel< T >::recoverLastTimestep

(

)

Definition at line 3573 of file BatteryModel_impl.h.

{
  _impl->recoverLastTimestep();
}

template<class T >

void BatteryModel< T >::updateTime

(

)

Definition at line 3566 of file BatteryModel_impl.h.

{
  _impl->updateTime();
}

Member Data Documentation

template<class T>

shared_ptr<Impl> BatteryModel< T >::_impl

private

Definition at line 79 of file BatteryModel.h.

---

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

• BatteryModel.h
• BatteryModel_impl.h