olb::particles::SuperParticleSystem< T, PARTICLETYPE > Class Template Reference

#include <superParticleSystem.h>

Inheritance diagram for olb::particles::SuperParticleSystem< T, PARTICLETYPE >:

Collaboration diagram for olb::particles::SuperParticleSystem< T, PARTICLETYPE >:

Public Member Functions
	SuperParticleSystem (SuperStructure< T, PARTICLETYPE::d > &superStructure, T maximalCircumRadius=T{0.})
	SuperParticleSystem (SuperGeometry< T, PARTICLETYPE::d > &superGeometry, T maximalCircumRadius=T{0.})
	Create SuperParticleSystem from SuperGeometry and optional maximal circumference radius (if already known)
void	print ()
void	addDynamics (std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > &dynamicsSPtr)
template<typename DYNAMICS , typename ... Args>
void	defineDynamics (Args &&...args)
std::vector< ParticleSystem< T, PARTICLETYPE > * > &	getBlockParticleSystems ()
SuperStructure< T, PARTICLETYPE::d > &	getSuperStructure ()
const std::set< int > &	getNeighbourRanks ()
const std::set< int > &	getExtendedNeighbourRanks ()
const std::vector< std::set< int > > &	getCuboidNeighborhood ()
std::size_t	getGlobID ()
std::size_t	getSerialSize () const
Particle< T, PARTICLETYPE >	get (std::size_t globalParticleID)
template<typename PCONDITION = conditions::all_particles>
constexpr std::size_t	size ()
void	checkForErrors ()
void	updateOffsetFromCircumRadius (T circumRadius)

Detailed Description

template<typename T, typename PARTICLETYPE>
class olb::particles::SuperParticleSystem< T, PARTICLETYPE >

Definition at line 32 of file superParticleSystem.h.

Constructor & Destructor Documentation

SuperParticleSystem() [1/2]

template<typename T , typename PARTICLETYPE >

olb::particles::SuperParticleSystem< T, PARTICLETYPE >::SuperParticleSystem	(	SuperStructure< T, PARTICLETYPE::d > &	superStructure,
		T	maximalCircumRadius = T{0.} )

Definition at line 32 of file superParticleSystem.hh.

    : _superStructure(superStructure)
    , _serialSize(ParticleSystem<T, PARTICLETYPE>(1).getSerialSize())
    , _maximalCircumRadius(maximalCircumRadius)
{
  static_assert(access::providesValid<PARTICLETYPE>(), "Field GENERAL:VALID has to be provided");
  auto loadBalancer = superStructure.getLoadBalancer();
  // always create at least one BlockParticleSystem to counteract possible problems
  // (for example in creator functions, where the first blockParticleSystem is hard coded)
  _blockParticleSystems.push_back(new ParticleSystem<T, PARTICLETYPE>);
  for (int iC = 1; iC < loadBalancer.size(); ++iC) {
    _blockParticleSystems.push_back(new ParticleSystem<T, PARTICLETYPE>);
  }
 
  _cuboidNeighborhood.resize(_superStructure.getCuboidDecomposition().size());
  updateCuboidNeighborhood();
}

References olb::SuperStructure< T, D >::getCuboidDecomposition(), olb::SuperStructure< T, D >::getLoadBalancer(), and olb::particles::access::providesValid().

Here is the call graph for this function:

SuperParticleSystem() [2/2]

template<typename T , typename PARTICLETYPE >

olb::particles::SuperParticleSystem< T, PARTICLETYPE >::SuperParticleSystem	(	SuperGeometry< T, PARTICLETYPE::d > &	superGeometry,
		T	maximalCircumRadius = T{0.} )

Create SuperParticleSystem from SuperGeometry and optional maximal circumference radius (if already known)

Definition at line 52 of file superParticleSystem.hh.

    : SuperParticleSystem<T, PARTICLETYPE>(
          static_cast<SuperStructure<T, PARTICLETYPE::d>&>(superGeometry), maximalCircumRadius)
{}

Member Function Documentation

addDynamics()

template<typename T , typename PARTICLETYPE >

void olb::particles::SuperParticleSystem< T, PARTICLETYPE >::addDynamics

(

std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > &

dynamicsSPtr

)

Definition at line 85 of file superParticleSystem.hh.

{
  auto loadBalancer = _superStructure.getLoadBalancer();
  for (int iC = 0; iC < loadBalancer.size(); ++iC) {
    auto& bParticleSystem = *_blockParticleSystems[iC];
    bParticleSystem.addDynamics( dynamicsSPtr );
  }
}

checkForErrors()

template<typename T , typename PARTICLETYPE >

void olb::particles::SuperParticleSystem< T, PARTICLETYPE >::checkForErrors

(

)

Definition at line 193 of file superParticleSystem.hh.

{
  //Check, whether at least one ParticleDynamics present
#ifdef PARALLEL_MODE_MPI
  if(singleton::mpi().isMainProcessor()){
#endif
    _blockParticleSystems[0]->checkForErrors();
#ifdef PARALLEL_MODE_MPI
  }
#endif
}

References olb::singleton::mpi().

Here is the call graph for this function:

defineDynamics()

template<typename T , typename PARTICLETYPE >

template<typename DYNAMICS , typename ... Args>

void olb::particles::SuperParticleSystem< T, PARTICLETYPE >::defineDynamics

(

Args &&...

args

)

Definition at line 97 of file superParticleSystem.hh.

                                                                       {
  auto loadBalancer = _superStructure.getLoadBalancer();
  for (int iC = 0; iC < loadBalancer.size(); ++iC) {
    auto& bParticleSystem = *_blockParticleSystems[iC];
    bParticleSystem.template defineDynamics<DYNAMICS>( std::forward<Args>(args)... );
  }
}

get()

template<typename T , typename PARTICLETYPE >

Particle< T, PARTICLETYPE > olb::particles::SuperParticleSystem< T, PARTICLETYPE >::get

(

std::size_t

globalParticleID

)

Definition at line 152 of file superParticleSystem.hh.

{
  using namespace descriptors;
 
  for (ParticleSystem<T, PARTICLETYPE>* blockParticleSystem :
       _blockParticleSystems) {
    for (std::size_t localiP = 0; localiP < blockParticleSystem->size();
         ++localiP) {
      auto              particle = blockParticleSystem->get(localiP);
      const std::size_t currentGlobalParticleID =
          particle.template getField<PARALLELIZATION, ID>();
      if (globalParticleID == currentGlobalParticleID) {
        return particle;
      }
    }
  }
 
  std::cerr << "ERROR: Rank " << singleton::mpi().getRank()
            << " cannot find particle with global id " << globalParticleID
            << std::endl;
  assert(false);
  return _blockParticleSystems[0]->get(0);
}

References olb::particles::ParticleSystem< T, PARTICLETYPE >::get(), olb::singleton::MpiManager::getRank(), and olb::singleton::mpi().

Here is the call graph for this function:

Here is the caller graph for this function:

getBlockParticleSystems()

template<typename T , typename PARTICLETYPE >

std::vector< ParticleSystem< T, PARTICLETYPE > * > & olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getBlockParticleSystems

(

)

Definition at line 125 of file superParticleSystem.hh.

{
  return _blockParticleSystems;
}

Here is the caller graph for this function:

getCuboidNeighborhood()

template<typename T , typename PARTICLETYPE >

const std::vector< std::set< int > > & olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getCuboidNeighborhood

(

)

Definition at line 118 of file superParticleSystem.hh.

{
  return _cuboidNeighborhood;
}

getExtendedNeighbourRanks()

template<typename T , typename PARTICLETYPE >

const std::set< int > & olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getExtendedNeighbourRanks

(

)

Definition at line 112 of file superParticleSystem.hh.

{
  return _extendedNeighbourRanks;
}

Here is the caller graph for this function:

getGlobID()

template<typename T , typename PARTICLETYPE >

std::size_t olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getGlobID

(

)

Definition at line 138 of file superParticleSystem.hh.

{
  return _currentGlobalID++;
}

Here is the caller graph for this function:

getNeighbourRanks()

template<typename T , typename PARTICLETYPE >

const std::set< int > & olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getNeighbourRanks

(

)

Definition at line 106 of file superParticleSystem.hh.

{
  return _neighbourRanks;
}

Here is the caller graph for this function:

getSerialSize()

template<typename T , typename PARTICLETYPE >

std::size_t olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getSerialSize

(

)

const

Definition at line 144 of file superParticleSystem.hh.

{
  return _serialSize;
}

Here is the caller graph for this function:

getSuperStructure()

template<typename T , typename PARTICLETYPE >

SuperStructure< T, PARTICLETYPE::d > & olb::particles::SuperParticleSystem< T, PARTICLETYPE >::getSuperStructure

(

)

Definition at line 132 of file superParticleSystem.hh.

{
  return _superStructure;
}

Here is the caller graph for this function:

print()

template<typename T , typename PARTICLETYPE >

void olb::particles::SuperParticleSystem< T, PARTICLETYPE >::print

(

)

Definition at line 59 of file superParticleSystem.hh.

{
  OstreamManager clout(std::cout, "SuperParticleSystem");
  auto           loadBalancer = _superStructure.getLoadBalancer();
  auto           rank         = singleton::mpi().getRank();
  clout << "---SuperParticleSystem---" << std::endl;
  clout.setMultiOutput(true);
#ifdef PARALLEL_MODE_MPI
  singleton::mpi().synchronizeIO();
#endif
  for (int iC = 0; iC < loadBalancer.size(); ++iC) {
    int    globiC          = loadBalancer.glob(iC);
    auto&  bParticleSystem = *_blockParticleSystems[iC];
    size_t size            = bParticleSystem.size();
    clout << "BlockParticleSystem " << globiC << " (" << rank << "," << iC
          << ")"
          << ": nop=" << size << std::endl;
  }
  clout.setMultiOutput(false);
#ifdef PARALLEL_MODE_MPI
  singleton::mpi().synchronizeIO();
#endif
  clout << "-------------------------" << std::endl;
}

size()

template<typename T , typename PARTICLETYPE >

template<typename PCONDITION >

std::size_t olb::particles::SuperParticleSystem< T, PARTICLETYPE >::size ( )

constexpr

Definition at line 178 of file superParticleSystem.hh.

{
  std::size_t size = 0;
  communication::forSystemsInSuperParticleSystem<T,PARTICLETYPE>(
    *this,
    [&](ParticleSystem<T, PARTICLETYPE>& particleSystem, int iC, int globiC) {
      size += particleSystem.template size<PCONDITION>(globiC);
    });
#ifdef PARALLEL_MODE_MPI
  singleton::mpi().reduceAndBcast(size, MPI_SUM);
#endif
  return size;
}

References olb::particles::communication::forSystemsInSuperParticleSystem(), olb::singleton::mpi(), and olb::singleton::MpiManager::reduceAndBcast().

Here is the call graph for this function:

updateOffsetFromCircumRadius()

template<typename T , typename PARTICLETYPE >

void olb::particles::SuperParticleSystem< T, PARTICLETYPE >::updateOffsetFromCircumRadius

(

T

circumRadius

)

Definition at line 206 of file superParticleSystem.hh.

{
  if(_maximalCircumRadius < circumRadius) {
    _maximalCircumRadius = circumRadius;
    updateCuboidNeighborhood();
  }
}

Here is the caller graph for this function:

---

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

• src/functors/groupedFieldF.h
• src/functors/lattice/latticeMomentumExchangeForce.h
• src/particles/communication/superParticleSystem.h
• src/particles/communication/superParticleSystem.hh