CD_GenericParticle.H File Reference

Declaration of a generic particle class. More...

#include <string>
#include <typeinfo>
#include <cstdio>
#include <cmath>
#include <array>
#include <cstdint>
#include <RealVect.H>
#include <CD_NamespaceHeader.H>
#include <CD_NamespaceFooter.H>
#include <CD_GenericParticleImplem.H>

Include dependency graph for CD_GenericParticle.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GenericParticle< M, N >
	A generic particle class, holding the position and a specified number of real and vector values. More...

Functions
template<class T >
void	detail::pushParticleProperty (uint8_t *&p, const T &a_x)
	Helper function for linearizing a particle onto a buffer. @detail This copies T into the buffer p and increments the pointer.
template<class T >
void	detail::pullParticleProperty (const uint8_t *&p, T &a_x)
	Helper function for linearizing a buffer onto a particle property. @detail This copies from the buffer p into the particle property T.
template<size_t M, size_t N>
std::ostream &	operator<< (std::ostream &ostr, const GenericParticle< M, N > &p)
	Particle printing function.

Detailed Description

Declaration of a generic particle class.

Author

Robert Marskar

Function Documentation

operator<<()

template<size_t M, size_t N>

std::ostream & operator<< ( std::ostream &  ostr, const GenericParticle< M, N > &  p  )

inline

Particle printing function.

Parameters

[in]	ostr	Output stream
[in]	a_particle	Particle to output

pullParticleProperty()

template<class T >

void detail::pullParticleProperty ( const uint8_t *&  p, T &  a_x  )

inline

Helper function for linearizing a buffer onto a particle property. @detail This copies from the buffer p into the particle property T.

Parameters

[in,out]	p	Buffer.
[in]	a_x	Particle property. Must be a trivial type.

pushParticleProperty()

template<class T >

void detail::pushParticleProperty ( uint8_t *&  p, const T &  a_x  )

inline

Helper function for linearizing a particle onto a buffer. @detail This copies T into the buffer p and increments the pointer.

Parameters

[in,out]	p	Buffer
[in]	a_x	Particle property. Must be a trivial type.