ESyS-Particle  4.0.1
Public Member Functions | Protected Member Functions
TRotSubLattice< T > Class Template Reference

class of a SubLattice of rotational particles More...

#include <RotSubLattice.h>

Inheritance diagram for TRotSubLattice< T >:
Inheritance graph
[legend]
Collaboration diagram for TRotSubLattice< T >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 TRotSubLattice (const esys::lsm::CLatticeParam &prm, int rank, MPI_Comm comm, MPI_Comm worker_comm)
virtual ~TRotSubLattice ()
virtual void setParticleAngularVelocity ()
virtual void addRotBondedIG ()
virtual void addRotThermBondedIG ()

Protected Member Functions

virtual bool doAddPIG (const string &, const string &, CVarMPIBuffer &)
virtual bool doAddDamping (const string &, CVarMPIBuffer &)

Detailed Description

template<typename T>
class TRotSubLattice< T >

class of a SubLattice of rotational particles

Author:
Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

template<class T >
TRotSubLattice< T >::TRotSubLattice ( const esys::lsm::CLatticeParam prm,
int  rank,
MPI_Comm  comm,
MPI_Comm  worker_comm 
)

Construct RotSubLattice. Calls constructor of base class.

Parameters:
paramLattice parameters
rankthe MPI rank
commthe MPI communicator
template<class T >
TRotSubLattice< T >::~TRotSubLattice ( ) [virtual]

Destructor


Member Function Documentation

template<class T >
void TRotSubLattice< T >::addRotBondedIG ( ) [virtual]

Add bonded interaction group to the lattice. Receive the parameters from master. The bonds are created from the neighbor table.

Reimplemented from TSubLattice< T >.

References CVarMPIBuffer::pop_double(), CVarMPIBuffer::pop_int(), CVarMPIBuffer::pop_string(), CVarMPIBuffer::receiveBroadcast(), and BasicCon::XDebug().

Here is the call graph for this function:

template<class T >
void TRotSubLattice< T >::addRotThermBondedIG ( ) [virtual]

Add thermal bonded interaction group to the lattice. Receive the parameters from master. The bonds are created from the neighbor table.

Reimplemented from TSubLattice< T >.

References CVarMPIBuffer::pop_double(), CVarMPIBuffer::pop_int(), CVarMPIBuffer::pop_string(), CVarMPIBuffer::receiveBroadcast(), and BasicCon::XDebug().

Here is the call graph for this function:

template<class T >
bool TRotSubLattice< T >::doAddDamping ( const string &  type,
CVarMPIBuffer param_buffer 
) [protected, virtual]

Do the work for adding the damping

Parameters:
typethe type of damping
param_bufferthe buffer containing the parameters

Reimplemented from TSubLattice< T >.

References BasicCon::Debug(), and TSubLattice< T >::doAddDamping().

Here is the call graph for this function:

template<class T >
bool TRotSubLattice< T >::doAddPIG ( const string &  name,
const string &  type,
CVarMPIBuffer param_buffer 
) [protected, virtual]

do the actual work adding the pair interaction group (PIG)

Parameters:
namethe name of the PIG
typethe type of the PIG
param_bufferthe buffer containing the rest of the parameters

References TSubLattice< T >::doAddPIG().

Here is the call graph for this function:

template<class T >
void TRotSubLattice< T >::setParticleAngularVelocity ( ) [virtual]

Set the angular velocity of a particle. Parameters are received from master.

Reimplemented from ASubLattice.

References BasicCon::Debug(), CVarMPIBuffer::pop_int(), CVarMPIBuffer::receiveBroadcast(), and BasicCon::XDebug().

Here is the call graph for this function:


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