olb::particles::couple_lattice_to_particles_single_cuboid< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR > Struct Template Reference

Couple lattice to particles. More...

#include <particleTasks.h>

Collaboration diagram for olb::particles::couple_lattice_to_particles_single_cuboid< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >:

Static Public Member Functions
static auto	execute (ParticleSystem< T, PARTICLETYPE > &particleSystem, SuperGeometry< T, DESCRIPTOR::d > &sGeometry, SuperLattice< T, DESCRIPTOR > &sLattice, UnitConverter< T, DESCRIPTOR > const &converter, Vector< bool, DESCRIPTOR::d > periodicity=Vector< bool, DESCRIPTOR::d >(false), std::size_t iP0=0)

Static Public Attributes
static constexpr bool	latticeCoupling = true
static constexpr bool	particleLoop = false

Detailed Description

template<typename T, typename DESCRIPTOR, typename PARTICLETYPE, typename FORCEFUNCTOR = SuperLatticeMomentumExchangeForce<T, DESCRIPTOR, PARTICLETYPE>>
struct olb::particles::couple_lattice_to_particles_single_cuboid< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >

Couple lattice to particles.

Definition at line 43 of file particleTasks.h.

Member Function Documentation

execute()

template<typename T , typename DESCRIPTOR , typename PARTICLETYPE , typename FORCEFUNCTOR = SuperLatticeMomentumExchangeForce<T, DESCRIPTOR, PARTICLETYPE>>

static auto olb::particles::couple_lattice_to_particles_single_cuboid< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >::execute ( ParticleSystem< T, PARTICLETYPE > & particleSystem, SuperGeometry< T, DESCRIPTOR::d > & sGeometry, SuperLattice< T, DESCRIPTOR > & sLattice, UnitConverter< T, DESCRIPTOR > const & converter, Vector< bool, DESCRIPTOR::d > periodicity = Vector<bool,DESCRIPTOR::d>(false), std::size_t iP0 = 0 )

inlinestatic

Definition at line 44 of file particleTasks.h.

  {
    //Momentum Exchange/Loss
    FORCEFUNCTOR forceFunctor( sLattice, sGeometry,
                               particleSystem, converter, periodicity, iP0 );
    //Store boundary force in particles
    dynamics::applySerializableParticleForce( forceFunctor, particleSystem, iP0 );
  }

References olb::particles::dynamics::applySerializableParticleForce().

Here is the call graph for this function:

Member Data Documentation

latticeCoupling

template<typename T , typename DESCRIPTOR , typename PARTICLETYPE , typename FORCEFUNCTOR = SuperLatticeMomentumExchangeForce<T, DESCRIPTOR, PARTICLETYPE>>

constexpr bool olb::particles::couple_lattice_to_particles_single_cuboid< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >::latticeCoupling = true

staticconstexpr

Definition at line 59 of file particleTasks.h.

particleLoop

template<typename T , typename DESCRIPTOR , typename PARTICLETYPE , typename FORCEFUNCTOR = SuperLatticeMomentumExchangeForce<T, DESCRIPTOR, PARTICLETYPE>>

constexpr bool olb::particles::couple_lattice_to_particles_single_cuboid< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >::particleLoop = false

staticconstexpr

Definition at line 60 of file particleTasks.h.

---

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

• src/particles/functions/particleTasks.h