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

Couple particles to lattice. More...

#include <particleTasks.h>

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

Static Public Member Functions
static auto	execute (SuperParticleSystem< T, PARTICLETYPE > &sParticleSystem, Particle< T, PARTICLETYPE > &particle, const SuperGeometry< T, DESCRIPTOR::d > &sGeometry, SuperLattice< T, DESCRIPTOR > &sLattice, UnitConverter< T, DESCRIPTOR > const &converter, int globiC, Vector< bool, DESCRIPTOR::d > periodicity=Vector< bool, DESCRIPTOR::d >(false))

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

Detailed Description

template<typename T, typename DESCRIPTOR, typename PARTICLETYPE>
struct olb::particles::couple_parallel_particles_to_lattice< T, DESCRIPTOR, PARTICLETYPE >

Couple particles to lattice.

Definition at line 262 of file particleTasks.h.

Member Function Documentation

execute()

template<typename T , typename DESCRIPTOR , typename PARTICLETYPE >

static auto olb::particles::couple_parallel_particles_to_lattice< T, DESCRIPTOR, PARTICLETYPE >::execute ( SuperParticleSystem< T, PARTICLETYPE > & sParticleSystem, Particle< T, PARTICLETYPE > & particle, const SuperGeometry< T, DESCRIPTOR::d > & sGeometry, SuperLattice< T, DESCRIPTOR > & sLattice, UnitConverter< T, DESCRIPTOR > const & converter, int globiC, Vector< bool, DESCRIPTOR::d > periodicity = Vector<bool,DESCRIPTOR::d>(false) )

inlinestatic

Definition at line 263 of file particleTasks.h.

  {
    constexpr unsigned D = DESCRIPTOR::d;
    using namespace descriptors;
 
    //Retrieve load balancer and local iC
    auto& superStructure = sParticleSystem.getSuperStructure();
    auto& loadBalancer = superStructure.getLoadBalancer();
    int iC = loadBalancer.loc(globiC);
 
    //Retrieve blockLattice and blockGeometry
    auto& blockLattice = sLattice.getBlock(iC);
    auto& blockGeometry = sGeometry.getBlockGeometry(iC);
 
    //Write particle to field
    if(isPeriodic(periodicity)) {
      const PhysR<T,D> min = communication::getCuboidMin<T,D>(sGeometry.getCuboidGeometry());
      const PhysR<T,D> max = communication::getCuboidMax<T,D>(sGeometry.getCuboidGeometry(), min);
 
      setBlockParticleField( blockGeometry, blockLattice, converter, min, max,
                           particle, periodicity);
    } else {
      setBlockParticleField( blockGeometry, blockLattice, converter, particle );
    }
  }

References olb::SuperLattice< T, DESCRIPTOR >::getBlock(), olb::SuperGeometry< T, D >::getBlockGeometry(), olb::SuperStructure< T, D >::getCuboidGeometry(), olb::SuperStructure< T, D >::getLoadBalancer(), olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getSuperStructure(), olb::particles::isPeriodic(), and olb::particles::setBlockParticleField().

Here is the call graph for this function:

Member Data Documentation

latticeCoupling

template<typename T , typename DESCRIPTOR , typename PARTICLETYPE >

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

staticconstexpr

Definition at line 296 of file particleTasks.h.

particleLoop

template<typename T , typename DESCRIPTOR , typename PARTICLETYPE >

constexpr bool olb::particles::couple_parallel_particles_to_lattice< T, DESCRIPTOR, PARTICLETYPE >::particleLoop = true

staticconstexpr

Definition at line 297 of file particleTasks.h.

---

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

• src/particles/functions/particleTasks.h