VTK-m  2.2
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
vtkm::ChargedParticle Class Reference

#include <Particle.h>

Public Member Functions

 ChargedParticle ()
 
 ChargedParticle (const vtkm::Vec3f &position, const vtkm::Id &id, const vtkm::Float64 &mass, const vtkm::Float64 &charge, const vtkm::Float64 &weighting, const vtkm::Vec3f &momentum, const vtkm::Id &numSteps=0, const vtkm::ParticleStatus &status=vtkm::ParticleStatus(), const vtkm::FloatDefault &time=0)
 
 ChargedParticle (const vtkm::ChargedParticle &other)
 
vtkm::ChargedParticleoperator= (const vtkm::ChargedParticle &)=default
 
 ~ChargedParticle () noexcept
 
const vtkm::Vec3fGetPosition () const
 
void SetPosition (const vtkm::Vec3f &position)
 
vtkm::Id GetID () const
 
void SetID (vtkm::Id id)
 
vtkm::Id GetNumberOfSteps () const
 
void SetNumberOfSteps (vtkm::Id numSteps)
 
vtkm::ParticleStatus GetStatus () const
 
vtkm::ParticleStatusGetStatus ()
 
void SetStatus (vtkm::ParticleStatus status)
 
vtkm::FloatDefault GetTime () const
 
void SetTime (vtkm::FloatDefault time)
 
vtkm::Float64 Gamma (const vtkm::Vec3f &momentum, bool reciprocal=false) const
 
vtkm::Vec3f Velocity (const vtkm::VecVariable< vtkm::Vec3f, 2 > &vectors, const vtkm::FloatDefault &length) const
 
vtkm::Vec3f GetEvaluationPosition (const vtkm::FloatDefault &deltaT) const
 

Static Public Member Functions

static size_t Sizeof ()
 

Private Attributes

vtkm::Vec3f Position
 
vtkm::Id ID = -1
 
vtkm::Id NumSteps = 0
 
vtkm::ParticleStatus Status
 
vtkm::FloatDefault Time = 0
 
vtkm::Float64 Mass
 
vtkm::Float64 Charge
 
vtkm::Float64 Weighting
 
vtkm::Vec3f Momentum
 

Static Private Attributes

constexpr static vtkm::FloatDefault SPEED_OF_LIGHT
 

Friends

struct mangled_diy_namespace::Serialization< vtkm::ChargedParticle >
 
std::ostream & operator<< (std::ostream &out, const vtkm::ChargedParticle &p)
 

Constructor & Destructor Documentation

◆ ChargedParticle() [1/3]

vtkm::ChargedParticle::ChargedParticle ( )
inline

◆ ChargedParticle() [2/3]

vtkm::ChargedParticle::ChargedParticle ( const vtkm::Vec3f position,
const vtkm::Id id,
const vtkm::Float64 mass,
const vtkm::Float64 charge,
const vtkm::Float64 weighting,
const vtkm::Vec3f momentum,
const vtkm::Id numSteps = 0,
const vtkm::ParticleStatus status = vtkm::ParticleStatus(),
const vtkm::FloatDefault time = 0 
)
inline

◆ ChargedParticle() [3/3]

vtkm::ChargedParticle::ChargedParticle ( const vtkm::ChargedParticle other)
inline

◆ ~ChargedParticle()

vtkm::ChargedParticle::~ChargedParticle ( )
inlinenoexcept

Member Function Documentation

◆ Gamma()

vtkm::Float64 vtkm::ChargedParticle::Gamma ( const vtkm::Vec3f momentum,
bool  reciprocal = false 
) const
inline

◆ GetEvaluationPosition()

vtkm::Vec3f vtkm::ChargedParticle::GetEvaluationPosition ( const vtkm::FloatDefault deltaT) const
inline

◆ GetID()

vtkm::Id vtkm::ChargedParticle::GetID ( ) const
inline

◆ GetNumberOfSteps()

vtkm::Id vtkm::ChargedParticle::GetNumberOfSteps ( ) const
inline

◆ GetPosition()

const vtkm::Vec3f& vtkm::ChargedParticle::GetPosition ( ) const
inline

◆ GetStatus() [1/2]

vtkm::ParticleStatus& vtkm::ChargedParticle::GetStatus ( )
inline

◆ GetStatus() [2/2]

vtkm::ParticleStatus vtkm::ChargedParticle::GetStatus ( ) const
inline

◆ GetTime()

vtkm::FloatDefault vtkm::ChargedParticle::GetTime ( ) const
inline

◆ operator=()

vtkm::ChargedParticle& vtkm::ChargedParticle::operator= ( const vtkm::ChargedParticle )
default

◆ SetID()

void vtkm::ChargedParticle::SetID ( vtkm::Id  id)
inline

◆ SetNumberOfSteps()

void vtkm::ChargedParticle::SetNumberOfSteps ( vtkm::Id  numSteps)
inline

◆ SetPosition()

void vtkm::ChargedParticle::SetPosition ( const vtkm::Vec3f position)
inline

◆ SetStatus()

void vtkm::ChargedParticle::SetStatus ( vtkm::ParticleStatus  status)
inline

◆ SetTime()

void vtkm::ChargedParticle::SetTime ( vtkm::FloatDefault  time)
inline

◆ Sizeof()

static size_t vtkm::ChargedParticle::Sizeof ( )
inlinestatic

◆ Velocity()

vtkm::Vec3f vtkm::ChargedParticle::Velocity ( const vtkm::VecVariable< vtkm::Vec3f, 2 > &  vectors,
const vtkm::FloatDefault length 
) const
inline

Friends And Related Function Documentation

◆ mangled_diy_namespace::Serialization< vtkm::ChargedParticle >

friend struct mangled_diy_namespace::Serialization< vtkm::ChargedParticle >
friend

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const vtkm::ChargedParticle p 
)
friend

Member Data Documentation

◆ Charge

vtkm::Float64 vtkm::ChargedParticle::Charge
private

◆ ID

vtkm::Id vtkm::ChargedParticle::ID = -1
private

◆ Mass

vtkm::Float64 vtkm::ChargedParticle::Mass
private

◆ Momentum

vtkm::Vec3f vtkm::ChargedParticle::Momentum
mutableprivate

◆ NumSteps

vtkm::Id vtkm::ChargedParticle::NumSteps = 0
private

◆ Position

vtkm::Vec3f vtkm::ChargedParticle::Position
private

◆ SPEED_OF_LIGHT

constexpr static vtkm::FloatDefault vtkm::ChargedParticle::SPEED_OF_LIGHT
staticconstexprprivate
Initial value:
=
static_cast<vtkm::FloatDefault>(2.99792458e8)

◆ Status

vtkm::ParticleStatus vtkm::ChargedParticle::Status
private

◆ Time

vtkm::FloatDefault vtkm::ChargedParticle::Time = 0
private

◆ Weighting

vtkm::Float64 vtkm::ChargedParticle::Weighting
private

The documentation for this class was generated from the following file:
vtkm::FloatDefault
vtkm::Float32 FloatDefault
The floating point type to use when no other precision is specified.
Definition: Types.h:236