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

Couple lattice to parallel particles. More...

#include <particleTasks.h>

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

Static Public Member Functions
static auto	execute (SuperParticleSystem< T, PARTICLETYPE > &sParticleSystem, const 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 = BlockLatticeMomentumExchangeForce<T,DESCRIPTOR,PARTICLETYPE>>
struct olb::particles::couple_lattice_to_parallel_particles< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >

Couple lattice to parallel particles.

• Resolved default: MomentumExchange, serialized
• Subgrid default: StokesDrag, non-serialized

Definition at line 164 of file particleTasks.h.

Member Function Documentation

execute()

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

static auto olb::particles::couple_lattice_to_parallel_particles< T, DESCRIPTOR, PARTICLETYPE, FORCEFUNCTOR >::execute ( SuperParticleSystem< T, PARTICLETYPE > & sParticleSystem, const 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 165 of file particleTasks.h.

  {
    constexpr unsigned D = DESCRIPTOR::d;
    const PhysR<T,D> min = communication::getCuboidMin<T,D>(sGeometry.getCuboidGeometry());
    const PhysR<T,D> max = communication::getCuboidMax<T,D>(sGeometry.getCuboidGeometry(), min);
 
    //Test output
    communication::forSystemsInSuperParticleSystem( sParticleSystem,
    [&](ParticleSystem<T,PARTICLETYPE>& particleSystem, int iC, int globiC){
 
      auto& blockLattice = sLattice.getBlock(iC);
      auto& blockGeometry = sGeometry.getBlockGeometry(iC);
 
      //Momentum Exchange/Loss
      FORCEFUNCTOR forceFunctor( blockLattice, blockGeometry,
                                 particleSystem, converter, min, max, periodicity, iP0 );
 
      //Store boundary force in particles
      // - if not serialized, allows for additional filtering (e.g. active_particles)
      if constexpr (FORCEFUNCTOR::serializeForce){
        dynamics::applySerializableParticleForce( forceFunctor, particleSystem, iP0 );
      } else {
        using PCONDITION = conditions::active_particles; //TODO: remove hardcoded active_particle limitation
        dynamics::applyLocalParticleForce<T,PARTICLETYPE,FORCEFUNCTOR,PCONDITION>(
          forceFunctor, particleSystem, iP0 );
      }
    });
  }

References olb::particles::dynamics::applySerializableParticleForce(), olb::particles::communication::forSystemsInSuperParticleSystem(), olb::SuperLattice< T, DESCRIPTOR >::getBlock(), olb::SuperGeometry< T, D >::getBlockGeometry(), and olb::SuperStructure< T, D >::getCuboidGeometry().

Here is the call graph for this function:

Member Data Documentation

latticeCoupling

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

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

staticconstexpr

Definition at line 200 of file particleTasks.h.

particleLoop

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

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

staticconstexpr

Definition at line 201 of file particleTasks.h.

---

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

• src/particles/functions/particleTasks.h