Public Types | Public Member Functions | Protected Attributes

OpenTissue::mbd::Damping< mbd_types > Class Template Reference

#include <mbd_damping.h>

Inheritance diagram for OpenTissue::mbd::Damping< mbd_types >:
OpenTissue::mbd::ForceInterface< mbd_types >

List of all members.

Public Types

typedef mbd_types::body_type body_type
typedef
mbd_types::math_policy::real_type 
real_type
typedef
mbd_types::math_policy::vector3_type 
vector3_type

Public Member Functions

 Damping ()
virtual ~Damping ()
void compute (body_type const &body, vector3_type &force, vector3_type &torque)
void set_linear_viscosity (real_type const &viscosity)
void set_angular_viscosity (real_type const &viscosity)
real_type const & get_linear_viscosity () const
real_type const & get_angular_viscosity () const

Protected Attributes

real_type m_linear_viscosity
 Linear Viscosity Coefficient.
real_type m_angular_viscosity
 Angular Viscosity Coefficient.

template<typename mbd_types>
class OpenTissue::mbd::Damping< mbd_types >


Member Typedef Documentation

template<typename mbd_types >
typedef mbd_types::body_type OpenTissue::mbd::Damping< mbd_types >::body_type
template<typename mbd_types >
typedef mbd_types::math_policy::real_type OpenTissue::mbd::Damping< mbd_types >::real_type

Constructor & Destructor Documentation

template<typename mbd_types >
OpenTissue::mbd::Damping< mbd_types >::Damping (  )  [inline]
template<typename mbd_types >
virtual OpenTissue::mbd::Damping< mbd_types >::~Damping (  )  [inline, virtual]

Member Function Documentation

template<typename mbd_types >
void OpenTissue::mbd::Damping< mbd_types >::compute ( body_type const &  body,
vector3_type force,
vector3_type torque 
) [inline]

Compute Damping force_type

Parameters:
body The body on which the damping froce should be applied.
force Upon return this argument holds the linear damping force that should be applied to the body.
torque Upon return this argument holds the damping torque that should be applied to the body.
template<typename mbd_types >
real_type const& OpenTissue::mbd::Damping< mbd_types >::get_angular_viscosity (  )  const [inline]

Retrieve Angular Viscosity.

Returns:
The current value of the angular viscosity.
template<typename mbd_types >
real_type const& OpenTissue::mbd::Damping< mbd_types >::get_linear_viscosity (  )  const [inline]

Retrieve Linear Viscosity.

Returns:
The current value of the linear viscosity.
template<typename mbd_types >
void OpenTissue::mbd::Damping< mbd_types >::set_angular_viscosity ( real_type const &  viscosity  )  [inline]

Set Angular Viscosity.

Parameters:
viscosity The new viscosity value, must be a non-negative value.
template<typename mbd_types >
void OpenTissue::mbd::Damping< mbd_types >::set_linear_viscosity ( real_type const &  viscosity  )  [inline]

Set Linear Viscosity.

Parameters:
viscosity The new viscosity value, must be a non-negative value.

Member Data Documentation

template<typename mbd_types >
real_type OpenTissue::mbd::Damping< mbd_types >::m_angular_viscosity [protected]

Angular Viscosity Coefficient.

template<typename mbd_types >
real_type OpenTissue::mbd::Damping< mbd_types >::m_linear_viscosity [protected]

Linear Viscosity Coefficient.


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