#include <RestShapeSpringsForceField.h>

This class describes a simple elastic springs ForceField between DOFs positions and rest positions. More...

Inheritance diagram for sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >:

Detailed Description

template<class DataTypes>
class sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >

This class describes a simple elastic springs ForceField between DOFs positions and rest positions.

Springs are applied to given degrees of freedom between their current positions and their rest shape positions. An external MechanicalState reference can also be passed to the ForceField as rest shape position.

Public Attributes
DataSubsetIndex	d_points
	points controlled by the rest shape springs More...

Data< VecReal >	d_stiffness
	stiffness values between the actual position and the rest shape position More...

Data< VecReal >	d_angularStiffness
	angularStiffness assigned when controlling the rotation of the points More...

Data< type::vector< CPos > >	d_pivotPoints
	global pivot points used when translations instead of the rigid mass centers More...

Data< VecIndex >	d_external_points
	points from the external Mechancial State that define the rest shape springs More...

Data< bool >	d_recompute_indices
	Recompute indices (should be false for BBOX) More...

Data< bool >	d_drawSpring
	draw Spring More...

Data< sofa::type::RGBAColor >	d_springColor
	spring color. (default=[0.0,1.0,0.0,1.0]) More...

Data< type::fixed_array< bool, coord_total_size > >	d_activeDirections
	directions (translation, and rotation in case of Rigids) in which the spring is active More...

SingleLink< RestShapeSpringsForceField< DataTypes >, sofa::core::behavior::MechanicalState< DataTypes >, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	l_restMState

linearalgebra::EigenBaseSparseMatrix< typename DataTypes::Real >	matS

SingleLink< RestShapeSpringsForceField< DataTypes >, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	l_topology
	Link to be set to the topology container in the component graph. More...

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

Data< bool >	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 object state More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Static Public Attributes
static constexpr sofa::Size	spatial_dimensions = Coord::spatial_dimensions

static constexpr sofa::Size	coord_total_size = Coord::total_size

Protected Attributes
VecIndex	m_indices

VecIndex	m_ext_indices

type::vector< CPos >	m_pivots

SReal	lastUpdatedStep {}

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::SingleStateAccessor< DataTypes >
SingleLink< SingleStateAccessor< DataTypes >, MechanicalState< DataTypes >, BaseLink::FLAG_STRONGLINK >	mstate

Static Protected Attributes
static constexpr type::fixed_array< bool, coord_total_size >	s_defaultActiveDirections = sofa::type::makeHomogeneousArray<bool, coord_total_size>(true)

Public Member Functions
	SOFA_CLASS (SOFA_TEMPLATE(RestShapeSpringsForceField, DataTypes), SOFA_TEMPLATE(core::behavior::ForceField, DataTypes))

void	bwdInit () override
	BaseObject initialization method. More...

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

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

void	addForce (const core::MechanicalParams *mparams, DataVecDeriv &f, const DataVecCoord &x, const DataVecDeriv &v) override
	Add the forces. More...

void	addDForce (const core::MechanicalParams *mparams, DataVecDeriv &df, const DataVecDeriv &dx) override

SReal	getPotentialEnergy (const core::MechanicalParams *mparams, const DataVecCoord &x) const override

void	addKToMatrix (const core::MechanicalParams mparams, const sofa::core::behavior::MultiMatrixAccessor matrix) override
	Brings ForceField contribution to the global system stiffness matrix. More...

void	buildStiffnessMatrix (core::behavior::StiffnessMatrix *matrix) override

void	buildDampingMatrix (core::behavior::DampingMatrix *matrix) override

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

const DataVecCoord *	getExtPosition () const

const VecIndex &	getIndices () const

const VecIndex &	getExtIndices () const

Public Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
	SOFA_CLASS2 (SOFA_TEMPLATE(ForceField, DataTypes), BaseForceField, SOFA_TEMPLATE(SingleStateAccessor, DataTypes))

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

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

void	addClambda (const MechanicalParams *mparams, MultiVecDerivId resId, MultiVecDerivId lambdaId, SReal cFactor) override

virtual void	addClambda (const MechanicalParams *mparams, DataVecDeriv &df, const DataVecDeriv &lambda, SReal cFactor)

SReal	getPotentialEnergy (const MechanicalParams *mparams) const override

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

virtual void	addKToMatrix (sofa::linearalgebra::BaseMatrix *matrix, SReal kFact, unsigned int &offset)

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

virtual void	addBToMatrix (sofa::linearalgebra::BaseMatrix *matrix, SReal bFact, unsigned int &offset)

void	addToMatrix (sofa::linearalgebra::BaseMatrix *bm, unsigned offset, const IndexArray &nodeIndex, const ElementMat &em, SReal scale)

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

bool	insertInNode (objectmodel::BaseNode *node) override

bool	removeInNode (objectmodel::BaseNode *node) override

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	addMBKToMatrix (const MechanicalParams mparams, const sofa::core::behavior::MultiMatrixAccessor matrix)
	Compute the system matrix corresponding to . More...

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

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)

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

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::SingleStateAccessor< DataTypes >
	SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE(SingleStateAccessor, DataTypes), StateAccessor)

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

MechanicalState< DataTypes > *	getMState ()

const MechanicalState< DataTypes > *	getMState () const

Protected Member Functions
	RestShapeSpringsForceField ()

void	recomputeIndices ()

bool	checkOutOfBoundsIndices ()

bool	checkOutOfBoundsIndices (const VecIndex &indices, const sofa::Size dimension)

Protected Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
	ForceField (MechanicalState< DataTypes > *mm=nullptr)

	~ForceField () 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::SingleStateAccessor< DataTypes >
	SingleStateAccessor (MechanicalState< DataTypes > *mm=nullptr)

	~SingleStateAccessor () override=default

Additional Inherited Members
Static Public Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
static bool	canCreate (T &obj, objectmodel::BaseContext context, objectmodel::BaseObjectDescription *arg)

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)

Attribute details

◆ coord_total_size

template<class DataTypes >

constexpr sofa::Size sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::coord_total_size = Coord::total_size

staticconstexpr

◆ d_activeDirections

template<class DataTypes >

Data< type::fixed_array<bool, coord_total_size> > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_activeDirections

directions (translation, and rotation in case of Rigids) in which the spring is active

◆ d_angularStiffness

template<class DataTypes >

Data< VecReal > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_angularStiffness

angularStiffness assigned when controlling the rotation of the points

◆ d_drawSpring

template<class DataTypes >

Data< bool > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_drawSpring

draw Spring

◆ d_external_points

template<class DataTypes >

Data< VecIndex > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_external_points

points from the external Mechancial State that define the rest shape springs

◆ d_pivotPoints

template<class DataTypes >

Data< type::vector< CPos > > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_pivotPoints

global pivot points used when translations instead of the rigid mass centers

◆ d_points

template<class DataTypes >

DataSubsetIndex sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_points

points controlled by the rest shape springs

◆ d_recompute_indices

template<class DataTypes >

Data< bool > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_recompute_indices

Recompute indices (should be false for BBOX)

◆ d_springColor

template<class DataTypes >

Data< sofa::type::RGBAColor > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_springColor

spring color. (default=[0.0,1.0,0.0,1.0])

◆ d_stiffness

template<class DataTypes >

Data< VecReal > sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::d_stiffness

stiffness values between the actual position and the rest shape position

◆ l_restMState

template<class DataTypes >

SingleLink<RestShapeSpringsForceField<DataTypes>, sofa::core::behavior::MechanicalState< DataTypes >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINK> sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::l_restMState

◆ l_topology

template<class DataTypes >

SingleLink<RestShapeSpringsForceField<DataTypes>, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::l_topology

Link to be set to the topology container in the component graph.

◆ lastUpdatedStep

template<class DataTypes >

SReal sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::lastUpdatedStep {}

protected

◆ m_ext_indices

template<class DataTypes >

VecIndex sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::m_ext_indices

protected

◆ m_indices

template<class DataTypes >

VecIndex sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::m_indices

protected

◆ m_pivots

template<class DataTypes >

type::vector<CPos> sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::m_pivots

protected

◆ matS

template<class DataTypes >

linearalgebra::EigenBaseSparseMatrix<typename DataTypes::Real> sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::matS

◆ s_defaultActiveDirections

template<class DataTypes >

constexpr type::fixed_array<bool, coord_total_size> sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::s_defaultActiveDirections = sofa::type::makeHomogeneousArray<bool, coord_total_size>(true)

staticconstexprprotected

◆ spatial_dimensions

template<class DataTypes >

constexpr sofa::Size sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::spatial_dimensions = Coord::spatial_dimensions

staticconstexpr

Constructor details

◆ RestShapeSpringsForceField()

template<class DataTypes >

sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::RestShapeSpringsForceField

protected

Function details

◆ addDForce()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::addDForce	(	const core::MechanicalParams *	mparams,
		DataVecDeriv &	df,
		const DataVecDeriv &	dx
	)

overridevirtual

Internal addDForce Overloaded function, usually called from the generic addDForce version. This addDForce version directly gives access to df and dx vectors through its parameters.

Parameters

mparams
df	Output vector to fill, result of
dx	Input vector used to compute

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

◆ addForce()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::addForce	(	const core::MechanicalParams *	mparams,
		DataVecDeriv &	f,
		const DataVecCoord &	x,
		const DataVecDeriv &	v
	)

overridevirtual

Add the forces.

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

◆ addKToMatrix()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::addKToMatrix	(	const core::MechanicalParams *	mparams,
		const sofa::core::behavior::MultiMatrixAccessor *	matrix
	)

overridevirtual

Brings ForceField contribution to the global system stiffness matrix.

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

◆ buildDampingMatrix()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::buildDampingMatrix ( core::behavior::DampingMatrix * matrix )

overridevirtual

Reimplemented from sofa::core::behavior::BaseForceField.

◆ buildStiffnessMatrix()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::buildStiffnessMatrix ( core::behavior::StiffnessMatrix * matrix )

overridevirtual

Reimplemented from sofa::core::behavior::BaseForceField.

◆ bwdInit()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::bwdInit

overridevirtual

BaseObject initialization method.

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

◆ checkOutOfBoundsIndices() [1/2]

template<class DataTypes >

bool sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::checkOutOfBoundsIndices

protected

◆ checkOutOfBoundsIndices() [2/2]

template<class DataTypes >

bool sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::checkOutOfBoundsIndices	(	const VecIndex &	indices,
		const sofa::Size	dimension
	)

protected

◆ draw()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::draw ( const core::visual::VisualParams * )

overridevirtual

Render internal data of this object, for debugging purposes.

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

◆ getExtIndices()

template<class DataTypes >

const VecIndex& sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::getExtIndices ( ) const

inline

◆ getExtPosition()

template<class DataTypes >

const RestShapeSpringsForceField< DataTypes >::DataVecCoord * sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::getExtPosition

◆ getIndices()

template<class DataTypes >

const VecIndex& sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::getIndices ( ) const

inline

◆ getPotentialEnergy()

template<class DataTypes >

SReal sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::getPotentialEnergy	(	const core::MechanicalParams *	mparams,
		const DataVecCoord &	x
	)		const

inlineoverridevirtual

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

◆ parse()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::parse ( core::objectmodel::BaseObjectDescription * arg )

overridevirtual

Parse the given description to assign values to this object's fields and potentially other parameters.

Reimplemented from sofa::core::objectmodel::Base.

◆ recomputeIndices()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::recomputeIndices

protected

◆ reinit()

template<class DataTypes >

void sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::reinit

overridevirtual

Update method called when variables used in precomputation are modified.

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

◆ SOFA_CLASS()

template<class DataTypes >

sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >::SOFA_CLASS	(	SOFA_TEMPLATE(RestShapeSpringsForceField< DataTypes >, DataTypes)	,
		SOFA_TEMPLATE(core::behavior::ForceField, DataTypes)
	)

Detailed Description

template<class DataTypes> class sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >

Public Attributes

Static Public Attributes

Protected Attributes

Static Protected Attributes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Attribute details

◆ coord_total_size

◆ d_activeDirections

◆ d_angularStiffness

◆ d_drawSpring

◆ d_external_points

◆ d_pivotPoints

◆ d_points

◆ d_recompute_indices

◆ d_springColor

◆ d_stiffness

◆ l_restMState

◆ l_topology

◆ lastUpdatedStep

◆ m_ext_indices

◆ m_indices

◆ m_pivots

◆ matS

◆ s_defaultActiveDirections

◆ spatial_dimensions

Constructor details

◆ RestShapeSpringsForceField()

Function details

◆ addDForce()

◆ addForce()

◆ addKToMatrix()

◆ buildDampingMatrix()

◆ buildStiffnessMatrix()

◆ bwdInit()

◆ checkOutOfBoundsIndices() [1/2]

◆ checkOutOfBoundsIndices() [2/2]

◆ draw()

◆ getExtIndices()

◆ getExtPosition()

◆ getIndices()

◆ getPotentialEnergy()

◆ parse()

◆ recomputeIndices()

◆ reinit()

◆ SOFA_CLASS()

template<class DataTypes>
class sofa::component::solidmechanics::spring::RestShapeSpringsForceField< DataTypes >