Public Types | Public Member Functions | Protected Attributes

OpenTissue::psys::Particle< types > Class Template Reference

#include <psys_particle.h>

Inheritance diagram for OpenTissue::psys::Particle< types >:
OpenTissue::psys::ConnectorFacade< types >

List of all members.

Public Types

typedef types::math_types math_types
typedef math_types::real_type real_type
typedef math_types::vector3_type vector3_type
typedef types::system_type system_type

Public Member Functions

 Particle ()
void bind (vector3_type const &r)
void release ()
vector3_typeposition ()
vector3_type const & position () const
vector3_typeold_position ()
vector3_type const & old_position () const
vector3_typevelocity ()
vector3_type const & velocity () const
vector3_typeforce ()
vector3_type const & force () const
vector3_typeacceleration ()
vector3_type const & acceleration () const
real_typeinv_mass ()
real_type const & inv_mass () const
real_typemass ()
real_type const & mass () const

Protected Attributes

bool m_coupled
 Boolean flag indicating whether the particle position is coupled. Default is false.
vector3_typem_ptr_r
vector3_type m_r
 A binding to the current position.
vector3_type m_old_r
 The old position (ie. in last iteration of the particle system the particle is in).
vector3_type m_v
 The current velocity.
vector3_type m_f
 Total Force (Accumulator).
vector3_type m_a
 Total acceleration. (F = m a -> a = F/m).
real_type m_inv_mass
 Inverse mass (a value of 0 means a fixed particle).
real_type m_mass
 The mass (a value of infinity means a fixed particle).

template<typename types>
class OpenTissue::psys::Particle< types >


Member Typedef Documentation

template<typename types >
typedef types::math_types OpenTissue::psys::Particle< types >::math_types
template<typename types >
typedef math_types::real_type OpenTissue::psys::Particle< types >::real_type
template<typename types >
typedef types::system_type OpenTissue::psys::Particle< types >::system_type

Constructor & Destructor Documentation

template<typename types >
OpenTissue::psys::Particle< types >::Particle (  )  [inline]

Member Function Documentation

template<typename types >
vector3_type& OpenTissue::psys::Particle< types >::acceleration (  )  [inline]
template<typename types >
vector3_type const& OpenTissue::psys::Particle< types >::acceleration (  )  const [inline]
template<typename types >
void OpenTissue::psys::Particle< types >::bind ( vector3_type const &  r  )  [inline]
template<typename types >
vector3_type& OpenTissue::psys::Particle< types >::force (  )  [inline]
template<typename types >
vector3_type const& OpenTissue::psys::Particle< types >::force (  )  const [inline]
template<typename types >
real_type& OpenTissue::psys::Particle< types >::inv_mass (  )  [inline]
template<typename types >
real_type const& OpenTissue::psys::Particle< types >::inv_mass (  )  const [inline]
template<typename types >
real_type const& OpenTissue::psys::Particle< types >::mass (  )  const [inline]
template<typename types >
real_type& OpenTissue::psys::Particle< types >::mass (  )  [inline]
template<typename types >
vector3_type& OpenTissue::psys::Particle< types >::old_position (  )  [inline]
template<typename types >
vector3_type const& OpenTissue::psys::Particle< types >::old_position (  )  const [inline]
template<typename types >
vector3_type const& OpenTissue::psys::Particle< types >::position (  )  const [inline]
template<typename types >
vector3_type& OpenTissue::psys::Particle< types >::position (  )  [inline]
template<typename types >
void OpenTissue::psys::Particle< types >::release (  )  [inline]
template<typename types >
vector3_type const& OpenTissue::psys::Particle< types >::velocity (  )  const [inline]
template<typename types >
vector3_type& OpenTissue::psys::Particle< types >::velocity (  )  [inline]

Member Data Documentation

template<typename types >
vector3_type OpenTissue::psys::Particle< types >::m_a [protected]

Total acceleration. (F = m a -> a = F/m).

template<typename types >
bool OpenTissue::psys::Particle< types >::m_coupled [protected]

Boolean flag indicating whether the particle position is coupled. Default is false.

template<typename types >
vector3_type OpenTissue::psys::Particle< types >::m_f [protected]

Total Force (Accumulator).

template<typename types >
real_type OpenTissue::psys::Particle< types >::m_inv_mass [protected]

Inverse mass (a value of 0 means a fixed particle).

template<typename types >
real_type OpenTissue::psys::Particle< types >::m_mass [protected]

The mass (a value of infinity means a fixed particle).

template<typename types >
vector3_type OpenTissue::psys::Particle< types >::m_old_r [protected]

The old position (ie. in last iteration of the particle system the particle is in).

template<typename types >
vector3_type* OpenTissue::psys::Particle< types >::m_ptr_r [protected]
template<typename types >
vector3_type OpenTissue::psys::Particle< types >::m_r [protected]

A binding to the current position.

template<typename types >
vector3_type OpenTissue::psys::Particle< types >::m_v [protected]

The current velocity.


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