Viskores  1.0
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
viskores::ChargedParticle Class Reference

#include <Particle.h>

Public Member Functions

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

Static Public Member Functions

static size_t Sizeof ()
 

Private Attributes

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

Static Private Attributes

constexpr static viskores::FloatDefault SPEED_OF_LIGHT
 

Friends

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

Constructor & Destructor Documentation

◆ ChargedParticle() [1/3]

viskores::ChargedParticle::ChargedParticle ( )
inline

◆ ChargedParticle() [2/3]

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

◆ ChargedParticle() [3/3]

viskores::ChargedParticle::ChargedParticle ( const viskores::ChargedParticle other)
inline

◆ ~ChargedParticle()

viskores::ChargedParticle::~ChargedParticle ( )
inlinenoexcept

Member Function Documentation

◆ Gamma()

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

◆ GetEvaluationPosition()

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

◆ GetID()

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

◆ GetNumberOfSteps()

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

◆ GetPosition()

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

◆ GetStatus() [1/2]

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

◆ GetStatus() [2/2]

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

◆ GetTime()

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

◆ operator=()

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

◆ SetID()

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

◆ SetNumberOfSteps()

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

◆ SetPosition()

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

◆ SetStatus()

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

◆ SetTime()

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

◆ Sizeof()

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

◆ Velocity()

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

Friends And Related Function Documentation

◆ mangled_diy_namespace::Serialization< viskores::ChargedParticle >

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

◆ operator<<

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

Member Data Documentation

◆ Charge

viskores::Float64 viskores::ChargedParticle::Charge
private

◆ ID

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

◆ Mass

viskores::Float64 viskores::ChargedParticle::Mass
private

◆ Momentum

viskores::Vec3f viskores::ChargedParticle::Momentum
mutableprivate

◆ NumSteps

viskores::Id viskores::ChargedParticle::NumSteps = 0
private

◆ Position

viskores::Vec3f viskores::ChargedParticle::Position
private

◆ SPEED_OF_LIGHT

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

◆ Status

viskores::ParticleStatus viskores::ChargedParticle::Status
private

◆ Time

viskores::FloatDefault viskores::ChargedParticle::Time = 0
private

◆ Weighting

viskores::Float64 viskores::ChargedParticle::Weighting
private

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