ElectricModel< T > Class Template Reference

#include <ElectricModel.h>

Inheritance diagram for ElectricModel< T >:

Collaboration diagram for ElectricModel< T >:

Classes
class	Impl

Public Types
typedef std::map< int, ElectricBC< T > * >	ElectricBCMap
typedef std::map< int, ElectricVC< T > * >	ElectricVCMap
typedef Array< T >	TArray
typedef Vector< T, 3 >	VectorT3
typedef Vector< double, 3 >	VectorD3
typedef Array< VectorT3 >	VectorT3Array

Public Member Functions
	ElectricModel (const GeomFields &geomFields, ElectricFields &electricFields, const MeshList &meshes)
virtual	~ElectricModel ()
virtual void	init ()
virtual map< string, shared_ptr< ArrayBase > > &	getPersistenceData ()
virtual void	restart ()
ElectricBCMap &	getBCMap ()
ElectricBC< T > &	getBC (const int id)
ElectricVCMap &	getVCMap ()
ElectricVC< T > &	getVC (const int id)
ElectricModelOptions< T > &	getOptions ()
ElectricModelConstants< T > &	getConstants ()
void	computeIBFacePotential (const StorageSite &solid)
void	computeSolidSurfaceForce (const StorageSite &particles)
void	computeSolidSurfaceForcePerUnitArea (const StorageSite &particles)
void	printBCs ()
bool	advance (const int niter)
void	updateTime ()
void	calculateEquilibriumParameters ()
vector< T >	getTunnelCurrent ()
T	getPotentialFluxIntegral (const Mesh &mesh, const int faceGroupId)
Public Member Functions inherited from Model
	Model (const MeshList &meshes)
virtual	~Model ()
	DEFINE_TYPENAME ("Model")

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

Definition at line 19 of file ElectricModel.h.

Member Typedef Documentation

template<class T>

typedef std::map<int,ElectricBC<T>*> ElectricModel< T >::ElectricBCMap

Definition at line 23 of file ElectricModel.h.

template<class T>

typedef std::map<int,ElectricVC<T>*> ElectricModel< T >::ElectricVCMap

Definition at line 24 of file ElectricModel.h.

template<class T>

typedef Array<T> ElectricModel< T >::TArray

Definition at line 26 of file ElectricModel.h.

template<class T>

typedef Vector<double, 3> ElectricModel< T >::VectorD3

Definition at line 28 of file ElectricModel.h.

template<class T>

typedef Vector<T,3> ElectricModel< T >::VectorT3

Definition at line 27 of file ElectricModel.h.

template<class T>

typedef Array<VectorT3> ElectricModel< T >::VectorT3Array

Definition at line 29 of file ElectricModel.h.

Constructor & Destructor Documentation

template<class T >

ElectricModel< T >::ElectricModel	(	const GeomFields &	geomFields,
		ElectricFields &	electricFields,
		const MeshList &	meshes
	)

Definition at line 1496 of file ElectricModel_impl.h.

References logCtor.

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

template<class T >

ElectricModel< T >::~ElectricModel ( )

virtual

Definition at line 1507 of file ElectricModel_impl.h.

References logDtor.

{
  logDtor();
}

Member Function Documentation

template<class T >

bool ElectricModel< T >::advance

(

const int

niter

)

Definition at line 1578 of file ElectricModel_impl.h.

{
  return _impl->advance(niter);  
}

template<class T >

void ElectricModel< T >::calculateEquilibriumParameters

(

)

Definition at line 1585 of file ElectricModel_impl.h.

{
  _impl->calculateEquilibriumParameters();
}

template<class T >

void ElectricModel< T >::computeIBFacePotential

(

const StorageSite &

solid

)

Definition at line 1592 of file ElectricModel_impl.h.

{
  _impl->computeIBFacePotential(particles);
}

template<class T >

void ElectricModel< T >::computeSolidSurfaceForce

(

const StorageSite &

particles

)

Definition at line 1599 of file ElectricModel_impl.h.

{
  return _impl->computeSolidSurfaceForce(particles,false);
}

template<class T >

void ElectricModel< T >::computeSolidSurfaceForcePerUnitArea

(

const StorageSite &

particles

)

Definition at line 1613 of file ElectricModel_impl.h.

{
  return _impl->computeSolidSurfaceForce(particles,true);
}

template<class T >

ElectricBC< T > & ElectricModel< T >::getBC

(

const int

id

)

Definition at line 1551 of file ElectricModel_impl.h.

{return _impl->getBC(id);}

template<class T >

ElectricModel< T >::ElectricBCMap & ElectricModel< T >::getBCMap

(

)

Definition at line 1547 of file ElectricModel_impl.h.

{return _impl->getBCMap();}

template<class T >

ElectricModelConstants< T > & ElectricModel< T >::getConstants

(

)

Definition at line 1567 of file ElectricModel_impl.h.

{return _impl->getConstants();}

template<class T >

ElectricModelOptions< T > & ElectricModel< T >::getOptions

(

)

Definition at line 1563 of file ElectricModel_impl.h.

{return _impl->getOptions();}

template<class T >

map< string, shared_ptr< ArrayBase > > & ElectricModel< T >::getPersistenceData ( )

virtual

Reimplemented from Model.

Definition at line 1620 of file ElectricModel_impl.h.

{
  return _impl->getPersistenceData();
}

template<class T >

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

Definition at line 1606 of file ElectricModel_impl.h.

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

template<class T >

vector< T > ElectricModel< T >::getTunnelCurrent

(

)

Definition at line 1635 of file ElectricModel_impl.h.

{
  return _impl->getTunnelCurrent();
}

template<class T >

ElectricVC< T > & ElectricModel< T >::getVC

(

const int

id

)

Definition at line 1559 of file ElectricModel_impl.h.

{return _impl->getVC(id);}

template<class T >

ElectricModel< T >::ElectricVCMap & ElectricModel< T >::getVCMap

(

)

Definition at line 1555 of file ElectricModel_impl.h.

{return _impl->getVCMap();}

template<class T >

void ElectricModel< T >::init ( )

virtual

Implements Model.

Definition at line 1514 of file ElectricModel_impl.h.

{
  _impl->init();
}

template<class T >

void ElectricModel< T >::printBCs

(

)

Definition at line 1571 of file ElectricModel_impl.h.

{
  _impl->printBCs();
}

template<class T >

void ElectricModel< T >::restart ( )

virtual

Reimplemented from Model.

Definition at line 1627 of file ElectricModel_impl.h.

{
  _impl->restart();
}

template<class T >

void ElectricModel< T >::updateTime

(

)

Definition at line 1540 of file ElectricModel_impl.h.

{
  _impl->updateTime();
}

Member Data Documentation

template<class T>

shared_ptr<Impl> ElectricModel< T >::_impl

private

Definition at line 73 of file ElectricModel.h.

---

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

• ElectricModel.h
• ElectricModel_impl.h