ESyS-Particle  2.3.4
AWallInteractionGroup< T > Class Template Referenceabstract

Abstract Base class for a group of interactions between particles and a wall. More...

#include <WallIG.h>

Inheritance diagram for AWallInteractionGroup< T >:
Collaboration diagram for AWallInteractionGroup< T >:

Public Member Functions

 AWallInteractionGroup (TML_Comm *comm)
 
virtual ~AWallInteractionGroup ()
 
virtual void setTimeStepSize (double dt)
 
virtual void calcForces ()=0
 
virtual void applyForce (const Vec3 &)
 
virtual void setVelocity (const Vec3 &)
 
double getDisplacement ()
 
void resetDisplacement ()
 
void moveWallBy (const Vec3 &mv)
 
void setWallNormal (const Vec3 &wn)
 
void zeroForce ()
 
- Public Member Functions inherited from AInteractionGroup< T >
virtual ~AInteractionGroup ()
 
virtual void Update (ParallelParticleArray< T > *)=0
 

Protected Attributes

CWallm_wall
 the wall More...
 
TML_Commm_comm
 MPI communicator. More...
 
int m_inner_count
 

Detailed Description

template<class T>
class AWallInteractionGroup< T >

Abstract Base class for a group of interactions between particles and a wall.

Constructor & Destructor Documentation

◆ AWallInteractionGroup()

template<class T >
AWallInteractionGroup< T >::AWallInteractionGroup ( TML_Comm comm)
inline

◆ ~AWallInteractionGroup()

template<class T >
virtual AWallInteractionGroup< T >::~AWallInteractionGroup ( )
inlinevirtual

Member Function Documentation

◆ applyForce()

template<class T >
virtual void AWallInteractionGroup< T >::applyForce ( const Vec3 )
inlinevirtual

◆ calcForces()

template<class T >
virtual void AWallInteractionGroup< T >::calcForces ( )
pure virtual

◆ getDisplacement()

template<class T >
double AWallInteractionGroup< T >::getDisplacement ( )
inline

References CWall::getDisplacement(), and AWallInteractionGroup< T >::m_wall.

Here is the call graph for this function:

◆ moveWallBy()

template<class T >
void AWallInteractionGroup< T >::moveWallBy ( const Vec3 mv)
inline

References AWallInteractionGroup< T >::m_wall, and CWall::moveBy().

Here is the call graph for this function:

◆ resetDisplacement()

template<class T >
void AWallInteractionGroup< T >::resetDisplacement ( )
inline

References AWallInteractionGroup< T >::m_wall, and CWall::resetDisplacement().

Here is the call graph for this function:

◆ setTimeStepSize()

template<class T >
virtual void AWallInteractionGroup< T >::setTimeStepSize ( double  dt)
inlinevirtual

Null op, current wall interactions don't require time step size.

Implements AInteractionGroup< T >.

◆ setVelocity()

template<class T >
virtual void AWallInteractionGroup< T >::setVelocity ( const Vec3 )
inlinevirtual

◆ setWallNormal()

template<class T >
void AWallInteractionGroup< T >::setWallNormal ( const Vec3 wn)
inline

References AWallInteractionGroup< T >::m_wall, and CWall::setNormal().

Here is the call graph for this function:

◆ zeroForce()

template<class T >
void AWallInteractionGroup< T >::zeroForce ( )
inline

References AWallInteractionGroup< T >::m_wall, and CWall::zeroForce().

Here is the call graph for this function:

Member Data Documentation

◆ m_comm

template<class T >
TML_Comm* AWallInteractionGroup< T >::m_comm
protected

MPI communicator.

◆ m_inner_count

template<class T >
int AWallInteractionGroup< T >::m_inner_count
protected

◆ m_wall


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