SpeciesModel< T > Class Template Reference

#include <SpeciesModel.h>

Inheritance diagram for SpeciesModel< T >:

Collaboration diagram for SpeciesModel< T >:

Classes
class	Impl

Public Types
typedef std::map< int, SpeciesBC< T > * >	SpeciesBCMap
typedef std::map< int, SpeciesVC< T > * >	SpeciesVCMap

Public Member Functions
	SpeciesModel (const GeomFields &geomFields, const MeshList &meshes, const int nSpecies)
virtual	~SpeciesModel ()
virtual void	init ()
SpeciesFields &	getSpeciesFields (const int speciesId)
SpeciesBCMap &	getBCMap (const int speciesId)
SpeciesVCMap &	getVCMap (const int speciesId)
SpeciesBC< T > &	getBC (const int id, const int speciesId)
SpeciesModelOptions< T > &	getOptions ()
T	getMassFluxIntegral (const Mesh &mesh, const int faceGroupId, const int m)
T	getAverageMassFraction (const Mesh &mesh, const int m)
T	getMassFractionResidual (const int speciesId)
void	printBCs ()
void	updateTime ()
void	advance (const int niter)
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 SpeciesModel< T >

Definition at line 19 of file SpeciesModel.h.

Member Typedef Documentation

template<class T>

typedef std::map<int,SpeciesBC<T>*> SpeciesModel< T >::SpeciesBCMap

Definition at line 23 of file SpeciesModel.h.

template<class T>

typedef std::map<int,SpeciesVC<T>*> SpeciesModel< T >::SpeciesVCMap

Definition at line 24 of file SpeciesModel.h.

Constructor & Destructor Documentation

template<class T >

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

Definition at line 784 of file SpeciesModel_impl.h.

References logCtor.

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

template<class T >

SpeciesModel< T >::~SpeciesModel ( )

virtual

Definition at line 795 of file SpeciesModel_impl.h.

References logDtor.

{
  logDtor();
}

Member Function Documentation

template<class T >

void SpeciesModel< T >::advance

(

const int

niter

)

Definition at line 837 of file SpeciesModel_impl.h.

{
  _impl->advance(niter);
}

template<class T >

T SpeciesModel< T >::getAverageMassFraction	(	const Mesh &	mesh,
		const int	m
	)

Definition at line 858 of file SpeciesModel_impl.h.

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

template<class T >

SpeciesBC< T > & SpeciesModel< T >::getBC	(	const int	id,
		const int	speciesId
	)

Definition at line 821 of file SpeciesModel_impl.h.

{return _impl->getBC(id, speciesId);}

template<class T >

SpeciesModel< T >::SpeciesBCMap & SpeciesModel< T >::getBCMap

(

const int

speciesId

)

Definition at line 813 of file SpeciesModel_impl.h.

{return _impl->getBCMap(speciesId);}

template<class T >

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

Definition at line 851 of file SpeciesModel_impl.h.

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

template<class T >

T SpeciesModel< T >::getMassFractionResidual

(

const int

speciesId

)

Definition at line 865 of file SpeciesModel_impl.h.

{
  return _impl->getMassFractionResidual(speciesId);
}

template<class T >

SpeciesModelOptions< T > & SpeciesModel< T >::getOptions

(

)

Definition at line 825 of file SpeciesModel_impl.h.

{return _impl->getOptions();}

template<class T >

SpeciesFields & SpeciesModel< T >::getSpeciesFields

(

const int

speciesId

)

Definition at line 809 of file SpeciesModel_impl.h.

{return _impl->getSpeciesFields(speciesId);}

template<class T >

SpeciesModel< T >::SpeciesVCMap & SpeciesModel< T >::getVCMap

(

const int

speciesId

)

Definition at line 817 of file SpeciesModel_impl.h.

{return _impl->getVCMap(speciesId);}

template<class T >

void SpeciesModel< T >::init ( )

virtual

Implements Model.

Definition at line 802 of file SpeciesModel_impl.h.

{
  _impl->init();
}

template<class T >

void SpeciesModel< T >::printBCs

(

)

Definition at line 830 of file SpeciesModel_impl.h.

{
  _impl->printBCs();
}

template<class T >

void SpeciesModel< T >::updateTime

(

)

Definition at line 844 of file SpeciesModel_impl.h.

{
  _impl->updateTime();
}

Member Data Documentation

template<class T>

shared_ptr<Impl> SpeciesModel< T >::_impl

private

Definition at line 54 of file SpeciesModel.h.

---

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

• SpeciesModel.h
• SpeciesModel_impl.h