ESyS-Particle  2.3.4
Public Member Functions | Public Attributes | Friends | List of all members
CRotElasticIGP Class Reference

Interaction group parameters for CRotElasticInteractionGroups. More...

#include <RotElasticInteraction.h>

Inheritance diagram for CRotElasticIGP:
Inheritance graph
[legend]
Collaboration diagram for CRotElasticIGP:
Collaboration graph
[legend]

Public Member Functions

 CRotElasticIGP ()
 
 CRotElasticIGP (const std::string &name, double kr, bool scaling)
 
virtual void packInto (CVarMPIBuffer *) const
 
void setNormalSpringConst (double k)
 
double getNormalSpringConst () 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
 

Public Attributes

double m_kr
 
bool m_scaling
 

Friends

ostream & operator<< (ostream &, const CRotElasticIGP &)
 

Detailed Description

Interaction group parameters for CRotElasticInteractionGroups.

Constructor & Destructor Documentation

◆ CRotElasticIGP() [1/2]

CRotElasticIGP::CRotElasticIGP ( )

◆ CRotElasticIGP() [2/2]

CRotElasticIGP::CRotElasticIGP ( const std::string &  name,
double  kr,
bool  scaling 
)

Member Function Documentation

◆ getNormalSpringConst()

double CRotElasticIGP::getNormalSpringConst ( ) const
inline

References m_kr.

Referenced by CRotElasticInteractionGroup< T >::CRotElasticInteractionGroup(), and CRotElasticInteractionGroup< T >::setParam().

Here is the caller graph for this function:

◆ getTypeString()

virtual std::string CRotElasticIGP::getTypeString ( ) const
inlinevirtual

Implements AIGParam.

Referenced by esys::lsm::LsmMpiPy::createRotElasticInteractGrp(), and esys::lsm::LsmMpiPy::createRotElasticInteractGrpTag().

Here is the caller graph for this function:

◆ packInto()

void CRotElasticIGP::packInto ( CVarMPIBuffer *  B) const
virtual

Reimplemented from AIGParam.

References CVarMPIBuffer::append(), m_kr, and AIGParam::packInto().

Here is the call graph for this function:

◆ setNormalSpringConst()

void CRotElasticIGP::setNormalSpringConst ( double  k)
inline

References m_kr.

Referenced by extractRotElasticIGP(), and extractRotElasticIGP_p().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

ostream& operator<< ( ostream &  ost,
const CRotElasticIGP &  B 
)
friend

Member Data Documentation

◆ m_kr

double CRotElasticIGP::m_kr

Referenced by CLatticeMaster::addPairIG(), CLatticeMaster::addTaggedPairIG(), CRotElasticInteraction::CRotElasticInteraction(), TSubLattice< T >::doAddPIG(), getNormalSpringConst(), operator<<(), packInto(), and setNormalSpringConst().

◆ m_scaling

bool CRotElasticIGP::m_scaling

Referenced by CLatticeMaster::addPairIG(), CLatticeMaster::addTaggedPairIG(), and CRotElasticInteraction::CRotElasticInteraction().

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