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

Compute Finite Element forces based on hexahedral elements. More...

#include <HexahedralFEMForceField.h>

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

Collaboration diagram for sofa::component::forcefield::HexahedralFEMForceField< DataTypes >:


Data Structures
class	HexahedronInformation
	the information stored for each hexahedron More...
Public Types
typedef DataTypes::VecCoord	VecCoord
typedef DataTypes::VecDeriv	VecDeriv
typedef VecCoord	Vector
typedef DataTypes::Coord	Coord
typedef DataTypes::Deriv	Deriv
typedef Coord::value_type	Real
typedef core::componentmodel::topology::BaseMeshTopology::index_type	Index
typedef core::componentmodel::topology::BaseMeshTopology::Cube	Element
typedef core::componentmodel::topology::BaseMeshTopology::SeqCubes	VecElement
Public Member Functions
	HexahedralFEMForceField ()
void	parse (core::objectmodel::BaseObjectDescription *arg)
	Parse the given description to assign values to this object's fields and potentially other parameters.
void	setPoissonRatio (Real val)
void	setYoungModulus (Real val)
void	setMethod (int val)
void	setComputeGlobalMatrix (bool val)
virtual void	init ()
	Initialization method called at graph modification, during bottom-up traversal.
virtual void	reinit ()
	Update method called when variables used in precomputation are modified.
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.
virtual void	handleTopologyChange ()
	Handle topological Changes.
void	draw ()
	Render internal data of this object, for debugging purposes.
Data Fields
int	method
Data< std::string >	f_method
	the computation method of the displacements
Data< Real >	f_poissonRatio
Data< Real >	f_youngModulus
Data< bool >	f_assembling
Static Public Attributes
static const int	LARGE = 0
	Symbol of large displacements hexahedron solver.
static const int	POLAR = 1
	Symbol of polar displacements hexahedron solver.
Protected Types
typedef Vec< 24, Real >	Displacement
	the displacement vector
typedef Mat< 6, 6, Real >	MaterialStiffness
	the matrix of material stiffness
typedef vector< MaterialStiffness >	VecMaterialStiffness
	a vector of material stiffness matrices
typedef Mat< 24, 24, Real >	ElementStiffness
typedef vector< ElementStiffness >	VecElementStiffness
typedef Mat< 3, 3, Real >	Mat33
typedef Mat33	Transformation
	matrix for rigid transformations like rotations
typedef std::pair< int, Real >	Col_Value
typedef vector< Col_Value >	CompressedValue
typedef vector< CompressedValue >	CompressedMatrix
Protected Member Functions
virtual void	computeElementStiffness (ElementStiffness &K, const MaterialStiffness &M, const Vec< 8, Coord > &nodes, const int elementIndice)
Mat33	integrateStiffness (int signx0, int signy0, int signz0, int signx1, int signy1, int signz1, const Real u, const Real v, const Real w, const Mat33 &J_1)
void	computeMaterialStiffness (int i)
void	computeForce (Displacement &F, const Displacement &Depl, const ElementStiffness &K)
void	initLarge (int i)
void	computeRotationLarge (Transformation &r, Coord &edgex, Coord &edgey)
virtual void	accumulateForceLarge (Vector &f, const Vector &p, int i)
void	initPolar (int i)
void	computeRotationPolar (Transformation &r, Vec< 8, Coord > &nodes)
virtual void	accumulateForcePolar (Vector &f, const Vector &p, int i)
Static Protected Member Functions
static void	FHexahedronCreationFunction (int, void *, HexahedronInformation &, const Hexahedron &, const helper::vector< unsigned int > &, const helper::vector< double > &)
	the callback function called when a hexahedron is created
Protected Attributes
HexahedronData < HexahedronInformation >	hexahedronInfo
	container that stotes all requires information for each hexahedron
double	m_potentialEnergy
sofa::core::componentmodel::topology::BaseMeshTopology *	_topology
Mat< 8, 3, int >	_coef
	coef of each vertices to compute the strain stress matrix
bool	_alreadyInit

Detailed Description

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

Compute Finite Element forces based on hexahedral elements.

Corotational hexahedron from {NMPCPF05, author = "Nesme, Matthieu and Marchal, Maud and Promayon, Emmanuel and Chabanas, Matthieu and Payan, Yohan and Faure, Fran\c{c}ois", title = "Physically Realistic Interactive Simulation for Biological Soft Tissues", journal = "Recent Research Developments in Biomechanics", volume = "2", year = "2005", keywords = "surgical simulation physical animation truth cube", url = "http://www-evasion.imag.fr/Publications/2005/NMPCPF05" }

indices ordering (same as in HexahedronSetTopology):

Y 7---------6 ^ / /| |/ Z / | 3----^----2 | | / | | | 4------|--5 | / | / |/ |/ 0---------1-->X

Definition at line 78 of file HexahedralFEMForceField.h.

Member Typedef Documentation

template<class DataTypes >

typedef std::pair<int,Real> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Col_Value [protected]

Definition at line 138 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef vector< CompressedValue > sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::CompressedMatrix [protected]

Definition at line 140 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef vector< Col_Value > sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::CompressedValue [protected]

Definition at line 139 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef DataTypes::Coord sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Coord

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

Definition at line 84 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef DataTypes::Deriv sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Deriv

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

Definition at line 85 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef Vec<24, Real> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Displacement [protected]

the displacement vector

Definition at line 102 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef core::componentmodel::topology::BaseMeshTopology::Cube sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Element

Definition at line 93 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef Mat<24, 24, Real> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::ElementStiffness [protected]

Definition at line 108 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef core::componentmodel::topology::BaseMeshTopology::index_type sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Index

Definition at line 88 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef Mat<3, 3, Real> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Mat33 [protected]

Definition at line 112 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef Mat<6, 6, Real> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::MaterialStiffness [protected]

the matrix of material stiffness

Definition at line 104 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef Coord::value_type sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Real

Definition at line 86 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef Mat33 sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Transformation [protected]

matrix for rigid transformations like rotations

Definition at line 113 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef DataTypes::VecCoord sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::VecCoord

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

Definition at line 81 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef DataTypes::VecDeriv sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::VecDeriv

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

Definition at line 82 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef core::componentmodel::topology::BaseMeshTopology::SeqCubes sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::VecElement

Definition at line 94 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef vector<ElementStiffness> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::VecElementStiffness [protected]

Definition at line 109 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef vector<MaterialStiffness> sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::VecMaterialStiffness [protected]

a vector of material stiffness matrices

Definition at line 105 of file HexahedralFEMForceField.h.

template<class DataTypes >

typedef VecCoord sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::Vector

Definition at line 83 of file HexahedralFEMForceField.h.

Constructor & Destructor Documentation

template<class DataTypes >

sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::HexahedralFEMForceField ( ) [inline]

Definition at line 164 of file HexahedralFEMForceField.h.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_alreadyInit, and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_coef.

Member Function Documentation

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForceLarge	(	Vector &	f,
		const Vector &	p,
		int	i
	)			`[inline, protected, virtual]`

Definition at line 642 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeForce(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeRotationLarge(), sofa::core::componentmodel::topology::BaseMeshTopology::getHexa(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::addForce().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForcePolar	(	Vector &	f,
		const Vector &	p,
		int	i
	)			`[inline, protected, virtual]`

Definition at line 752 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeForce(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeRotationPolar(), sofa::core::componentmodel::topology::BaseMeshTopology::getHexa(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::addForce().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< 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 258 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeForce(), sofa::core::componentmodel::topology::BaseMeshTopology::getHexa(), sofa::core::componentmodel::topology::BaseMeshTopology::getNbHexas(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo.

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< 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 231 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForceLarge(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForcePolar(), sofa::core::componentmodel::topology::BaseMeshTopology::getNbHexas(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::LARGE, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::method, and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::POLAR.

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeElementStiffness	(	ElementStiffness &	K,
		const MaterialStiffness &	M,
		const Vec< 8, Coord > &	nodes,
		const int	elementIndice
	)			`[inline, protected, virtual]`

Definition at line 313 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_coef, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::integrateStiffness(), and norm().

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initLarge(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initPolar().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeForce	(	Displacement &	F,
		const Displacement &	Depl,
		const ElementStiffness &	K
	)			`[inline, protected]`

Definition at line 553 of file HexahedralFEMForceField.inl.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForceLarge(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForcePolar(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::addDForce().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeMaterialStiffness ( int i ) [inline, protected]

Definition at line 534 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::f_poissonRatio, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::f_youngModulus, sofa::core::objectmodel::Data< T >::getValue(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::FHexahedronCreationFunction().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeRotationLarge	(	Transformation &	r,
		Coord &	edgex,
		Coord &	edgey
	)			`[inline, protected]`

Definition at line 605 of file HexahedralFEMForceField.inl.

References cross().

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForceLarge(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initLarge().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeRotationPolar	(	Transformation &	r,
		Vec< 8, Coord > &	nodes
	)			`[inline, protected]`

Definition at line 723 of file HexahedralFEMForceField.inl.

References sofa::helper::polar_decomp().

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::accumulateForcePolar(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initPolar().

template<class DataTypes >

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

Render internal data of this object, for debugging purposes.

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

Definition at line 809 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::componentmodel::topology::BaseMeshTopology::getHexa(), sofa::core::componentmodel::topology::BaseMeshTopology::getNbHexas(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), sofa::helper::gl::glVertexT(), and sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate.

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::FHexahedronCreationFunction	(	int	hexahedronIndex,
		void *	param,
		HexahedronInformation &	,
		const Hexahedron &	,
		const helper::vector< unsigned int > &	,
		const helper::vector< double > &
	)			`[inline, static, protected]`

the callback function called when a hexahedron is created

Definition at line 72 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeMaterialStiffness(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initLarge(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initPolar(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::LARGE, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::method, and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::POLAR.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::reinit().

template<class DataTypes >

double sofa::component::forcefield::HexahedralFEMForceField< 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 293 of file HexahedralFEMForceField.inl.

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::handleTopologyChange ( ) [inline, virtual]

Handle topological Changes.

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

Definition at line 104 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::core::componentmodel::topology::BaseMeshTopology::firstChange(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo, and sofa::core::componentmodel::topology::BaseMeshTopology::lastChange().

template<class DataTypes >

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

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

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

Definition at line 115 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_alreadyInit, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::BaseContext::getMeshTopology(), sofa::core::componentmodel::topology::BaseMeshTopology::getNbHexas(), and sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::reinit().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initLarge ( int i ) [inline, protected]

Definition at line 573 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeElementStiffness(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeRotationLarge(), sofa::core::componentmodel::topology::BaseMeshTopology::getHexa(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX0(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo, and sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::FHexahedronCreationFunction().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::initPolar ( int i ) [inline, protected]

Definition at line 699 of file HexahedralFEMForceField.inl.

References sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::_topology, sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeElementStiffness(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeRotationPolar(), sofa::core::componentmodel::topology::BaseMeshTopology::getHexa(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX0(), sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::hexahedronInfo, and sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::FHexahedronCreationFunction().

template<class DataTypes >

HexahedralFEMForceField< DataTypes >::Mat33 sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::integrateStiffness	(	int	signx0,
		int	signy0,
		int	signz0,
		int	signx1,
		int	signy1,
		int	signz1,
		const Real	u,
		const Real	v,
		const Real	w,
		const Mat33 &	J_1
	)			`[inline, protected]`

Definition at line 369 of file HexahedralFEMForceField.inl.

Referenced by sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::computeElementStiffness().

template<class DataTypes >

void sofa::component::forcefield::HexahedralFEMForceField< DataTypes >::parse ( core::objectmodel::BaseObjectDescription * arg ) [inline, virtual]