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

#include <Particle.h>

Public Member Functions

 Particle ()
 
 Particle (const vtkm::Vec3f &p, const vtkm::Id &id, const vtkm::Id &numSteps=0, const vtkm::ParticleStatus &status=vtkm::ParticleStatus(), const vtkm::FloatDefault &time=0)
 
 Particle (const vtkm::Particle &p)
 
vtkm::Particleoperator= (const vtkm::Particle &)=default
 
 ~Particle () 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::Vec3f Velocity (const vtkm::VecVariable< vtkm::Vec3f, 2 > &vectors, const vtkm::FloatDefault &) 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
 

Friends

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

Constructor & Destructor Documentation

◆ Particle() [1/3]

vtkm::Particle::Particle ( )
inline

◆ Particle() [2/3]

vtkm::Particle::Particle ( const vtkm::Vec3f p,
const vtkm::Id id,
const vtkm::Id numSteps = 0,
const vtkm::ParticleStatus status = vtkm::ParticleStatus(),
const vtkm::FloatDefault time = 0 
)
inline

◆ Particle() [3/3]

vtkm::Particle::Particle ( const vtkm::Particle p)
inline

◆ ~Particle()

vtkm::Particle::~Particle ( )
inlinenoexcept

Member Function Documentation

◆ GetEvaluationPosition()

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

◆ GetID()

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

◆ GetNumberOfSteps()

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

◆ GetPosition()

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

◆ GetStatus() [1/2]

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

◆ GetStatus() [2/2]

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

◆ GetTime()

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

◆ operator=()

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

◆ SetID()

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

◆ SetNumberOfSteps()

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

◆ SetPosition()

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

◆ SetStatus()

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

◆ SetTime()

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

◆ Sizeof()

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

◆ Velocity()

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

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ ID

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

◆ NumSteps

vtkm::Id vtkm::Particle::NumSteps = 0
private

◆ Position

vtkm::Vec3f vtkm::Particle::Position
private

◆ Status

vtkm::ParticleStatus vtkm::Particle::Status
private

◆ Time

vtkm::FloatDefault vtkm::Particle::Time = 0
private

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