#include <PairInteractionForceField.h>

Component computing forces between a pair of simulated body. More...

Inheritance diagram for sofa::core::behavior::PairInteractionForceField< TDataTypes >:

Detailed Description

template<class TDataTypes>
class sofa::core::behavior::PairInteractionForceField< TDataTypes >

Component computing forces between a pair of simulated body.

This class define the abstract API common to interaction force fields between a pair of bodies using a given type of DOFs.

Public Member Functions
	SOFA_ABSTRACT_CLASS2 (SOFA_TEMPLATE(PairInteractionForceField, TDataTypes), BaseInteractionForceField, SOFA_TEMPLATE2(PairStateAccessor, TDataTypes, TDataTypes))

void	setPathObject1 (const std::string &path)
	Set the Object1 path. More...

void	setPathObject2 (const std::string &path)
	Set the Object2 path. More...

std::string	getPathObject1 () const
	Retrieve the Object1 path. More...

std::string	getPathObject2 () const
	Retrieve the Object2 path. More...

Vector operations
void	addForce (const MechanicalParams *mparams, MultiVecDerivId fId) override

virtual void	addForce (const MechanicalParams *mparams, DataVecDeriv &f1, DataVecDeriv &f2, const DataVecCoord &x1, const DataVecCoord &x2, const DataVecDeriv &v1, const DataVecDeriv &v2)=0

void	addDForce (const MechanicalParams *mparams, MultiVecDerivId dfId) override

virtual void	addDForce (const MechanicalParams *mparams, DataVecDeriv &df1, DataVecDeriv &df2, const DataVecDeriv &dx1, const DataVecDeriv &dx2)=0

SReal	getPotentialEnergy (const MechanicalParams *mparams) const override

virtual SReal	getPotentialEnergy (const MechanicalParams *mparams, const DataVecCoord &x1, const DataVecCoord &x2) const =0

Public Member Functions inherited from sofa::core::behavior::BaseInteractionForceField
	SOFA_ABSTRACT_CLASS (BaseInteractionForceField, BaseForceField)

virtual BaseMechanicalState *	getMechModel1 ()

virtual BaseMechanicalState *	getMechModel2 ()

void	addKToMatrix (const MechanicalParams , const sofa::core::behavior::MultiMatrixAccessor ) override
	Compute the system matrix corresponding to . More...

virtual void	initGnuplot (const std::string path)
	initialization to export potential energy to gnuplot files format More...

virtual void	exportGnuplot (SReal time)
	export kinetic and potential energy state at "time" to a gnuplot file More...

bool	insertInNode (objectmodel::BaseNode *node) override

bool	removeInNode (objectmodel::BaseNode *node) override

Public Member Functions inherited from sofa::core::behavior::BaseForceField
	SOFA_ABSTRACT_CLASS (BaseForceField, StateAccessor)

virtual void	addMBKdx (const MechanicalParams *mparams, MultiVecDerivId dfId)
	Accumulate the contribution of M, B, and/or K matrices multiplied by the dx vector with the given coefficients. More...

virtual void	addBToMatrix (const MechanicalParams mparams, const sofa::core::behavior::MultiMatrixAccessor matrix)
	Compute the system matrix corresponding to . More...

virtual void	addMBKToMatrix (const MechanicalParams mparams, const sofa::core::behavior::MultiMatrixAccessor matrix)
	Compute the system matrix corresponding to . More...

virtual void	buildStiffnessMatrix (StiffnessMatrix *matrix)

virtual void	buildDampingMatrix (DampingMatrix *matrix)

virtual const sofa::linearalgebra::BaseMatrix *	getComplianceMatrix (const MechanicalParams *)

virtual void	addClambda (const MechanicalParams *, MultiVecDerivId, MultiVecDerivId, SReal)
	Accumulate the contribution of the C compliant matrix multiplied by the given Lagrange multipliers lambda vector with the given cFactor coefficient. More...

Public Member Functions inherited from sofa::core::behavior::StateAccessor
	SOFA_ABSTRACT_CLASS (StateAccessor, objectmodel::BaseObject)

virtual const MultiLink< StateAccessor, BaseMechanicalState, BaseLink::FLAG_DUPLICATE >::Container &	getMechanicalStates () const
	Return a list of mechanical states to which this component is associated. More...

void	computeBBox (const core::ExecParams *params, bool onlyVisible=false) override

Public Member Functions inherited from sofa::core::objectmodel::BaseObject
	SOFA_CLASS (BaseObject, Base)

virtual void	draw (const core::visual::VisualParams *)
	Render internal data of this object, for debugging purposes. More...

void	setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
	Sets a source Object and parses it to collect dependent Data. More...

void	setSrc (const std::string &v, const BaseObject loader, std::vector< std::string > attributeList=nullptr)

Base *	findLinkDestClass (const BaseClass destType, const std::string &path, const BaseLink link) override

virtual std::string	getPathName () const override
	Return the full path name of this object. More...

SReal	getTime () const
	Current time. More...

const BaseContext *	getContext () const

BaseContext *	getContext ()

const BaseObject *	getMaster () const

BaseObject *	getMaster ()

const VecSlaves &	getSlaves () const

BaseObject *	getSlave (const std::string &name) const

virtual void	addSlave (BaseObject::SPtr s)

virtual void	removeSlave (BaseObject::SPtr s)

virtual void	handleEvent (Event *)
	Handle an event. More...

virtual void	handleTopologyChange ()

virtual void	handleTopologyChange (core::topology::Topology *t)

void	parse (BaseObjectDescription *arg) override
	Parse the given description to assign values to this object's fields and potentially other parameters. More...

virtual void	bwdInit ()
	Initialization method called at graph creation and modification, during bottom-up traversal. More...

virtual void	reinit ()
	Update method called when variables used in precomputation are modified. More...

void	updateInternal ()
	Update method called when variables (used to compute other internal variables) are modified. More...

virtual void	storeResetState ()
	Save the initial state for later uses in reset() More...

virtual void	reset ()
	Reset to initial state. More...

virtual void	cleanup ()

Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClass *	getClass () const

void	addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)

void	addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)

void	addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)

const std::string &	getName () const
	Accessor to the object name. More...

void	setName (const std::string &n)
	Set the name of this object. More...

void	setName (const std::string &n, int counter)
	Set the name of this object, adding an integer counter. More...

std::string	getTypeName () const
	Get the type name of this object (i.e. class and template types) More...

virtual std::string	getClassName () const
	Get the class name of this object. More...

virtual std::string	getTemplateName () const final
	Get the template type names (if any) used to instantiate this object. More...

std::string	getNameSpaceName () const
	Get the template type names (if any) used to instantiate this object. More...

void	setDefinitionSourceFileName (const std::string &sourceFileName)
	Set the source filename (where the component is implemented) More...

const std::string &	getDefinitionSourceFileName () const
	Get the source filename (where the component is implemented) More...

void	setDefinitionSourceFilePos (const int)
	Set the source location (where the component is implemented) More...

int	getDefinitionSourceFilePos () const
	Get the source location (where the component is implemented) More...

void	setInstanciationSourceFileName (const std::string &sourceFileName)

const std::string &	getInstanciationSourceFileName () const

void	setInstanciationSourceFilePos (const int)

int	getInstanciationSourceFilePos () const

void	addMessage (const sofa::helper::logging::Message &m) const

size_t	countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const

const std::deque< sofa::helper::logging::Message > &	getLoggedMessages () const

const std::string	getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const

void	clearLoggedMessages () const

bool	notMuted () const

const sofa::core::objectmodel::TagSet &	getTags () const
	Represents the subsets the object belongs to. More...

bool	hasTag (Tag t) const
	Return true if the object belong to the given subset. More...

void	addTag (Tag t)
	Add a subset qualification to the object. More...

void	removeTag (Tag t)
	Remove a subset qualification to the object. More...

ComponentState	getComponentState () const

bool	isComponentStateValid () const

virtual bool	parseField (const std::string &attribute, const std::string &value)
	Assign one field value (Data or Link) More...

virtual bool	hasField (const std::string &attribute) const
	Check if a given Data field or Link exists. More...

void	parseFields (const std::list< std::string > &str)
	Assign the field values stored in the given list of name + value pairs of strings. More...

virtual void	parseFields (const std::map< std::string, std::string * > &str)
	Assign the field values stored in the given map of name -> value pairs. More...

void	writeDatas (std::map< std::string, std::string * > &str)
	Write the current field values to the given map of name -> value pairs. More...

void	writeDatas (std::ostream &out, const std::string &separator=" ")

BaseData *	findData (const std::string &name) const

std::vector< BaseData * >	findGlobalField (const std::string &name) const
	Find data fields given a name: several can be found as we look into the alias map. More...

BaseLink *	findLink (const std::string &name) const

std::vector< BaseLink * >	findLinks (const std::string &name) const
	Find link fields given a name: several can be found as we look into the alias map. More...

virtual void	updateLinks (bool logErrors=true)
	Update pointers in case the pointed-to objects have appeared. More...

template<class T >
BaseData::BaseInitData	initData (::sofa::core::objectmodel::Data< T > field, const char name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
	Helper method used to initialize a data field containing a value of type T. More...

template<class T >
BaseData::BaseInitData	initData (Data< T > field, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...

template<class T >
Data< T >::InitData	initData (Data< T > field, const T &value, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...

void	addData (BaseData *f, const std::string &name)

void	addData (BaseData *f)

void	removeData (BaseData *f)
	Remove a data field. More...

void	addAlias (BaseData field, const char alias)
	Add an alias to a Data. More...

void	addLink (BaseLink *l)
	Add a link. More...

void	addAlias (BaseLink link, const char alias)
	Add an alias to a Link. More...

const VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...

const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...

const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...

const MapLink &	getLinkAliases () const
	Accessor to the map containing all the aliases of this object. More...

virtual bool	findDataLinkDest (BaseData &ptr, const std::string &path, const BaseLink link)

template<class T >
bool	findLinkDest (T &ptr, const std::string &path, const BaseLink link)

Public Member Functions inherited from sofa::core::behavior::PairStateAccessor< TDataTypes >
	SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE2(PairStateAccessor, TDataTypes, TDataTypes), StateAccessor)

void	init () override
	Initialization method called at graph creation and modification, during top-down traversal. More...

MechanicalState< TDataTypes > *	getMState1 ()
	Retrieve the associated MechanicalState #1. More...

const MechanicalState< TDataTypes > *	getMState1 () const
	Retrieve the associated MechanicalState #1. More...

BaseMechanicalState *	getMechModel1 ()
	Retrieve the associated MechanicalState #1 as a BaseMechanicalState. More...

const BaseMechanicalState *	getMechModel1 () const
	Retrieve the associated MechanicalState #1 as a BaseMechanicalState. More...

MechanicalState< TDataTypes > *	getMState2 ()
	Retrieve the associated MechanicalState #2. More...

const MechanicalState< TDataTypes > *	getMState2 () const
	Retrieve the associated MechanicalState #2. More...

BaseMechanicalState *	getMechModel2 ()
	Retrieve the associated MechanicalState #2 as a BaseMechanicalState. More...

const BaseMechanicalState *	getMechModel2 () const
	Retrieve the associated MechanicalState #2 as a BaseMechanicalState. More...

Static Public Member Functions
template<class T >
static bool	canCreate (T obj, objectmodel::BaseContext context, objectmodel::BaseObjectDescription *arg)

template<class T >
static T::SPtr	create (T , core::objectmodel::BaseContext context, core::objectmodel::BaseObjectDescription *arg)
	Construction method called by ObjectFactory. More...

template<class T >
static std::string	shortName (const T ptr=nullptr, objectmodel::BaseObjectDescription arg=nullptr)

Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool	canCreate (T , BaseContext , BaseObjectDescription *)
	Pre-construction check method called by ObjectFactory. More...

template<class T >
static T::SPtr	create (T , BaseContext context, BaseObjectDescription *arg)
	Construction method called by ObjectFactory. More...

Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClass *	GetClass ()

template<class T >
static std::string	shortName (const T ptr=nullptr, BaseObjectDescription =nullptr)

Protected Member Functions
	PairInteractionForceField (MechanicalState< DataTypes > mm1=nullptr, MechanicalState< DataTypes > mm2=nullptr)

	~PairInteractionForceField () override

Protected Member Functions inherited from sofa::core::behavior::BaseForceField
	BaseForceField ()

	~BaseForceField () override=default

Protected Member Functions inherited from sofa::core::behavior::StateAccessor
	StateAccessor ()

	~StateAccessor () override=default

Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
	BaseObject ()

	~BaseObject () override

virtual void	doUpdateInternal ()
	Implementation of the internal update. More...

void	changeContextLink (BaseContext before, BaseContext &after)

void	changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
	This method insures that slaves objects have master and context links set correctly. More...

void	trackInternalData (const BaseData &data)
	Method called to add the Data to the DataTracker (listing the Data to track) More...

void	cleanTracker ()

bool	hasDataChanged (const BaseData &data)
	Method called to know if a tracked Data has changed. More...

Protected Member Functions inherited from sofa::core::objectmodel::Base
	Base ()

virtual	~Base ()

void	initData0 (BaseData field, BaseData::BaseInitData &res, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

void	initData0 (BaseData field, BaseData::BaseInitData &res, const char name, const char *help, BaseData::DataFlags dataFlags)
	Helper method used by initData() More...

template<class T >
void	initData0 (Data< T > field, typename Data< T >::InitData &res, const T &value, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

Protected Member Functions inherited from sofa::core::behavior::PairStateAccessor< TDataTypes >
	PairStateAccessor (MechanicalState< TDataTypes > mm1=nullptr, MechanicalState< TDataTypes > mm2=nullptr)

	~PairStateAccessor () override=default

Additional Inherited Members
Public Attributes inherited from sofa::core::behavior::BaseForceField
Data< SReal >	rayleighStiffness
	Rayleigh Damping stiffness matrix coefficient. More...

objectmodel::lifecycle::DeprecatedData	isCompliance
	Considered as compliance, else considered as stiffness (default to false) More...

Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool >	f_listening
	if true, handle the events, otherwise ignore the events More...

Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * >	m_oldAttributes

Data< int >	d_messageLogCount

Data< std::string >	name
	Name of the object. More...

Data< bool >	f_printLog
	if true, emits extra messages at runtime. More...

Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the objet belongs to More...

Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...

Data< sofa::core::objectmodel::ComponentState >	d_componentState
	The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Protected Attributes inherited from sofa::core::behavior::StateAccessor
MultiLink< StateAccessor, BaseMechanicalState, BaseLink::FLAG_DUPLICATE >	l_mechanicalStates

Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context

LinkSlaves	l_slaves

SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK >	l_master

Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_internalEngine

VecData	m_vecData
	List of fields (Data instances) More...

MapData	m_aliasData
	name -> Data multi-map (includes names and aliases) More...

VecLink	m_vecLink
	List of links. More...

MapLink	m_aliasLink
	name -> Link multi-map (includes names and aliases) More...

Protected Attributes inherited from sofa::core::behavior::PairStateAccessor< TDataTypes >
SingleLink< PairStateAccessor< TDataTypes, TDataTypes >, MechanicalState< TDataTypes >, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	mstate1

SingleLink< PairStateAccessor< TDataTypes, TDataTypes >, MechanicalState< TDataTypes >, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	mstate2

Constructor details

◆ PairInteractionForceField()

template<class DataTypes >

sofa::core::behavior::PairInteractionForceField< DataTypes >::PairInteractionForceField	(	MechanicalState< DataTypes > *	mm1 = `nullptr`,
		MechanicalState< DataTypes > *	mm2 = `nullptr`
	)

explicitprotected

◆ ~PairInteractionForceField()

template<class DataTypes >

sofa::core::behavior::PairInteractionForceField< DataTypes >::~PairInteractionForceField

overrideprotected

Function details

◆ addDForce() [1/2]

template<class TDataTypes >

virtual void sofa::core::behavior::PairInteractionForceField< TDataTypes >::addDForce	(	const MechanicalParams *	mparams,
		DataVecDeriv &	df1,
		DataVecDeriv &	df2,
		const DataVecDeriv &	dx1,
		const DataVecDeriv &	dx2
	)

pure 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 += kFactor K dx + bFactor B dx $

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

To support old components that implement the deprecated addForce method without scalar coefficients, it defaults to using a temporaty vector to compute $ K dx $ and then manually scaling all values by kFactor.

Implemented in sofa::component::collision::response::contact::PenalityContactForceField< DataTypes >, sofa::component::solidmechanics::spring::VectorSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::RegularGridSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::PolynomialSpringsForceField< DataTypes >, sofa::component::solidmechanics::spring::JointSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::GearSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >, and sofa::component::solidmechanics::spring::SpringForceField< DataTypes >.

◆ addDForce() [2/2]

template<class DataTypes >

void sofa::core::behavior::PairInteractionForceField< DataTypes >::addDForce	(	const MechanicalParams *	mparams,
		MultiVecDerivId	dfId
	)

overridevirtual

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 += kFactor K dx + bFactor B dx $

This method retrieves the force and dx vector from the two MechanicalState and call the internal addDForce(VecDeriv&,VecDeriv&,const VecDeriv&,const VecDeriv&,SReal,SReal) method implemented by the component.

Implements sofa::core::behavior::BaseForceField.

◆ addForce() [1/2]

template<class TDataTypes >

virtual void sofa::core::behavior::PairInteractionForceField< TDataTypes >::addForce	(	const MechanicalParams *	mparams,
		DataVecDeriv &	f1,
		DataVecDeriv &	f2,
		const DataVecCoord &	x1,
		const DataVecCoord &	x2,
		const DataVecDeriv &	v1,
		const DataVecDeriv &	v2
	)

pure 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.

Implemented in sofa::component::solidmechanics::spring::RepulsiveSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::GearSpringForceField< DataTypes >, sofa::component::collision::response::contact::PenalityContactForceField< DataTypes >, sofa::component::solidmechanics::spring::SpringForceField< DataTypes >, sofa::component::solidmechanics::spring::VectorSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::RegularGridSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::JointSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >, and sofa::component::solidmechanics::spring::PolynomialSpringsForceField< DataTypes >.

◆ addForce() [2/2]

template<class DataTypes >

void sofa::core::behavior::PairInteractionForceField< DataTypes >::addForce	(	const MechanicalParams *	mparams,
		MultiVecDerivId	fId
	)

overridevirtual

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 retrieves the force, x and v vector from the two MechanicalState and call the internal addForce(VecDeriv&,VecDeriv&,const VecCoord&,const VecCoord&,const VecDeriv&,const VecDeriv&) method implemented by the component.

Implements sofa::core::behavior::BaseForceField.

◆ canCreate()

template<class TDataTypes >

template<class T >

static bool sofa::core::behavior::PairInteractionForceField< TDataTypes >::canCreate	(	T *	obj,
		objectmodel::BaseContext *	context,
		objectmodel::BaseObjectDescription *	arg
	)

inlinestatic

Pre-construction check method called by ObjectFactory. Check that DataTypes matches the MechanicalState.

◆ create()

template<class TDataTypes >

template<class T >

static T::SPtr sofa::core::behavior::PairInteractionForceField< TDataTypes >::create	(	T *	,
		core::objectmodel::BaseContext *	context,
		core::objectmodel::BaseObjectDescription *	arg
	)

inlinestatic

Construction method called by ObjectFactory.

◆ getPathObject1()

template<class TDataTypes >

std::string sofa::core::behavior::PairInteractionForceField< TDataTypes >::getPathObject1 ( ) const

inline

Retrieve the Object1 path.

◆ getPathObject2()

template<class TDataTypes >

std::string sofa::core::behavior::PairInteractionForceField< TDataTypes >::getPathObject2 ( ) const

inline

Retrieve the Object2 path.

◆ getPotentialEnergy() [1/2]

template<class DataTypes >

SReal sofa::core::behavior::PairInteractionForceField< DataTypes >::getPotentialEnergy ( const MechanicalParams * mparams ) const

overridevirtual

Get the potential energy associated to this ForceField.

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

This method retrieves the x vector from the MechanicalState and call the internal getPotentialEnergy(const VecCoord&,const VecCoord&) method implemented by the component.

Implements sofa::core::behavior::BaseForceField.

◆ getPotentialEnergy() [2/2]

template<class TDataTypes >

virtual SReal sofa::core::behavior::PairInteractionForceField< TDataTypes >::getPotentialEnergy	(	const MechanicalParams *	mparams,
		const DataVecCoord &	x1,
		const DataVecCoord &	x2
	)		const

pure 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.

Implemented in sofa::component::solidmechanics::spring::RepulsiveSpringForceField< DataTypes >, sofa::component::collision::response::contact::PenalityContactForceField< DataTypes >, sofa::component::solidmechanics::spring::SpringForceField< DataTypes >, sofa::component::solidmechanics::spring::VectorSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::PolynomialSpringsForceField< DataTypes >, sofa::component::solidmechanics::spring::JointSpringForceField< DataTypes >, sofa::component::solidmechanics::spring::GearSpringForceField< DataTypes >, and sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >.

◆ setPathObject1()

template<class TDataTypes >

void sofa::core::behavior::PairInteractionForceField< TDataTypes >::setPathObject1 ( const std::string & path )

inline

Set the Object1 path.

◆ setPathObject2()

template<class TDataTypes >

void sofa::core::behavior::PairInteractionForceField< TDataTypes >::setPathObject2 ( const std::string & path )

inline

Set the Object2 path.

◆ shortName()

template<class TDataTypes >

template<class T >

static std::string sofa::core::behavior::PairInteractionForceField< TDataTypes >::shortName	(	const T *	ptr = `nullptr`,
		objectmodel::BaseObjectDescription *	arg = `nullptr`
	)

inlinestatic

◆ SOFA_ABSTRACT_CLASS2()

template<class TDataTypes >

sofa::core::behavior::PairInteractionForceField< TDataTypes >::SOFA_ABSTRACT_CLASS2	(	SOFA_TEMPLATE(PairInteractionForceField< TDataTypes >, TDataTypes)	,
		BaseInteractionForceField	,
		SOFA_TEMPLATE2(PairStateAccessor, TDataTypes, TDataTypes)
	)

Detailed Description

template<class TDataTypes> class sofa::core::behavior::PairInteractionForceField< TDataTypes >

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor details

◆ PairInteractionForceField()

◆ ~PairInteractionForceField()

Function details

◆ addDForce() [1/2]

◆ addDForce() [2/2]

◆ addForce() [1/2]

◆ addForce() [2/2]

◆ canCreate()

◆ create()

◆ getPathObject1()

◆ getPathObject2()

◆ getPotentialEnergy() [1/2]

◆ getPotentialEnergy() [2/2]

◆ setPathObject1()

◆ setPathObject2()

◆ shortName()

◆ SOFA_ABSTRACT_CLASS2()

template<class TDataTypes>
class sofa::core::behavior::PairInteractionForceField< TDataTypes >