CLocalDampingIGP Class Reference

Interaction group parameters for CLocalDampingGroup. More...

#include <LocalDampingIGP.h>

Inheritance diagram for CLocalDampingIGP:

Collaboration diagram for CLocalDampingIGP:

Public Member Functions
	CLocalDampingIGP ()
	CLocalDampingIGP (const string &type, const string &name, double viscosity, double dt)
virtual void	packInto (CVarMPIBuffer *) const
void	setType (const string &type)
void	setVisc (double v)
double	getVisc () const
void	setTimeStep (double t)
void	setTimeStepSize (double t)
double	getTimeStep () 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
double	m_visc
	damping coefficient More...
double	m_dt
	time step More...

Detailed Description

Interaction group parameters for CLocalDampingGroup.

Constructor & Destructor Documentation

CLocalDampingIGP() [1/2]

CLocalDampingIGP::CLocalDampingIGP

(

)

CLocalDampingIGP() [2/2]

CLocalDampingIGP::CLocalDampingIGP	(	const string &	type,
		const string &	name,
		double	viscosity,
		double	dt
	)

Member Function Documentation

getTimeStep()

double CLocalDampingIGP::getTimeStep ( ) const

inline

References m_dt.

Referenced by CLocalDamping< T >::CLocalDamping(), and CRotLocalDamping< T >::CRotLocalDamping().

Here is the caller graph for this function:

getTypeString()

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

inlinevirtual

Implements AIGParam.

References m_type.

Referenced by CLatticeMaster::addDamping().

Here is the caller graph for this function:

getVisc()

double CLocalDampingIGP::getVisc ( ) const

inline

References m_visc.

Referenced by CLocalDamping< T >::CLocalDamping(), and CRotLocalDamping< T >::CRotLocalDamping().

Here is the caller graph for this function:

packInto()

void CLocalDampingIGP::packInto ( CVarMPIBuffer *  B ) const

virtual

Pack the parameters for a LocalDampingGroup into a MPI-buffer

Parameters

B	the buffer

Reimplemented from AIGParam.

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

Here is the call graph for this function:

setTimeStep()

void CLocalDampingIGP::setTimeStep ( double  t )

inline

References m_dt.

Referenced by extractLocalDampingIGP(), and setTimeStepSize().

Here is the caller graph for this function:

setTimeStepSize()

void CLocalDampingIGP::setTimeStepSize ( double  t )

inline

References setTimeStep().

Referenced by esys::lsm::LsmMpiPy::createLocalDamping(), and esys::lsm::LsmMpiPy::createRotLocalDamping().

Here is the call graph for this function:

Here is the caller graph for this function:

setType()

void CLocalDampingIGP::setType ( const string &  type )

inline

References m_type.

Referenced by extractLocalDampingIGP().

Here is the caller graph for this function:

setVisc()

void CLocalDampingIGP::setVisc ( double  v )

inline

References m_visc.

Referenced by extractLocalDampingIGP().

Here is the caller graph for this function:

Member Data Documentation

m_dt

double CLocalDampingIGP::m_dt

protected

time step

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

m_type

string CLocalDampingIGP::m_type

protected

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

m_visc

double CLocalDampingIGP::m_visc

protected

damping coefficient

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

---

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

• Model/LocalDampingIGP.h
• Model/LocalDampingIGP.cpp