sofa::filemanager::pml::LMLForce< DataTypes > Class Template Reference

#include <LMLForce.h>

Inheritance diagram for sofa::filemanager::pml::LMLForce< DataTypes >:

Collaboration diagram for sofa::filemanager::pml::LMLForce< DataTypes >:


Public Types
typedef DataTypes::VecCoord	VecCoord
	template types
typedef DataTypes::VecDeriv	VecDeriv
typedef DataTypes::VecCoord::iterator	VecCoordIterator
typedef DataTypes::VecDeriv::iterator	VecDerivIterator
typedef DataTypes::Coord	Coord
typedef DataTypes::Deriv	Deriv
Public Member Functions
	LMLForce (MechanicalState< DataTypes > *mm=NULL)
	constructors
	LMLForce (Loads loadsList, const map< unsigned int, unsigned int > &atomIndexToDOFIndex, MechanicalState< DataTypes > mm)
	~LMLForce ()
std::vector< unsigned int >	getTargets ()
	return targets list
void	addTarget (unsigned int i)
	add a new target (dof index)
virtual void	addForce (VecDeriv &f, const VecCoord &x, const VecDeriv &v)
	-- ForceField Inherits
virtual void	addDForce (VecDeriv &, const VecDeriv &)
	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 &)
	Get the potential energy associated to this ForceField.
void	draw ()
	-- VisualModel interface
void	initTextures ()
	Initialize the textures, or other graphical resources.
void	update ()
	used to update the model if necessary.
Protected Attributes
MechanicalState< DataTypes > *	mmodel
std::vector< unsigned int >	targets
	list of forces targets
VecDeriv	forces
	list of force directions
Loads *	loads
	LML loads.
map< unsigned int, unsigned int >	atomToDOFIndexes
	link between PML object indexes and sofa dofs indexs

Detailed Description

template<class DataTypes>
class sofa::filemanager::pml::LMLForce< DataTypes >

Definition at line 68 of file LMLForce.h.

Member Typedef Documentation

template<class DataTypes >

typedef DataTypes::Coord sofa::filemanager::pml::LMLForce< DataTypes >::Coord

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

Definition at line 76 of file LMLForce.h.

template<class DataTypes >

typedef DataTypes::Deriv sofa::filemanager::pml::LMLForce< DataTypes >::Deriv

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

Definition at line 77 of file LMLForce.h.

template<class DataTypes >

typedef DataTypes::VecCoord sofa::filemanager::pml::LMLForce< DataTypes >::VecCoord

template types

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

Definition at line 72 of file LMLForce.h.

template<class DataTypes >

typedef DataTypes::VecCoord::iterator sofa::filemanager::pml::LMLForce< DataTypes >::VecCoordIterator

Definition at line 74 of file LMLForce.h.

template<class DataTypes >

typedef DataTypes::VecDeriv sofa::filemanager::pml::LMLForce< DataTypes >::VecDeriv

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

Definition at line 73 of file LMLForce.h.

template<class DataTypes >

typedef DataTypes::VecDeriv::iterator sofa::filemanager::pml::LMLForce< DataTypes >::VecDerivIterator

Definition at line 75 of file LMLForce.h.

Constructor & Destructor Documentation

template<class DataTypes >

sofa::filemanager::pml::LMLForce< DataTypes >::LMLForce ( MechanicalState< DataTypes > * mm = NULL ) [inline]

constructors

Definition at line 80 of file LMLForce.h.

template<class DataTypes >

sofa::filemanager::pml::LMLForce< DataTypes >::LMLForce	(	Loads *	loadsList,
		const map< unsigned int, unsigned int > &	atomIndexToDOFIndex,
		MechanicalState< DataTypes > *	mm
	)			`[inline]`

Definition at line 45 of file LMLForce.inl.

References sofa::filemanager::pml::LMLForce< DataTypes >::forces, sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), sofa::filemanager::pml::LMLForce< DataTypes >::loads, sofa::filemanager::pml::LMLForce< DataTypes >::mmodel, sofa::core::objectmodel::Base::setName(), and sofa::filemanager::pml::LMLForce< DataTypes >::targets.

template<class DataTypes >

sofa::filemanager::pml::LMLForce< DataTypes >::~LMLForce ( ) [inline]

Definition at line 85 of file LMLForce.h.

Member Function Documentation

template<class DataTypes >

virtual void sofa::filemanager::pml::LMLForce< 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 95 of file LMLForce.h.

template<class DataTypes >