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

Interaction group parameters for Linear Dashpot interactions. More...

#include <LinearDashpotInteraction.h>

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

Public Member Functions

 CLinearDashpotIGP ()
 default constructor More...
 
 CLinearDashpotIGP (const std::string &, double, double)
 
virtual std::string getTypeString () const
 
- Public Member Functions inherited from AIGParam
 AIGParam (const std::string &name="")
 
virtual ~AIGParam ()
 
virtual void packInto (CVarMPIBuffer *) const
 
void setName (const std::string &name)
 
const std::string & getName () const
 
const std::string & Name () const
 

Public Attributes

double m_damp
 
double m_cutoff
 

Detailed Description

Interaction group parameters for Linear Dashpot interactions.

Constructor & Destructor Documentation

◆ CLinearDashpotIGP() [1/2]

CLinearDashpotIGP::CLinearDashpotIGP ( )

default constructor

◆ CLinearDashpotIGP() [2/2]

CLinearDashpotIGP::CLinearDashpotIGP ( const std::string &  name,
double  damp,
double  cutoff 
)

constructor with parameters

Parameters
namethe name of the interaction group
dampthe damping coefficient
cutoffthe interaction range, relative to the sum of the particle radii

Member Function Documentation

◆ getTypeString()

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

Implements AIGParam.

Referenced by esys::lsm::LsmMpiPy::createLinearDashpotIG(), and esys::lsm::LsmMpiPy::createLinearDashpotInteractGrpTag().

Here is the caller graph for this function:

Member Data Documentation

◆ m_cutoff

double CLinearDashpotIGP::m_cutoff

Referenced by CLatticeMaster::addPairIG(), CLatticeMaster::addTaggedPairIG(), CLinearDashpotInteraction::CLinearDashpotInteraction(), and TSubLattice< T >::doAddPIG().

◆ m_damp

double CLinearDashpotIGP::m_damp

Referenced by CLatticeMaster::addPairIG(), CLatticeMaster::addTaggedPairIG(), CLinearDashpotInteraction::CLinearDashpotInteraction(), and TSubLattice< T >::doAddPIG().

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