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. More... | |
| virtual | ~PointParticle () |
| Dtor - does nothing. | |
| void | define (const RealVect a_position, const Real a_weight) |
| Full define function. More... | |
| 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. More... | |
| virtual | ~GenericParticle () |
| Destructor (deallocates runtime memory storage) | |
| RealVect & | position () |
| Get the particle position. More... | |
| const RealVect & | position () const |
| Get the particle position. More... | |
| const std::array< Real, M > & | getReals () const noexcept |
| Get the M scalars. More... | |
| std::array< Real, M > & | getReals () noexcept |
| Get the M scalars. More... | |
| const std::array< RealVect, N > & | getVects () const noexcept |
| Get the N vectors. More... | |
| std::array< RealVect, N > & | getVects () noexcept |
| Get the N vectors. More... | |
| Real & | real () |
| Get one of the scalars. More... | |
| const Real & | real () const |
| Get one of the scalars. More... | |
| RealVect & | vect () |
| Get one of the RealVects. More... | |
| const RealVect & | vect () const |
| Get one of the RealVects. More... | |
| bool | operator== (const GenericParticle< M, N > &a_other) const |
| Comparison operator with other particle. More... | |
| bool | operator!= (const GenericParticle< M, N > &a_other) const |
| Comparison operator with other particle. More... | |
| 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 *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. More... | |
| virtual void | linearIn (void *a_buffer) |
| Read a linear binary representation of the internal data. Assumes that the buffer has the correct data. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from GenericParticle< 1, 0 > | |
| 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()
|
inline |
Constructor. Subsequently calls define.
- Parameters
-
[in] a_position Position (in physical space) [in] a_weight Particle weight
Member Function Documentation
◆ define()
|
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
