ESyS-Particle  2.3
CViscWallIG< T > Class Template Reference

Class for a group of viscous and elastic interactions between particles and a wall. More...

#include <ViscWallIG.h>

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

Public Member Functions

 CViscWallIG (TML_Comm *)
 
 CViscWallIG (TML_Comm *, CWall *, const CVWallIGP *)
 
virtual ~CViscWallIG ()
 
virtual void setTimeStepSize (double dt)
 
virtual void calcForces ()
 
virtual void applyForce (const Vec3 &)
 
virtual void setVelocity (const Vec3 &)
 
virtual void Update (ParallelParticleArray< T > *)
 
- Public Member Functions inherited from AWallInteractionGroup< T >
 AWallInteractionGroup (TML_Comm *comm)
 
virtual ~AWallInteractionGroup ()
 
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 ()
 

Protected Attributes

vector< CViscWallInteraction< T > > m_visc_interactions
 visc interactions for tagged particles More...
 
vector
< CElasticWallInteraction< T > > 
m_elastic_interactions
 elastic interactions all particles More...
 
double m_k
 spring constant More...
 
double m_nu
 
int m_tag
 
- Protected Attributes inherited from AWallInteractionGroup< T >
CWallm_wall
 the wall More...
 
TML_Commm_comm
 MPI communicator. More...
 
int m_inner_count
 

Friends

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

Detailed Description

template<class T>
class CViscWallIG< T >

Class for a group of viscous and elastic interactions between particles and a wall.

Constructor & Destructor Documentation

template<class T >
CViscWallIG< T >::CViscWallIG ( TML_Comm comm)
template<class T >
CViscWallIG< T >::CViscWallIG ( TML_Comm comm,
CWall wallp,
const CVWallIGP I 
)

Constructor for wall interaction group with viscous drag

Parameters
commthe communicator
wallpa pointer to the wall
paramthe interaction parameters

References console, CVWallIGP::getNu(), CElasticIGP::getSpringConst(), CVWallIGP::getTag(), AWallInteractionGroup< T >::m_inner_count, CViscWallIG< T >::m_k, CViscWallIG< T >::m_nu, CViscWallIG< T >::m_tag, AWallInteractionGroup< T >::m_wall, and BasicCon::XDebug().

Here is the call graph for this function:

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

Member Function Documentation

template<class T >
void CViscWallIG< T >::applyForce ( const Vec3 F)
virtual

Apply a given force to the wall. Only forces in the direction of the given force are considered, free movement is assumed in perpendicular directions.

Parameters
Fthe force

Reimplemented from AWallInteractionGroup< T >.

References esys::lsm::bpu::iter(), Vec3::unit(), Vec3::X(), Vec3::Y(), and Vec3::Z().

Here is the call graph for this function:

template<class T >
void CViscWallIG< T >::calcForces ( )
virtual

Implements AWallInteractionGroup< T >.

References console, and BasicCon::XDebug().

Here is the call graph for this function:

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

Null op, don't require time step size.

Reimplemented from AWallInteractionGroup< T >.

template<class T >
void CViscWallIG< T >::setVelocity ( const Vec3 V)
virtual

Set velocity of the wall. Only sets m_vel of the wall, doesn't affect position updates.

Parameters
Vthe velocity

Reimplemented from AWallInteractionGroup< T >.

template<class T >
void CViscWallIG< T >::Update ( ParallelParticleArray< T > *  PPA)
virtual

Update interactions from an existing parallel particle array

Parameters
PPAa pointer to the particle array

Implements AInteractionGroup< T >.

References console, ParallelParticleArray< T >::getParticlesAtPlane(), ParallelParticleArray< T >::isInInner(), esys::lsm::bpu::iter(), and BasicCon::XDebug().

Here is the call graph for this function:

Friends And Related Function Documentation

template<class T>
ostream& operator<< ( ostream &  ost,
const CViscWallIG< T > &  IG 
)
friend

Member Data Documentation

template<class T>
vector<CElasticWallInteraction<T> > CViscWallIG< T >::m_elastic_interactions
protected

elastic interactions all particles

template<class T>
double CViscWallIG< T >::m_k
protected

spring constant

Referenced by CViscWallIG< T >::CViscWallIG().

template<class T>
double CViscWallIG< T >::m_nu
protected
template<class T>
int CViscWallIG< T >::m_tag
protected
template<class T>
vector<CViscWallInteraction<T> > CViscWallIG< T >::m_visc_interactions
protected

visc interactions for tagged particles


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