OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE > Struct Template Referenceabstract

Basic particle dynamics. More...

#include <particleDynamicsBase.h>

+ Inheritance diagram for olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >:
+ Collaboration diagram for olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >:

Public Member Functions

virtual ~ParticleDynamics ()
 Destructor: virtual to enable inheritance.
 
virtual void process (Particle< T, PARTICLETYPE > &particle, T timeStepSize)=0
 Implementation of the processing step.
 
std::string & getName ()
 read and write access to name
 
std::string const & getName () const
 read only access to name
 

Detailed Description

template<typename T, typename PARTICLETYPE>
struct olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >

Basic particle dynamics.

Definition at line 36 of file particleDynamicsBase.h.

Constructor & Destructor Documentation

◆ ~ParticleDynamics()

template<typename T , typename PARTICLETYPE >
virtual olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >::~ParticleDynamics ( )
inlinevirtual

Destructor: virtual to enable inheritance.

Definition at line 38 of file particleDynamicsBase.h.

38{ }

Member Function Documentation

◆ getName() [1/2]

template<typename T , typename PARTICLETYPE >
std::string & olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >::getName ( )

read and write access to name

Definition at line 35 of file particleDynamicsBase.hh.

36{
37 return _name;
38}
+ Here is the caller graph for this function:

◆ getName() [2/2]

template<typename T , typename PARTICLETYPE >
std::string const & olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >::getName ( ) const

read only access to name

Definition at line 41 of file particleDynamicsBase.hh.

42{
43 return _name;
44}

◆ process()

template<typename T , typename PARTICLETYPE >
virtual void olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >::process ( Particle< T, PARTICLETYPE > & particle,
T timeStepSize )
pure virtual

Implementation of the processing step.

Implemented in olb::particles::dynamics::NoParticleDynamics< T, PARTICLETYPE >, olb::particles::dynamics::VerletParticleDynamics< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamics< T, PARTICLETYPE, conditions::active_particles >, olb::particles::dynamics::VerletParticleDynamicsTranslationOnly< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsRotationOnly< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsRotor< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsVelocityWallReflection< T, PARTICLETYPE, useCubicBounds, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsWallCapture< T, PARTICLETYPE, useCubicBounds, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsMaterialCapture< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsMaterialAwareWallCapture< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsEscape< T, PARTICLETYPE, useCubicBounds, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsMaterialEscape< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsMaterialAwareEscape< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsMaterialCaptureAndEscape< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::VerletParticleDynamicsMaterialAwareWallCaptureAndEscape< T, PARTICLETYPE, PCONDITION >, olb::particles::dynamics::ParticleDetachmentDynamics< T, PARTICLETYPE >, olb::particles::dynamics::VerletParticleDynamicsCubicBoundsAdhesion< T, PARTICLETYPE >, and olb::particles::dynamics::VerletParticleDynamicsCubicBoundsDeposition< T, PARTICLETYPE, DEPOSITION_MODEL >.

+ Here is the caller graph for this function:

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