ESyS-Particle  4.0.1
Public Types | Public Member Functions | List of all members
esys::lsm::BodyForceGroup< TmplParticle > Class Template Reference

#include <BodyForceGroup.h>

Inheritance diagram for esys::lsm::BodyForceGroup< TmplParticle >:
Inheritance graph
[legend]
Collaboration diagram for esys::lsm::BodyForceGroup< TmplParticle >:
Collaboration graph
[legend]

Public Types

typedef ParallelParticleArray
< TmplParticle > 
ParticleArray
typedef
ParticleArray::ParticleListIterator 
ParticleIterator

Public Member Functions

 BodyForceGroup (const BodyForceIGP &prms, ParticleArray &particleArray)
Vec3 getForce (double mass) const
void applyForce (TmplParticle &particle) const
virtual void Update (ParallelParticleArray< TmplParticle > *particleArray)
virtual void setTimeStepSize (double dt)
virtual void calcForces ()

Detailed Description

template<class TmplParticle>
class esys::lsm::BodyForceGroup< TmplParticle >

Objects of this class apply a gravitational body-acceleration to individual particles.

Member Function Documentation

template<class TmplParticle >
void esys::lsm::BodyForceGroup< TmplParticle >::applyForce ( TmplParticle &  particle) const

Applies body force to the specified particle.

Parameters
particleForce applied to this particle using a call to particle.applyForce(...).
template<class TmplParticle >
Vec3 esys::lsm::BodyForceGroup< TmplParticle >::getForce ( double  mass) const

Returns the force which would be applied to a particle of the specified mass.

Parameters
massA mass ("units" assumed to be same as the acceleration units).
template<class TmplParticle>
virtual void esys::lsm::BodyForceGroup< TmplParticle >::setTimeStepSize ( double  dt)
inlinevirtual

Null op, time step size not required.

Implements AInteractionGroup< TmplParticle >.


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