#include <particleSystem.h>

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

Public Member Functions
	ParticleSystem ()
	Default constructor.

	ParticleSystem (std::size_t count)
	Constructor with initial particle size.

	ParticleSystem (std::size_t count, typename associatedTypes::template decompose_into< std::tuple > associatedData)
	Constructor with initial particle size and associated Data.

Iterator	begin ()

Iterator	end ()

template<typename PCONDITION = conditions::all_particles>
constexpr std::size_t	size ()
	Size of ParticleSystem.

template<typename PCONDITION = conditions::all_particles>
constexpr std::size_t	size (int globiC)
	Size of ParticleSystem (enables passing of globiC, if used in SuperParticleSystem)

template<bool boundsCheck = false>
dynamics::ParticleDynamics< T, PARTICLETYPE > *	getDynamics (unsigned iDyn=0)
	Get specific dynamics (optional boundsCheck via .at())

void	addDynamics (std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > &dynamicsSPtr)
	Add dynamics (from shared_pointer of dynamics)

template<typename DYNAMICS , typename ... Args>
void	defineDynamics (Args &&...args)
	Define dynamics (factory method)

void	extend ()
	Extend particle system by one particle.

void	swapParticles (std::size_t iP, std::size_t jP)
	Swap particles by index.

void	process (std::size_t p0, std::size_t p1, T timeStepSize, unsigned iDyn=0)
	Upate/process particle quantities on a subset (mostly local equivalent to collide)

void	process (T timeStepSize, unsigned iDyn=0)
	Upate/process particle quantities on all particles.

void	update ()
	Update particles (equivalent to stream())

auto &	get ()
	Expose container.

std::vector< std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > > &	getDynamicsVector ()
	Expose dynamics vector.

template<bool boundsCheck = false>
Particle< T, PARTICLETYPE >	get (std::size_t iParticle)
	Create and return particle (analogous to cell TODO: make same baseclass) (optional boundsCheck)

Particle< T, PARTICLETYPE >	operator[] (std::size_t iParticle)
	Create and return particle with operator[].

template<typename GROUP , typename FIELD >
auto &	getFieldD ()
	Get whole Field by GROUP (or base of GROUP) and FIELD.

template<typename GROUP , typename FIELD >
auto	getFieldPointer (std::size_t iParticle)
	Get FieldPointer by GROUP (or base of GROUP) and FIELD for specific iParticle.

template<typename TYPE >
auto &	getAssociatedData ()
	Get associated data by specifying data type.

std::size_t	getSerialSize () const
	Get serial size of dynamic fields group.

void	print ()
	Print relevant infos.

void	checkForErrors ()
	Check for erroes.

Detailed Description

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

Definition at line 41 of file blockLatticeInteraction.h.

Constructor & Destructor Documentation

◆ ParticleSystem() [1/3]

template<typename T , typename PARTICLETYPE >

olb::particles::ParticleSystem< T, PARTICLETYPE >::ParticleSystem ( )

Default constructor.

Definition at line 34 of file particleSystem.hh.

  : _fieldGroupsContainer( Container<T,PARTICLETYPE,DATA>(0) ),
    _serialSize(DATA(0).getSerializableSize())
{}

◆ ParticleSystem() [2/3]

template<typename T , typename PARTICLETYPE >

olb::particles::ParticleSystem< T, PARTICLETYPE >::ParticleSystem ( std::size_t count )

Constructor with initial particle size.

Definition at line 40 of file particleSystem.hh.

  : _fieldGroupsContainer( Container<T,PARTICLETYPE,DATA>(count) ),
    _serialSize(DATA(0).getSerializableSize())
{}

◆ ParticleSystem() [3/3]

template<typename T , typename PARTICLETYPE >

olb::particles::ParticleSystem< T, PARTICLETYPE >::ParticleSystem	(	std::size_t	count,
		typename associatedTypes::template decompose_into< std::tuple >	associatedData )

Constructor with initial particle size and associated Data.

Definition at line 46 of file particleSystem.hh.

  : _associatedData( associatedData ),
    _fieldGroupsContainer( Container<T,PARTICLETYPE,DATA>(count) ),
    _serialSize(DATA(0).getSerializableSize())
{}

Member Function Documentation

◆ addDynamics()

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::addDynamics ( std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > & dynamicsSPtr )

Add dynamics (from shared_pointer of dynamics)

Definition at line 104 of file particleSystem.hh.

{
  _dynamicsVector.push_back( dynamicsSPtr );
}

◆ begin()

template<typename T , typename PARTICLETYPE >

Iterator olb::particles::ParticleSystem< T, PARTICLETYPE >::begin ( )

inline

Definition at line 87 of file particleSystem.h.

87{ return Iterator(this,0); }

◆ checkForErrors()

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::checkForErrors ( )

Check for erroes.

Definition at line 228 of file particleSystem.hh.

{
  //Check, whether at least one ParticleDynamics present
  if ( _dynamicsVector.size()==0 ){
    throw std::logic_error("No ParticleDynamics set!");
  }
}

◆ defineDynamics()

template<typename T , typename PARTICLETYPE >

template<typename DYNAMICS , typename ... Args>

void olb::particles::ParticleSystem< T, PARTICLETYPE >::defineDynamics ( Args &&... args )

Define dynamics (factory method)

Definition at line 112 of file particleSystem.hh.

                                                                  {
  _dynamicsVector.push_back( std::make_shared<DYNAMICS>(std::forward<Args>(args)...) );
}

◆ end()

template<typename T , typename PARTICLETYPE >

Iterator olb::particles::ParticleSystem< T, PARTICLETYPE >::end ( )

inline

Definition at line 88 of file particleSystem.h.

88{ return Iterator(this,size()); }

olb::particles::ParticleSystem::size

constexpr std::size_t size()

Size of ParticleSystem.

Definition particleSystem.hh:55

References olb::particles::ParticleSystem< T, PARTICLETYPE >::size().

Here is the call graph for this function:

◆ extend()

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::extend ( )

Extend particle system by one particle.

Definition at line 117 of file particleSystem.hh.

{
  _fieldGroupsContainer.push_back();
//  _dynamicsMapContainer.push_back();
}

Here is the caller graph for this function:

◆ get() [1/2]

template<typename T , typename PARTICLETYPE >

auto & olb::particles::ParticleSystem< T, PARTICLETYPE >::get ( )

Expose container.

Definition at line 149 of file particleSystem.hh.

{
  return _fieldGroupsContainer;
}

Here is the caller graph for this function:

◆ get() [2/2]

template<typename T , typename PARTICLETYPE >

template<bool boundsCheck>

Particle< T, PARTICLETYPE > olb::particles::ParticleSystem< T, PARTICLETYPE >::get ( std::size_t iParticle )

Create and return particle (analogous to cell TODO: make same baseclass) (optional boundsCheck)

Definition at line 162 of file particleSystem.hh.

{
  if constexpr(boundsCheck){
    if (iParticle>_fieldGroupsContainer.size()){
      throw std::out_of_range("Particle does not exist in Particlesystem!");
    }
    return Particle<T,PARTICLETYPE>( _fieldGroupsContainer.data(),
              _dynamicsVector, iParticle );
  } else {
    return Particle<T,PARTICLETYPE>( _fieldGroupsContainer.data(),
              _dynamicsVector, iParticle );
  }
}

◆ getAssociatedData()

template<typename T , typename PARTICLETYPE >

template<typename TYPE >

auto & olb::particles::ParticleSystem< T, PARTICLETYPE >::getAssociatedData ( )

Get associated data by specifying data type.

Definition at line 205 of file particleSystem.hh.

{
  const std::size_t idx = associatedTypes::template index<TYPE>();
  return std::get<idx>(_associatedData);
}

◆ getDynamics()

template<typename T , typename PARTICLETYPE >

template<bool boundsCheck>

dynamics::ParticleDynamics< T, PARTICLETYPE > * olb::particles::ParticleSystem< T, PARTICLETYPE >::getDynamics ( unsigned iDyn = 0 )

Get specific dynamics (optional boundsCheck via .at())

Definition at line 93 of file particleSystem.hh.

{
  if constexpr(boundsCheck){
    return _dynamicsVector.at(iDyn).get();
  } else {
    return _dynamicsVector[iDyn].get();
  }
}

◆ getDynamicsVector()

template<typename T , typename PARTICLETYPE >

std::vector< std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > > & olb::particles::ParticleSystem< T, PARTICLETYPE >::getDynamicsVector ( )

Expose dynamics vector.

Definition at line 155 of file particleSystem.hh.

{
  return _dynamicsVector;
}

◆ getFieldD()

template<typename T , typename PARTICLETYPE >

template<typename GROUP , typename FIELD >

auto & olb::particles::ParticleSystem< T, PARTICLETYPE >::getFieldD ( )

Get whole Field by GROUP (or base of GROUP) and FIELD.

Definition at line 184 of file particleSystem.hh.

{
  using GROUP_EVAL = typename PARTICLETYPE::template derivedField<GROUP>;
  using FIELD_EVAL = typename GROUP_EVAL::template derivedField<FIELD>;
  return _fieldGroupsContainer.data().template get<GROUP_EVAL>()
         .template get<FIELD_EVAL>();
}

◆ getFieldPointer()

template<typename T , typename PARTICLETYPE >

template<typename GROUP , typename FIELD >

auto olb::particles::ParticleSystem< T, PARTICLETYPE >::getFieldPointer ( std::size_t iParticle )

Get FieldPointer by GROUP (or base of GROUP) and FIELD for specific iParticle.

Definition at line 194 of file particleSystem.hh.

{
  using GROUP_EVAL = typename PARTICLETYPE::template derivedField<GROUP>;
  using FIELD_EVAL = typename GROUP_EVAL::template derivedField<FIELD>;
  return _fieldGroupsContainer.data().template get<GROUP_EVAL>()
         .template get<FIELD_EVAL>()
         .getRowPointer( iParticle );
}

◆ getSerialSize()

template<typename T , typename PARTICLETYPE >

std::size_t olb::particles::ParticleSystem< T, PARTICLETYPE >::getSerialSize ( ) const

Get serial size of dynamic fields group.

Definition at line 213 of file particleSystem.hh.

{
  return _serialSize;
}

◆ operator[]()

template<typename T , typename PARTICLETYPE >

Particle< T, PARTICLETYPE > olb::particles::ParticleSystem< T, PARTICLETYPE >::operator[] ( std::size_t iParticle )

Create and return particle with operator[].

Definition at line 177 of file particleSystem.hh.

{
  return get(iParticle);
}

◆ print()

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::print ( )

Print relevant infos.

Definition at line 219 of file particleSystem.hh.

{
  OstreamManager clout(std::cout, "ParticleSystem");
  clout << "-----ParticleSystem------" << std::endl;
  clout << "nop=" << size() << std::endl;
  clout << "-------------------------" << std::endl;
}

◆ process() [1/2]

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::process	(	std::size_t	p0,
		std::size_t	p1,
		T	timeStepSize,
		unsigned	iDyn = 0 )

Upate/process particle quantities on a subset (mostly local equivalent to collide)

Definition at line 131 of file particleSystem.hh.

{
  auto particle = get(iP0);
  for (std::size_t iP=iP0; iP<iPmax; ++iP) {
    particle.process(timeStepSize,iDyn);
    particle.advanceId();
  }
}

◆ process() [2/2]

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::process	(	T	timeStepSize,
		unsigned	iDyn = 0 )

Upate/process particle quantities on all particles.

Definition at line 142 of file particleSystem.hh.

{
  process(0, size(), timeStepSize, iDyn);
}

◆ size() [1/2]

template<typename T , typename PARTICLETYPE >

template<typename PCONDITION >

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

constexpr

Size of ParticleSystem.

Definition at line 55 of file particleSystem.hh.

{
  //Either directly return size of container
  if constexpr(std::is_same_v<PCONDITION,conditions::all_particles>){
    return _fieldGroupsContainer.size();
  //Or iterate over container evaluating condition
  } else {
    std::size_t count=0;
    for (std::size_t iP=0; iP<_fieldGroupsContainer.size(); ++iP) {
      auto particle = get(iP);
      doWhenMeetingCondition<T,PARTICLETYPE,PCONDITION>( particle,
        [&](Particle<T,PARTICLETYPE> particle){ ++count; });
    }
    return count;
  }
}

References olb::particles::doWhenMeetingCondition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size() [2/2]

template<typename T , typename PARTICLETYPE >

template<typename PCONDITION >

std::size_t olb::particles::ParticleSystem< T, PARTICLETYPE >::size ( int globiC )

constexpr

Size of ParticleSystem (enables passing of globiC, if used in SuperParticleSystem)

Definition at line 74 of file particleSystem.hh.

{
  //Either directly return size of container
  if constexpr(std::is_same_v<PCONDITION,conditions::all_particles>){
    return _fieldGroupsContainer.size();
  //Or iterate over container evaluating condition
  } else {
    std::size_t count=0;
    for (std::size_t iP=0; iP<_fieldGroupsContainer.size(); ++iP) {
      auto particle = get(iP);
      doWhenMeetingCondition<T,PARTICLETYPE,PCONDITION>( particle,
        [&](Particle<T,PARTICLETYPE> particle){ ++count; }, globiC);
    }
    return count;
  }
}

References olb::particles::doWhenMeetingCondition().

Here is the call graph for this function:

◆ swapParticles()

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::swapParticles	(	std::size_t	iP,
		std::size_t	jP )

Swap particles by index.

Definition at line 124 of file particleSystem.hh.

{
  _fieldGroupsContainer.swapElements(iP,jP);
//  _dynamicsMapContainer.swapElements(iP,jP);
}

Here is the caller graph for this function:

◆ update()

template<typename T , typename PARTICLETYPE >

void olb::particles::ParticleSystem< T, PARTICLETYPE >::update ( )

Update particles (equivalent to stream())

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

src/functors/lattice/latticeHaiderLevenspielDragForce.h
src/functors/lattice/latticeMomentumExchangeForce.h
src/functors/lattice/latticeSchillerNaumannDragForce.h
src/functors/lattice/latticeSpheroidLiftForce.h
src/functors/lattice/latticeStokesDragForce.h
src/functors/lattice/latticeStokesSpheroidDragForce.h
src/functors/lattice/latticeTranCongDragForce.h
src/particles/particleSystem.h
src/particles/resolved/blockLatticeInteraction.h
src/particles/particleSystem.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ParticleSystem() [1/3]

◆ ParticleSystem() [2/3]

◆ ParticleSystem() [3/3]

Member Function Documentation

◆ addDynamics()

◆ begin()

◆ checkForErrors()

◆ defineDynamics()

◆ end()

◆ extend()

◆ get() [1/2]

◆ get() [2/2]

◆ getAssociatedData()

◆ getDynamics()

◆ getDynamicsVector()

◆ getFieldD()

◆ getFieldPointer()

◆ getSerialSize()

◆ operator[]()

◆ print()

◆ process() [1/2]

◆ process() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ swapParticles()

◆ update()