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

#include <Particle.h>

Public Member Functions

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

Friends

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

Constructor & Destructor Documentation

◆ Particle() [1/3]

viskores::Particle::Particle ( )
inline

◆ Particle() [2/3]

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

◆ Particle() [3/3]

viskores::Particle::Particle ( const viskores::Particle p)
inline

◆ ~Particle()

viskores::Particle::~Particle ( )
inlinenoexcept

Member Function Documentation

◆ GetEvaluationPosition()

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

◆ GetID()

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

◆ GetNumberOfSteps()

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

◆ GetPosition()

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

◆ GetStatus() [1/2]

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

◆ GetStatus() [2/2]

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

◆ GetTime()

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

◆ operator=()

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

◆ SetID()

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

◆ SetNumberOfSteps()

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

◆ SetPosition()

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

◆ SetStatus()

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

◆ SetTime()

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

◆ Sizeof()

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

◆ Velocity()

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

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ ID

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

◆ NumSteps

viskores::Id viskores::Particle::NumSteps = 0
private

◆ Position

viskores::Vec3f viskores::Particle::Position
private

◆ Status

viskores::ParticleStatus viskores::Particle::Status
private

◆ Time

viskores::FloatDefault viskores::Particle::Time = 0
private

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