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

#include <particle.h>

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

Public Types
using	Communicatable = typename GroupedDataCommunicatableHelper<DATA,PARTICLETYPE>::type
	Define Communicatable.

Public Member Functions
	Particle (DATA &dynamicFieldGroupsD, std::vector< std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > > &dynamicsVector, std::size_t iParticle)
void	init ()
	Initialize.
template<bool multiOutput = PARTICLETYPE::template providesNested<descriptors::PARALLELIZATION>()>
void	print (std::size_t iParticle)
	Print.
template<bool multiOutput = PARTICLETYPE::template providesNested<descriptors::PARALLELIZATION>()>
void	print ()
std::size_t	getId () const
	Return memory ID of the currently represented particle.
void	setId (std::size_t iParticle)
	Jump to arbitrary particle memory ID.
void	advanceId ()
	Jump to next particle in linearization sequence.
void	addDynamics (std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > &dynamicsSPtr)
	Add dynamics.
template<typename DYNAMICS , typename ... Args>
void	defineDynamics (Args &&...args)
	Define dynamics (factory method)
template<bool boundsCheck = false>
dynamics::ParticleDynamics< T, PARTICLETYPE > *	getDynamics (unsigned iDyn=0)
	Get a pointer to specific dynamics.
void	process (T timeStepSize, unsigned short iDyn=0)
	Apply processing to the particle according to dynamics at iDyn.
template<typename GROUP , typename FIELD >
std::enable_if_t<(PARTICLETYPE::template size< typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >() > 1), FieldD< T, PARTICLETYPE, typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >	getField ()
	Return copy of descriptor-declared FIELD as a vector.
template<typename GROUP , typename FIELD >
std::enable_if_t<(PARTICLETYPE::templatesize< typenamePARTICLETYPE::templatederivedField< GROUP >::templatederivedField< FIELD > >()==1), typenamePARTICLETYPE::templatederivedField< GROUP >::template derivedField< FIELD >::template value_type< T >	getField ()
	Return copy of descriptor-declared FIELD as a scalar (more specifically as value type of FIELD)
template<typename GROUP , typename FIELD >
std::enable_if_t<(PARTICLETYPE::template size< typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >() > 1), void >	setField (const FieldD< T, PARTICLETYPE, typename PARTICLETYPE::template derivedField< GROUP > ::template derivedField< FIELD > > &v)
	Set descriptor-declared FIELD.
template<typename GROUP , typename FIELD >
std::enable_if_t<(PARTICLETYPE::template size< typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >()==1), void >	setField (typename PARTICLETYPE::template derivedField< GROUP > ::template derivedField< FIELD > ::template value_type< T > value)
	Set descriptor-declared FIELD.
Communicatable	getCommunicatable ()
	Get communicatable necessary for serialization.
std::size_t	getSerialSize () const
	Get serialized size.
std::size_t	serialize (std::uint8_t *buffer) const
	Serialize data.
std::size_t	deserialize (const std::uint8_t *buffer)
	Deserialize data.

Detailed Description

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

Definition at line 42 of file particle.h.

Member Typedef Documentation

Communicatable

template<typename T , typename PARTICLETYPE >

using olb::particles::Particle< T, PARTICLETYPE >::Communicatable = typename GroupedDataCommunicatableHelper<DATA,PARTICLETYPE>::type

Define Communicatable.

Definition at line 130 of file particle.h.

Constructor & Destructor Documentation

Particle()

template<typename T , typename PARTICLETYPE >

olb::particles::Particle< T, PARTICLETYPE >::Particle	(	DATA &	dynamicFieldGroupsD,
		std::vector< std::shared_ptr< dynamics::ParticleDynamics< T, PARTICLETYPE > > > &	dynamicsVector,
		std::size_t	iParticle )

Definition at line 37 of file particle.hh.

  : _dynamicFieldGroupsD( dynamicFieldGroupsD ),
    _dynamicsVector( dynamicsVector ),
    _iParticle( iParticle)
{}

Member Function Documentation

addDynamics()

template<typename T , typename PARTICLETYPE >

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

(

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

dynamicsSPtr

)

Add dynamics.

Definition at line 85 of file particle.hh.

{
  _dynamicsVector.push_back( dynamicsSPtr );
}

advanceId()

template<typename T , typename PARTICLETYPE >

void olb::particles::Particle< T, PARTICLETYPE >::advanceId

(

)

Jump to next particle in linearization sequence.

Definition at line 79 of file particle.hh.

{
  ++_iParticle;
}

defineDynamics()

template<typename T , typename PARTICLETYPE >

template<typename DYNAMICS , typename ... Args>

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

(

Args &&...

args

)

Define dynamics (factory method)

Definition at line 93 of file particle.hh.

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

deserialize()

template<typename T , typename PARTICLETYPE >

std::size_t olb::particles::Particle< T, PARTICLETYPE >::deserialize ( const std::uint8_t * buffer )

inline

Deserialize data.

Definition at line 146 of file particle.h.

                                                 {
    const std::vector<unsigned int> indices{static_cast<unsigned int>(_iParticle)};
    return Communicatable(_dynamicFieldGroupsD).deserialize(indices, buffer);
  }

Here is the caller graph for this function:

getCommunicatable()

template<typename T , typename PARTICLETYPE >

Communicatable olb::particles::Particle< T, PARTICLETYPE >::getCommunicatable ( )

inline

Get communicatable necessary for serialization.

Definition at line 132 of file particle.h.

                                    {
    return Communicatable(_dynamicFieldGroupsD);
  }

getDynamics()

template<typename T , typename PARTICLETYPE >

template<bool boundsCheck>

dynamics::ParticleDynamics< T, PARTICLETYPE > * olb::particles::Particle< T, PARTICLETYPE >::getDynamics

(

unsigned

iDyn = 0

)

Get a pointer to specific dynamics.

Definition at line 99 of file particle.hh.

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

getField() [1/2]

template<typename T , typename PARTICLETYPE >

template<typename GROUP , typename FIELD >

std::enable_if_t<( PARTICLETYPE::template size< typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >() > 1), FieldD< T, PARTICLETYPE, typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > > olb::particles::Particle< T, PARTICLETYPE >::getField

(

)

Return copy of descriptor-declared FIELD as a vector.

getField() [2/2]

template<typename T , typename PARTICLETYPE >

template<typename GROUP , typename FIELD >

std::enable_if_t<(PARTICLETYPE::templatesize< typenamePARTICLETYPE::templatederivedField< GROUP >::templatederivedField< FIELD > >()==1), typenamePARTICLETYPE::templatederivedField< GROUP >::template derivedField< FIELD >::template value_type< T > olb::particles::Particle< T, PARTICLETYPE >::getField

(

)

Return copy of descriptor-declared FIELD as a scalar (more specifically as value type of FIELD)

getId()

template<typename T , typename PARTICLETYPE >

std::size_t olb::particles::Particle< T, PARTICLETYPE >::getId

(

)

const

Return memory ID of the currently represented particle.

Definition at line 67 of file particle.hh.

{
  return _iParticle;
}

Here is the caller graph for this function:

getSerialSize()

template<typename T , typename PARTICLETYPE >

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

inline

Get serialized size.

Definition at line 136 of file particle.h.

                                  {
    const std::vector<unsigned int> indices{static_cast<unsigned int>(_iParticle)};
    return Communicatable(_dynamicFieldGroupsD).size(indices);
  }

init()

template<typename T , typename PARTICLETYPE >

void olb::particles::Particle< T, PARTICLETYPE >::init

(

)

Initialize.

Definition at line 47 of file particle.hh.

{
  particles::dynamics::initializeParticle<T, PARTICLETYPE>( _dynamicFieldGroupsD, _iParticle);
}

print() [1/2]

template<typename T , typename PARTICLETYPE >

template<bool multiOutput>

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

(

)

Definition at line 61 of file particle.hh.

{
  print<multiOutput>(_iParticle);
}

print() [2/2]

template<typename T , typename PARTICLETYPE >

template<bool multiOutput>

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

(

std::size_t

iParticle

)

Print.

Definition at line 54 of file particle.hh.

{
  particles::io::printGenericParticleInfo<T, PARTICLETYPE,multiOutput>( _dynamicFieldGroupsD, iParticle);
}

process()

template<typename T , typename PARTICLETYPE >

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

Apply processing to the particle according to dynamics at iDyn.

Definition at line 110 of file particle.hh.

{
  if(access::isMotionComputationEnabled(*this)) {
    getDynamics(iDyn)->process(*this, timeStepSize);
  }
}

References olb::particles::access::isMotionComputationEnabled(), and olb::particles::dynamics::ParticleDynamics< T, PARTICLETYPE >::process().

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

template<typename T , typename PARTICLETYPE >

std::size_t olb::particles::Particle< T, PARTICLETYPE >::serialize ( std::uint8_t * buffer ) const

inline

Serialize data.

Definition at line 141 of file particle.h.

                                                {
    const std::vector<unsigned int> indices{static_cast<unsigned int>(_iParticle)};
    return Communicatable(_dynamicFieldGroupsD).serialize(indices, buffer);
  }

Here is the caller graph for this function:

setField() [1/2]

template<typename T , typename PARTICLETYPE >

template<typename GROUP , typename FIELD >

std::enable_if_t<(PARTICLETYPE::template size< typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >() > 1), void > olb::particles::Particle< T, PARTICLETYPE >::setField

(

const FieldD< T, PARTICLETYPE, typename PARTICLETYPE::template derivedField< GROUP > ::template derivedField< FIELD > > &

v

)

Set descriptor-declared FIELD.

Definition at line 164 of file particle.hh.

{
  using GROUP_EVAL = typename PARTICLETYPE
                     ::template derivedField<GROUP>;
  using FIELD_EVAL = typename GROUP_EVAL
                     ::template derivedField<FIELD>;
  //Analogous to BlockStaticFieldsD
  auto& field = _dynamicFieldGroupsD.template get<GROUP_EVAL>()
                .template get<FIELD_EVAL>();
  for (unsigned iDim=0; iDim < PARTICLETYPE::template size<FIELD_EVAL>(); ++iDim) {
    field[iDim][_iParticle] = v[iDim];
  }
}

setField() [2/2]

template<typename T , typename PARTICLETYPE >

template<typename GROUP , typename FIELD >

std::enable_if_t<(PARTICLETYPE::template size< typename PARTICLETYPE::template derivedField< GROUP >::template derivedField< FIELD > >()==1), void > olb::particles::Particle< T, PARTICLETYPE >::setField

(

typename PARTICLETYPE::template derivedField< GROUP > ::template derivedField< FIELD > ::template value_type< T >

value

)

Set descriptor-declared FIELD.

Definition at line 186 of file particle.hh.

{
  using GROUP_EVAL = typename PARTICLETYPE
                     ::template derivedField<GROUP>;
  using FIELD_EVAL = typename GROUP_EVAL
                     ::template derivedField<FIELD>;
  _dynamicFieldGroupsD.template get<GROUP_EVAL>()
  .template get<FIELD_EVAL>()
  .getRowPointer(_iParticle)[0] = value;
}

setId()

template<typename T , typename PARTICLETYPE >

void olb::particles::Particle< T, PARTICLETYPE >::setId

(

std::size_t

iParticle

)

Jump to arbitrary particle memory ID.

Definition at line 73 of file particle.hh.

{
  _iParticle = iParticle;
}

---

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

• src/functors/lattice/latticeMomentumExchangeForce.h
• src/particles/particle.h
• src/particles/particle.hh