sofa::component::forcefield::LennardJonesForceField< DataTypes > Class Template Reference

#include <LennardJonesForceField.h>

Inheritance diagram for sofa::component::forcefield::LennardJonesForceField< DataTypes >:

Inheritance graph
[legend]
Collaboration diagram for sofa::component::forcefield::LennardJonesForceField< DataTypes >:

Collaboration graph
[legend]

Data Structures

struct  DForce

Public Types

typedef
sofa::core::componentmodel::behavior::ForceField
< DataTypes > 		Inherit
typedef DataTypes::VecCoord VecCoord
typedef DataTypes::VecDeriv VecDeriv
typedef DataTypes::Coord Coord
typedef DataTypes::Deriv Deriv
typedef Coord::value_type Real

Public Member Functions

 LennardJonesForceField ()
void setAlpha (Real v)
void setBeta (Real v)
void setFMax (Real v)
void setDMax (Real v)
void setD0 (Real v)
void setP0 (Real v)
void setDamping (Real v)
virtual void init ()
 Initialization method called at graph modification, during bottom-up traversal.
virtual void addForce (VecDeriv &f, const VecCoord &x, const VecDeriv &v)
 Given the current position and velocity states, update the current force vector by computing and adding the forces associated with this ForceField.
virtual void addDForce (VecDeriv &df, const VecDeriv &dx)
 Compute the force derivative given a small displacement from the position and velocity used in the previous call to addForce().
virtual double getPotentialEnergy (const VecCoord &x)
 Get the potential energy associated to this ForceField.
void draw ()
 Render internal data of this object, for debugging purposes.

Protected Attributes

Real a
Real b
Data< Real > alpha
Data< Real > beta
Data< Real > dmax
Data< Real > fmax
Data< Real > d0
Data< Real > p0
Data< Real > damping
sofa::helper::vector< DForce > dforces

Detailed Description

template<class DataTypes>
class sofa::component::forcefield::LennardJonesForceField< DataTypes >

Definition at line 42 of file LennardJonesForceField.h.

Member Typedef Documentation

template<class DataTypes >
typedef DataTypes::Coord sofa::component::forcefield::LennardJonesForceField< DataTypes >::Coord

Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 48 of file LennardJonesForceField.h.

template<class DataTypes >
typedef DataTypes::Deriv sofa::component::forcefield::LennardJonesForceField< DataTypes >::Deriv

Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 49 of file LennardJonesForceField.h.

template<class DataTypes >
typedef sofa::core::componentmodel::behavior::ForceField<DataTypes> sofa::component::forcefield::LennardJonesForceField< DataTypes >::Inherit

Definition at line 45 of file LennardJonesForceField.h.

template<class DataTypes >
typedef Coord::value_type sofa::component::forcefield::LennardJonesForceField< DataTypes >::Real

Definition at line 50 of file LennardJonesForceField.h.

template<class DataTypes >
typedef DataTypes::VecCoord sofa::component::forcefield::LennardJonesForceField< DataTypes >::VecCoord

Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 46 of file LennardJonesForceField.h.

template<class DataTypes >
typedef DataTypes::VecDeriv sofa::component::forcefield::LennardJonesForceField< DataTypes >::VecDeriv

Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 47 of file LennardJonesForceField.h.

Constructor & Destructor Documentation

template<class DataTypes >
sofa::component::forcefield::LennardJonesForceField< DataTypes >::LennardJonesForceField (  )  [inline]

Definition at line 67 of file LennardJonesForceField.h.

Member Function Documentation

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::addDForce ( VecDeriv &  df,
const VecDeriv &  dx 
) [inline, virtual]

Compute the force derivative given a small displacement from the position and velocity used in the previous call to addForce().

The derivative should be directly derived from the computations done by addForce. Any forces neglected in addDForce will be integrated explicitly (i.e. using its value at the beginning of the timestep).

If the ForceField can be represented as a matrix, this method computes $ df += K dx $

This method must be implemented by the component, and is usually called by the generic ForceField::addDForce() method.

Deprecated:
to more efficiently accumulate contributions from all terms of the system equation, a new addDForce method allowing to pass two coefficients for the stiffness and damping terms should now be used.

Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 117 of file LennardJonesForceField.inl.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::a, sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::b, sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::df, sofa::component::forcefield::LennardJonesForceField< DataTypes >::dforces, sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), and sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate.

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce ( VecDeriv &  f,
const VecCoord &  x,
const VecDeriv &  v 
) [inline, virtual]

Given the current position and velocity states, update the current force vector by computing and adding the forces associated with this ForceField.

If the ForceField can be represented as a matrix, this method computes $ f += B v + K x $

This method must be implemented by the component, and is usually called by the generic ForceField::addForce() method.

Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 73 of file LennardJonesForceField.inl.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::a, sofa::component::forcefield::LennardJonesForceField< DataTypes >::a, sofa::component::forcefield::LennardJonesForceField< DataTypes >::alpha, sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::b, sofa::component::forcefield::LennardJonesForceField< DataTypes >::b, sofa::component::forcefield::LennardJonesForceField< DataTypes >::beta, sofa::component::forcefield::LennardJonesForceField< DataTypes >::damping, sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::df, sofa::component::forcefield::LennardJonesForceField< DataTypes >::dforces, sofa::component::forcefield::LennardJonesForceField< DataTypes >::dmax, sofa::component::forcefield::LennardJonesForceField< DataTypes >::fmax, force, and sofa::core::objectmodel::Data< T >::getValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::draw (  )  [inline, virtual]

Render internal data of this object, for debugging purposes.

Reimplemented from sofa::core::objectmodel::BaseObject.

Definition at line 143 of file LennardJonesForceField.inl.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::a, sofa::component::forcefield::LennardJonesForceField< DataTypes >::DForce::b, sofa::component::forcefield::LennardJonesForceField< DataTypes >::d0, sofa::component::forcefield::LennardJonesForceField< DataTypes >::dforces, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::Data< T >::getValue(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), sofa::helper::gl::glVertexT(), and sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate.

template<class DataTypes >
double sofa::component::forcefield::LennardJonesForceField< DataTypes >::getPotentialEnergy ( const VecCoord &  x  )  [inline, virtual]

Get the potential energy associated to this ForceField.

Used to extimate the total energy of the system by some post-stabilization techniques.

This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.

Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.

Definition at line 135 of file LennardJonesForceField.inl.

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::init ( void   )  [inline, virtual]

Initialization method called at graph modification, during bottom-up traversal.

Reimplemented from sofa::core::objectmodel::BaseObject.

Definition at line 48 of file LennardJonesForceField.inl.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::a, sofa::component::forcefield::LennardJonesForceField< DataTypes >::alpha, sofa::component::forcefield::LennardJonesForceField< DataTypes >::b, sofa::component::forcefield::LennardJonesForceField< DataTypes >::beta, sofa::component::forcefield::LennardJonesForceField< DataTypes >::d0, sofa::component::forcefield::LennardJonesForceField< DataTypes >::dmax, sofa::core::objectmodel::Data< T >::getValue(), sofa::core::componentmodel::behavior::ForceField< DataTypes >::init(), sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate, and sofa::component::forcefield::LennardJonesForceField< DataTypes >::p0.

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setAlpha ( Real  v  )  [inline]

Definition at line 80 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::alpha, and sofa::core::objectmodel::Data< T >::setValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setBeta ( Real  v  )  [inline]

Definition at line 81 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::beta, and sofa::core::objectmodel::Data< T >::setValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setD0 ( Real  v  )  [inline]

Definition at line 84 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::d0, and sofa::core::objectmodel::Data< T >::setValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setDamping ( Real  v  )  [inline]

Definition at line 86 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::damping, and sofa::core::objectmodel::Data< T >::setValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setDMax ( Real  v  )  [inline]

Definition at line 83 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::dmax, and sofa::core::objectmodel::Data< T >::setValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setFMax ( Real  v  )  [inline]

Definition at line 82 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::fmax, and sofa::core::objectmodel::Data< T >::setValue().

template<class DataTypes >
void sofa::component::forcefield::LennardJonesForceField< DataTypes >::setP0 ( Real  v  )  [inline]

Definition at line 85 of file LennardJonesForceField.h.

References sofa::component::forcefield::LennardJonesForceField< DataTypes >::p0, and sofa::core::objectmodel::Data< T >::setValue().

Field Documentation

template<class DataTypes >
Real sofa::component::forcefield::LennardJonesForceField< DataTypes >::a [protected]

Definition at line 53 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::init().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::alpha [protected]

Definition at line 54 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), sofa::component::forcefield::LennardJonesForceField< DataTypes >::init(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setAlpha().

template<class DataTypes >
Real sofa::component::forcefield::LennardJonesForceField< DataTypes >::b [protected]

Definition at line 53 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::init().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::beta [protected]

Definition at line 54 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), sofa::component::forcefield::LennardJonesForceField< DataTypes >::init(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setBeta().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::d0 [protected]

Definition at line 55 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::draw(), sofa::component::forcefield::LennardJonesForceField< DataTypes >::init(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setD0().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::damping [protected]

Definition at line 56 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setDamping().

template<class DataTypes >
sofa::helper::vector<DForce> sofa::component::forcefield::LennardJonesForceField< DataTypes >::dforces [protected]

Definition at line 64 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addDForce(), sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::draw().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::dmax [protected]

Definition at line 54 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), sofa::component::forcefield::LennardJonesForceField< DataTypes >::init(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setDMax().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::fmax [protected]

Definition at line 54 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::addForce(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setFMax().

template<class DataTypes >
Data<Real> sofa::component::forcefield::LennardJonesForceField< DataTypes >::p0 [protected]

Definition at line 55 of file LennardJonesForceField.h.

Referenced by sofa::component::forcefield::LennardJonesForceField< DataTypes >::init(), and sofa::component::forcefield::LennardJonesForceField< DataTypes >::setP0().

The documentation for this class was generated from the following files:
Generated on Sun Nov 23 04:18:45 2008 for Sofa by  doxygen 1.5.7.1