ESyS-Particle  2.3.2
CWall Class Reference

base class for all walls More...

#include <Wall.h>

Collaboration diagram for CWall:

Public Types

typedef Vec3(CWall::* VectorFieldFunction )() const

Public Member Functions

 CWall ()
 CWall (const Vec3 &, const Vec3 &)
virtual ~CWall ()
void moveBy (const Vec3 &v)
void moveTo (const Vec3 &v)
void setNormal (const Vec3 &v)
void setVel (const Vec3 &v)
Vec3 getVel ()
const Vec3getOrigin () const
const Vec3getNormal () const
void addForce (const Vec3 &force)
void zeroForce ()
const Vec3getForce ()
const Vec3getPos ()
Vec3 getPos () const
Vec3 getForce () const
double getDisplacement ()
Vec3 getTotalDisplacement ()
void resetDisplacement ()
VectorWallFieldSlave< CWall > * generateVectorFieldSlave (TML_Comm *, const string &)
int getFieldSummationFlag (const string &)
virtual void writeCheckPoint (ostream &, const string &) const
virtual void loadCheckPoint (istream &)

Static Public Member Functions

static VectorFieldFunction getVectorFieldFunction (const string &)

Protected Attributes

Vec3 m_origin
Vec3 m_normal
Vec3 m_force
Vec3 m_oldpos
Vec3 m_vel

Friends

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

Detailed Description

base class for all walls

Author
Steffen Abe $Revision$ $Date$

Member Typedef Documentation

typedef Vec3(CWall::* CWall::VectorFieldFunction)() const

Constructor & Destructor Documentation

CWall::CWall ( )

Default constructor. Zeroes all variables. Does not construct a useable wall (normal=(0,0,0)) !

References m_force, m_normal, m_oldpos, m_origin, m_vel, and Vec3::ZERO.

CWall::CWall ( const Vec3 o,
const Vec3 n 
)

constructor

Parameters
othe orgin/position of the wall
nthe wall normal

References m_force, m_normal, m_oldpos, m_origin, m_vel, and Vec3::ZERO.

virtual CWall::~CWall ( )
inlinevirtual

Member Function Documentation

void CWall::addForce ( const Vec3 force)
inline

References m_force.

VectorWallFieldSlave< CWall > * CWall::generateVectorFieldSlave ( TML_Comm comm,
const string &  name 
)

generate new vector field slave

Parameters
comm
name

References AWallFieldSlave::addWall(), getVectorFieldFunction(), and NULL.

Here is the call graph for this function:

double CWall::getDisplacement ( )
inline

References m_oldpos, and m_origin.

Referenced by AWallInteractionGroup< T >::getDisplacement().

Here is the caller graph for this function:

int CWall::getFieldSummationFlag ( const string &  fieldname)

Get a flag how the field with a given name is to be treated when received by the master, i.e. summed over all nodes (Force...) or not (Position...)

Parameters
fieldnamethe name of the field
Returns
1 if the field is to be summed, 0 if not and -1 if the name is invalid

References console, and Console::Error().

Here is the call graph for this function:

const Vec3& CWall::getForce ( )
inline

References m_force.

Referenced by getVectorFieldFunction().

Here is the caller graph for this function:

Vec3 CWall::getForce ( ) const
inline

References m_force.

const Vec3& CWall::getNormal ( ) const
inline

References m_normal.

const Vec3& CWall::getOrigin ( ) const
inline

References m_origin.

const Vec3& CWall::getPos ( )
inline

References m_origin.

Referenced by getVectorFieldFunction().

Here is the caller graph for this function:

Vec3 CWall::getPos ( ) const
inline

References m_origin.

Vec3 CWall::getTotalDisplacement ( )
inline

References m_oldpos, and m_origin.

CWall::VectorFieldFunction CWall::getVectorFieldFunction ( const string &  name)
static

Get the wall member function which returns a vector field of a given name.

Parameters
namethe name of the field

References console, Console::Error(), getForce(), getPos(), and NULL.

Referenced by generateVectorFieldSlave().

Here is the call graph for this function:

Here is the caller graph for this function:

Vec3 CWall::getVel ( )
inline

References m_vel.

void CWall::loadCheckPoint ( istream &  ist)
virtual

load wall data from a restartable checkpoint

Parameters
istthe input stream from which the checkpoint is read

References m_normal, m_oldpos, and m_origin.

Referenced by TSubLattice< T >::loadCheckPointData().

Here is the caller graph for this function:

void CWall::moveBy ( const Vec3 v)
inline

References console, m_oldpos, m_origin, and Console::XDebug().

Referenced by AWallInteractionGroup< T >::moveWallBy().

Here is the call graph for this function:

Here is the caller graph for this function:

void CWall::moveTo ( const Vec3 v)
inline

References m_origin.

void CWall::resetDisplacement ( )
inline

References m_oldpos, and m_origin.

Referenced by AWallInteractionGroup< T >::resetDisplacement().

Here is the caller graph for this function:

void CWall::setNormal ( const Vec3 v)
inline

References m_normal.

Referenced by AWallInteractionGroup< T >::setWallNormal().

Here is the caller graph for this function:

void CWall::setVel ( const Vec3 v)
inline

References m_vel.

void CWall::writeCheckPoint ( ostream &  ost,
const string &  delim 
) const
virtual

write restartable checkpoint data to an output stream

Parameters
ostthe output stream
delim

References m_normal, m_oldpos, and m_origin.

void CWall::zeroForce ( )
inline

References m_force.

Referenced by AWallInteractionGroup< T >::zeroForce().

Here is the caller graph for this function:

Friends And Related Function Documentation

ostream& operator<< ( ostream &  ost,
const CWall w 
)
friend

Member Data Documentation

Vec3 CWall::m_force
protected

Referenced by addForce(), CWall(), getForce(), and zeroForce().

Vec3 CWall::m_normal
protected
Vec3 CWall::m_vel
protected

Referenced by CWall(), getVel(), and setVel().


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