esys::lsm::BuoyancyForceGroup< TmplParticle > Class Template Reference

#include <BodyForceGroup.h>

Inheritance diagram for esys::lsm::BuoyancyForceGroup< TmplParticle >:

Collaboration diagram for esys::lsm::BuoyancyForceGroup< TmplParticle >:

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

Public Member Functions
	BuoyancyForceGroup (const BuoyancyIGP &prms, ParticleArray &particleArray)
	~BuoyancyForceGroup ()
Vec3	getForce (double volume) const
void	applyForce (TmplParticle &particle) const
virtual void	Update (ParallelParticleArray< TmplParticle > *particleArray)
virtual void	setTimeStepSize (double dt)
virtual void	calcForces ()
Public Member Functions inherited from AInteractionGroup< TmplParticle >
virtual	~AInteractionGroup ()

Private Attributes
Vec3	m_acceleration
ParticleArray *	m_pParticleArray
double	m_fluidDensity
double	m_fluidHeight

Member Typedef Documentation

ParticleArray

template<class TmplParticle >

typedef ParallelParticleArray<TmplParticle> esys::lsm::BuoyancyForceGroup< TmplParticle >::ParticleArray

ParticleIterator

template<class TmplParticle >

typedef ParticleArray::ParticleListIterator esys::lsm::BuoyancyForceGroup< TmplParticle >::ParticleIterator

Constructor & Destructor Documentation

BuoyancyForceGroup()

template<class TmplParticle >

esys::lsm::BuoyancyForceGroup< TmplParticle >::BuoyancyForceGroup	(	const BuoyancyIGP &	prms,
		ParticleArray &	particleArray
	)

~BuoyancyForceGroup()

template<class TmplParticle >

esys::lsm::BuoyancyForceGroup< TmplParticle >::~BuoyancyForceGroup

Member Function Documentation

applyForce()

template<class TmplParticle >

void esys::lsm::BuoyancyForceGroup< TmplParticle >::applyForce

(

TmplParticle &

particle

)

const

Applies body force to the specified particle.

Parameters

particle

Force applied to this particle using a call to particle.applyForce(...).

calcForces()

template<class TmplParticle >

void esys::lsm::BuoyancyForceGroup< TmplParticle >::calcForces

virtual

Implements AInteractionGroup< TmplParticle >.

getForce()

template<class TmplParticle >

Vec3 esys::lsm::BuoyancyForceGroup< TmplParticle >::getForce

(

double

volume

)

const

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

Parameters

mass	A mass ("units" assumed to be same as the acceleration units).

setTimeStepSize()

template<class TmplParticle >

virtual void esys::lsm::BuoyancyForceGroup< TmplParticle >::setTimeStepSize ( double  dt )

inlinevirtual

Null op, time step size not required.

Implements AInteractionGroup< TmplParticle >.

Update()

template<class TmplParticle >

void esys::lsm::BuoyancyForceGroup< TmplParticle >::Update ( ParallelParticleArray< TmplParticle > *  particleArray )

virtual

Implements AInteractionGroup< TmplParticle >.

Member Data Documentation

m_acceleration

template<class TmplParticle >

Vec3 esys::lsm::BuoyancyForceGroup< TmplParticle >::m_acceleration

private

m_fluidDensity

template<class TmplParticle >

double esys::lsm::BuoyancyForceGroup< TmplParticle >::m_fluidDensity

private

m_fluidHeight

template<class TmplParticle >

double esys::lsm::BuoyancyForceGroup< TmplParticle >::m_fluidHeight

private

m_pParticleArray

template<class TmplParticle >

ParticleArray* esys::lsm::BuoyancyForceGroup< TmplParticle >::m_pParticleArray

private

---

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

• Model/BodyForceGroup.h
• Model/BodyForceGroup.hpp