CDampingIGP Class Reference

Interaction group parameters for CDampingGroup. More...

#include <DampingIGP.h>

Inheritance diagram for CDampingIGP:

Collaboration diagram for CDampingIGP:

Public Member Functions
	CDampingIGP ()
	CDampingIGP (const string &type, const string &name, double viscosity, double dt, int maxIteractions, const Vec3 &refVelocity=Vec3::ZERO)
virtual void	packInto (CVarMPIBuffer *) const
void	setType (const string &type)
void	setVRef (const Vec3 V)
Vec3	getVRef () const
void	setVisc (double v)
double	getVisc () const
void	setTimeStep (double t)
void	setTimeStepSize (double t)
double	getTimeStep () const
void	setMaxIter (int mi)
int	getMaxIter () const
virtual std::string	getTypeString () const
Public Member Functions inherited from AIGParam
	AIGParam (const std::string &name="")
virtual	~AIGParam ()
void	setName (const std::string &name)
const std::string &	getName () const
const std::string &	Name () const

Protected Attributes
string	m_type
Vec3	m_vref
	reference velocity More...
double	m_visc
	artificial viscosity More...
double	m_dt
	time step More...
int	m_max_iter
	max nr. of iterations More...

Detailed Description

Interaction group parameters for CDampingGroup.

Constructor & Destructor Documentation

CDampingIGP() [1/2]

CDampingIGP::CDampingIGP

(

)

CDampingIGP() [2/2]

CDampingIGP::CDampingIGP	(	const string &	type,
		const string &	name,
		double	viscosity,
		double	dt,
		int	maxIteractions,
		const Vec3 &	refVelocity = Vec3::ZERO
	)

Member Function Documentation

getMaxIter()

int CDampingIGP::getMaxIter ( ) const

inline

References m_max_iter.

Referenced by CDamping< T >::CDamping(), and CRotDamping< T >::CRotDamping().

Here is the caller graph for this function:

getTimeStep()

double CDampingIGP::getTimeStep ( ) const

inline

References m_dt.

Referenced by CDamping< T >::CDamping(), and CRotDamping< T >::CRotDamping().

Here is the caller graph for this function:

getTypeString()

virtual std::string CDampingIGP::getTypeString ( ) const

inlinevirtual

Implements AIGParam.

References m_type.

Referenced by CLatticeMaster::addDamping().

Here is the caller graph for this function:

getVisc()

double CDampingIGP::getVisc ( ) const

inline

References m_visc.

Referenced by CDamping< T >::CDamping(), and CRotDamping< T >::CRotDamping().

Here is the caller graph for this function:

getVRef()

Vec3 CDampingIGP::getVRef ( ) const

inline

References m_vref.

Referenced by CDamping< T >::CDamping(), and CRotDamping< T >::CRotDamping().

Here is the caller graph for this function:

packInto()

void CDampingIGP::packInto ( CVarMPIBuffer *  B ) const

virtual

Pack the parameters for a DampingGroup into a MPI-buffer

Parameters

B	the buffer

Reimplemented from AIGParam.

Reimplemented in ABCDampingIGP.

References CVarMPIBuffer::append(), m_dt, m_max_iter, m_type, m_visc, m_vref, and AIGParam::packInto().

Referenced by ABCDampingIGP::packInto().

Here is the call graph for this function:

Here is the caller graph for this function:

setMaxIter()

void CDampingIGP::setMaxIter ( int  mi )

inline

References m_max_iter.

Referenced by extractABCDampingIGP(), and extractDampingIGP().

Here is the caller graph for this function:

setTimeStep()

void CDampingIGP::setTimeStep ( double  t )

inline

References m_dt.

Referenced by extractABCDampingIGP(), extractDampingIGP(), and setTimeStepSize().

Here is the caller graph for this function:

setTimeStepSize()

void CDampingIGP::setTimeStepSize ( double  t )

inline

References setTimeStep().

Referenced by esys::lsm::LsmMpiPy::createABCDamping(), and esys::lsm::LsmMpiPy::createDamping().

Here is the call graph for this function:

Here is the caller graph for this function:

setType()

void CDampingIGP::setType ( const string &  type )

inline

References m_type.

Referenced by extractABCDampingIGP(), and extractDampingIGP().

Here is the caller graph for this function:

setVisc()

void CDampingIGP::setVisc ( double  v )

inline

References m_visc.

Referenced by extractABCDampingIGP(), and extractDampingIGP().

Here is the caller graph for this function:

setVRef()

void CDampingIGP::setVRef ( const Vec3  V )

inline

References m_vref.

Referenced by extractABCDampingIGP(), and extractDampingIGP().

Here is the caller graph for this function:

Member Data Documentation

m_dt

double CDampingIGP::m_dt

protected

time step

Referenced by getTimeStep(), packInto(), and setTimeStep().

m_max_iter

int CDampingIGP::m_max_iter

protected

max nr. of iterations

Referenced by getMaxIter(), packInto(), and setMaxIter().

m_type

string CDampingIGP::m_type

protected

Referenced by getTypeString(), packInto(), and setType().

m_visc

double CDampingIGP::m_visc

protected

artificial viscosity

Referenced by getVisc(), packInto(), and setVisc().

m_vref

Vec3 CDampingIGP::m_vref

protected

reference velocity

Referenced by getVRef(), packInto(), and setVRef().

---

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

• Model/DampingIGP.h
• Model/DampingIGP.cpp