PointParticle Class Reference

A particle class that only has a position and a weight. More...

#include <CD_PointParticle.H>

Inheritance diagram for PointParticle:

Collaboration diagram for PointParticle:

Public Member Functions
	PointParticle ()
	Default constructor. Sets weight and position to zero.
	PointParticle (const RealVect a_position, const Real a_weight)
	Constructor. Subsequently calls define.
virtual	~PointParticle ()
	Dtor - does nothing.
void	define (const RealVect a_position, const Real a_weight)
	Full define function.
Real &	weight ()
	Get weight.
const Real &	weight () const
	Const retrieve weight.
Public Member Functions inherited from GenericParticle< 1, 0 >
	GenericParticle ()
	Default constructor – initializes everything to zero.
	GenericParticle (const GenericParticle< M, N > &a_other)
	Copy constructor. Copies all fields.
virtual	~GenericParticle ()
	Destructor (deallocates runtime memory storage)
const int32_t &	particleID () const noexcept
	Get the particle ID.
int32_t &	particleID () noexcept
	Get the particle ID.
const int32_t &	rankID () const noexcept
	Get the MPI rank ID.
int32_t &	rankID () noexcept
	Get the MPI rank ID.
RealVect &	position ()
	Get the particle position.
const RealVect &	position () const
	Get the particle position.
const std::array< Real, M > &	getReals () const noexcept
	Get the M scalars.
std::array< Real, M > &	getReals () noexcept
	Get the M scalars.
const std::array< RealVect, N > &	getVects () const noexcept
	Get the N vectors.
std::array< RealVect, N > &	getVects () noexcept
	Get the N vectors.
Real &	real ()
	Get one of the scalars.
const Real &	real () const
	Get one of the scalars.
RealVect &	vect ()
	Get one of the RealVects.
const RealVect &	vect () const
	Get one of the RealVects.
bool	operator== (const GenericParticle< M, N > &a_other) const
	Comparison operator with other particle.
bool	operator!= (const GenericParticle< M, N > &a_other) const
	Comparison operator with other particle.
bool	operator< (const GenericParticle< M, N > &a_other) const noexcept
	Particle comparison operator. Returns lexicographical ordering.
virtual int	size () const
	Returns the size, in number of bytes, of a flat representation of the data in this object.
virtual void	linearOut (void *const a_buffer) const
	Write a linear binary representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller.
virtual void	linearIn (const void *const a_buffer)
	Read a linear binary representation of the internal data. Assumes that the buffer has the correct data.
virtual int	H5size () const
	Function that is used when writing particles to HDF5.
virtual void	H5linearOut (void *const a_buffer) const
	Linearize the Real components onto a buffer workable by HDF5.
virtual void	H5linearIn (const void *const a_buffer)
	Delinearize the buffer onto the real components in the particle class.

Additional Inherited Members
Protected Attributes inherited from GenericParticle< 1, 0 >
int32_t	m_particleID
	Particle ID.
int32_t	m_rankID
	MPI rank owning this particle.
RealVect	m_position
	Particle position.
std::array< Real, M >	m_scalars
	Scalar storage array.
std::array< RealVect, N >	m_vectors
	vector storage array

Detailed Description

A particle class that only has a position and a weight.

Constructor & Destructor Documentation

PointParticle()

PointParticle::PointParticle ( const RealVect  a_position, const Real  a_weight  )

inline

Constructor. Subsequently calls define.

Parameters

[in]	a_position	Position (in physical space)
[in]	a_weight	Particle weight

Member Function Documentation

define()

void PointParticle::define ( const RealVect  a_position, const Real  a_weight  )

inline

Full define function.

Parameters

[in]	a_position	Position (in physical space)
[in]	a_weight	Particle weight

---

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

• Source/Particle/CD_PointParticle.H
• Source/Particle/CD_PointParticleImplem.H