SOFA API  180226c0
Open source framework for multi-physics simuation
sofa::component::interactionforcefield::SpringForceField< DataTypes > Class Template Reference

#include <SpringForceField.h>

Set of simple springs between particles. More...

Inheritance diagram for sofa::component::interactionforcefield::SpringForceField< DataTypes >:

Detailed Description

template<class DataTypes>
class sofa::component::interactionforcefield::SpringForceField< DataTypes >

Set of simple springs between particles.

Classes

class  Loader
 

Public Attributes

Data< SRealks
 uniform stiffness for the all springs More...
 
Data< SRealkd
 uniform damping for the all springs More...
 
Data< floatshowArrowSize
 size of the axis More...
 
Data< intdrawMode
 
Data< sofa::helper::vector< Spring > > springs
 Draw Mode: 0=Line - 1=Cylinder - 2=Arrow. More...
 
- Public Attributes inherited from sofa::core::behavior::BaseForceField
Data< SRealrayleighStiffness
 Rayleigh Damping stiffness matrix coefficient. More...
 
Data< boolisCompliance
 Considered as compliance, else considered as stiffness (default to false) More...
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
helper::system::SofaOStream< helper::logging::Message::Warningserr
 
helper::system::SofaOStream< helper::logging::Message::Infosout
 
helper::system::SofaEndl< Basesendl
 runs the stream processing More...
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet belongs to More...
 
Data< sofa::defaulttype::BoundingBoxf_bbox
 this object bounding box More...
 
Data< ComponentStated_componentstate
 the object state More...
 
Data< ComponentState > & m_componentstate {d_componentstate}
 TODO bruno: uncomment once c++17 is enabled in SOFA. More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Protected Attributes

core::objectmodel::DataFileName fileSprings
 
bool maskInUse
 
Real m_potentialEnergy
 
SpringForceFieldInternalData< DataTypesdata
 
std::ofstream * m_gnuplotFileEnergy
 stream to export Potential Energy to gnuplot files More...
 
- Protected Attributes inherited from sofa::core::behavior::PairInteractionForceField< DataTypes >
SingleLink< PairInteractionForceField< DataTypes >, MechanicalState< DataTypes >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINK > mstate1
 
SingleLink< PairInteractionForceField< DataTypes >, MechanicalState< DataTypes >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINK > mstate2
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
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...
 

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE(SpringForceField, DataTypes), SOFA_TEMPLATE(core::behavior::PairInteractionForceField, DataTypes))
 
bool load (const char *filename)
 
core::behavior::MechanicalState< DataTypes > * getObject1 ()
 
core::behavior::MechanicalState< DataTypes > * getObject2 ()
 
const sofa::helper::vector< Spring > & getSprings () const
 
void reinit () override
 Update method called when variables used in precomputation are modified. More...
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void addForce (const core::MechanicalParams *mparams, DataVecDeriv &f1, DataVecDeriv &f2, const DataVecCoord &x1, const DataVecCoord &x2, const DataVecDeriv &v1, const DataVecDeriv &v2) override
 
void addDForce (const core::MechanicalParams *, DataVecDeriv &df1, DataVecDeriv &df2, const DataVecDeriv &dx1, const DataVecDeriv &dx2) override
 
SReal getPotentialEnergy (const core::MechanicalParams *, const DataVecCoord &data_x1, const DataVecCoord &data_x2) const override
 
virtual void addKToMatrix (sofa::defaulttype::BaseMatrix *, SReal, unsigned int &)
 
SReal getStiffness () const
 
SReal getDamping () const
 
void setStiffness (SReal _ks)
 
void setDamping (SReal _kd)
 
SReal getArrowSize () const
 
void setArrowSize (float s)
 
int getDrawMode () const
 
void setDrawMode (int m)
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. More...
 
void clear (int reserve=0)
 
void removeSpring (unsigned int idSpring)
 
void addSpring (int m1, int m2, SReal ks, SReal kd, SReal initlen)
 
void addSpring (const Spring &spring)
 
void updateForceMask () override
 
void handleTopologyChange (core::topology::Topology *topo) override
 
void initGnuplot (const std::string path) override
 initialization to export kinetic, potential energy and force intensity to gnuplot files format More...
 
void exportGnuplot (SReal time) override
 export kinetic and potential energy state at "time" to a gnuplot file More...
 
- Public Member Functions inherited from sofa::core::behavior::PairInteractionForceField< DataTypes >
 SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE(PairInteractionForceField, DataTypes), BaseInteractionForceField)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
MechanicalState< DataTypes > * getMState1 ()
 Retrieve the associated MechanicalState. More...
 
BaseMechanicalStategetMechModel1 () override
 
MechanicalState< DataTypes > * getMState2 ()
 Retrieve the associated MechanicalState. More...
 
BaseMechanicalStategetMechModel2 () override
 
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...
 
virtual std::string getTemplateName () const override
 Get the template type names (if any) used to instantiate this object. More...
 
void updateForceMask () override
 
void addForce (const MechanicalParams *mparams, MultiVecDerivId fId) override
 
void addDForce (const MechanicalParams *mparams, MultiVecDerivId dfId) override
 
SReal getPotentialEnergy (const MechanicalParams *mparams) const override
 
- Public Member Functions inherited from sofa::core::behavior::BaseInteractionForceField
 SOFA_ABSTRACT_CLASS (BaseInteractionForceField, BaseForceField)
 
void addKToMatrix (const MechanicalParams *, const sofa::core::behavior::MultiMatrixAccessor *) override
 Compute the system matrix corresponding to k K. 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, objectmodel::BaseObject)
 
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 addSubKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > &subMatrixIndex)
 
virtual void addBToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix)
 Compute the system matrix corresponding to b B. More...
 
virtual void addSubBToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > &vecIds)
 
virtual void addMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix)
 Compute the system matrix corresponding to m M + b B + k K. More...
 
virtual void addSubMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > subMatrixIndex)
 addMBKToMatrix only on the subMatrixIndex More...
 
virtual const sofa::defaulttype::BaseMatrixgetComplianceMatrix (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::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
virtual void computeBBox (const core::ExecParams *, bool=false)
 
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)
 
void * findLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const
 Return the full path name of this object. More...
 
template<class T >
T::SPtr searchLocal () const
 Local search of an object of the given type. More...
 
template<class T >
T::SPtr searchUp () const
 Upward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchDown () const
 Downward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchFromRoot () const
 
template<class T >
T::SPtr searchInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal () const
 Local search of all objects of the given type. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp () const
 Upward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown () const
 Downward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot () const
 Search of all objects of the given type, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const Tag &t) const
 Local search of all objects of the given type with a given Tag. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const Tag &t) const
 Upward search of all objects of the given type with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const Tag &t) const
 Downward search of all objects of the given typee with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const Tag &t) const
 Search of all objects of the given typee with a given Tag, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const Tag &t) const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const TagSet &t) const
 Local search of all objects of the given type with a given TagSet. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const TagSet &t) const
 Upward search of all objects of the given type with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const TagSet &t) const
 Downward search of all objects of the given typee with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const TagSet &t) const
 Search of all objects of the given typee with a given TagSet, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const TagSet &t) const
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
void copyAspect (int destAspect, int srcAspect) override
 Copy the source aspect to the destination aspect for each Data in the component. More...
 
void releaseAspect (int aspect) override
 Release memory allocated for the specified aspect. More...
 
virtual void handleEvent (Event *)
 Handle an event. More...
 
virtual void handleTopologyChange ()
 
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...
 
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 BaseClassgetClass () const
 
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...
 
virtual 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...
 
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
 
const std::string getWarnings () const
 
const std::string getOutputs () const
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearWarnings ()
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearOutputs ()
 use clearLoggedMessages() instead More...
 
void processStream (std::ostream &out)
 use clearLoggedMessages() instead More...
 
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::TagSetgetTags () 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=" ")
 
BaseDatafindData (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...
 
BaseLinkfindLink (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 (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 removeLink (BaseLink *l)
 Remove a link. More...
 
void addAlias (BaseLink *link, const char *alias)
 Add an alias to a Link. More...
 
const VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () 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)
 

Protected Member Functions

virtual void addSpringForce (Real &potentialEnergy, VecDeriv &f1, const VecCoord &p1, const VecDeriv &v1, VecDeriv &f2, const VecCoord &p2, const VecDeriv &v2, int, const Spring &spring)
 
 SpringForceField (SReal _ks=100.0, SReal _kd=5.0)
 
 SpringForceField (MechanicalState *object1, MechanicalState *object2, SReal _ks=100.0, SReal _kd=5.0)
 
- Protected Member Functions inherited from sofa::core::behavior::PairInteractionForceField< DataTypes >
 PairInteractionForceField (MechanicalState< DataTypes > *mm1=nullptr, MechanicalState< DataTypes > *mm2=nullptr)
 
 ~PairInteractionForceField () override
 
- Protected Member Functions inherited from sofa::core::behavior::BaseForceField
 BaseForceField ()
 
 ~BaseForceField () override
 
- 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, unsigned int, 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...
 

Friends

class SpringForceFieldInternalData< DataTypes >
 

Additional Inherited Members

- Static Public Member Functions inherited from sofa::core::behavior::PairInteractionForceField< DataTypes >
static bool canCreate (T *obj, objectmodel::BaseContext *context, objectmodel::BaseObjectDescription *arg)
 
static T::SPtr create (T *, core::objectmodel::BaseContext *context, core::objectmodel::BaseObjectDescription *arg)
 Construction method called by ObjectFactory. More...
 
static std::string templateName (const PairInteractionForceField< DataTypes > *=nullptr)
 
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 MyClassGetClass ()
 
template<class T >
static void dynamicCast (T *&ptr, Base *b)
 
template<class T >
static std::string typeName (const T *ptr=nullptr)
 
template<class T >
static std::string className (const T *ptr=nullptr)
 
template<class T >
static std::string namespaceName (const T *ptr=nullptr)
 
template<class T >
static std::string templateName (const T *ptr=nullptr)
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

template<class DataTypes >
Data<int> sofa::component::interactionforcefield::SpringForceField< DataTypes >::drawMode

uniform damping for the all springs

uniform stiffness for the all springs

template<class DataTypes >
std::ofstream* sofa::component::interactionforcefield::SpringForceField< DataTypes >::m_gnuplotFileEnergy
protected

stream to export Potential Energy to gnuplot files

template<class DataTypes >
Real sofa::component::interactionforcefield::SpringForceField< DataTypes >::m_potentialEnergy
protected
template<class DataTypes >
bool sofa::component::interactionforcefield::SpringForceField< DataTypes >::maskInUse
protected
template<class DataTypes >
Data<float> sofa::component::interactionforcefield::SpringForceField< DataTypes >::showArrowSize

size of the axis

Draw Mode: 0=Line - 1=Cylinder - 2=Arrow.

pairs of indices, stiffness, damping, rest length

Constructor details

template<class DataTypes >
sofa::component::interactionforcefield::SpringForceField< DataTypes >::SpringForceField ( SReal  _ks = 100.0,
SReal  _kd = 5.0 
)
protected
template<class DataTypes >
sofa::component::interactionforcefield::SpringForceField< DataTypes >::SpringForceField ( MechanicalState object1,
MechanicalState object2,
SReal  _ks = 100.0,
SReal  _kd = 5.0 
)
protected

Function details

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::addDForce ( const core::MechanicalParams mparams,
DataVecDeriv df1,
DataVecDeriv df2,
const DataVecDeriv dx1,
const DataVecDeriv dx2 
)
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 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.

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

Reimplemented in sofa::component::interactionforcefield::StiffSpringForceField< DataTypes >.

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::addForce ( const core::MechanicalParams mparams,
DataVecDeriv f1,
DataVecDeriv f2,
const DataVecCoord x1,
const DataVecCoord x2,
const DataVecDeriv v1,
const DataVecDeriv v2 
)
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 must be implemented by the component, and is usually called by the generic ForceField::addForce() method.

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

Reimplemented in sofa::component::interactionforcefield::StiffSpringForceField< DataTypes >.

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::addKToMatrix ( sofa::defaulttype::BaseMatrix ,
SReal  ,
unsigned int  
)
virtual
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::addSpring ( int  m1,
int  m2,
SReal  ks,
SReal  kd,
SReal  initlen 
)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::addSpring ( const Spring spring)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::addSpringForce ( Real potentialEnergy,
VecDeriv f1,
const VecCoord p1,
const VecDeriv v1,
VecDeriv f2,
const VecCoord p2,
const VecDeriv v2,
int  ,
const Spring spring 
)
protectedvirtual
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::clear ( int  reserve = 0)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::draw ( const core::visual::VisualParams )
overridevirtual

Render internal data of this object, for debugging purposes.

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

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::exportGnuplot ( SReal  time)
overridevirtual

export kinetic and potential energy state at "time" to a gnuplot file

Reimplemented from sofa::core::behavior::BaseInteractionForceField.

template<class DataTypes >
SReal sofa::component::interactionforcefield::SpringForceField< DataTypes >::getArrowSize ( ) const
inline
template<class DataTypes >
SReal sofa::component::interactionforcefield::SpringForceField< DataTypes >::getDamping ( ) const
inline
template<class DataTypes >
int sofa::component::interactionforcefield::SpringForceField< DataTypes >::getDrawMode ( ) const
inline
template<class DataTypes >
SReal sofa::component::interactionforcefield::SpringForceField< DataTypes >::getPotentialEnergy ( const core::MechanicalParams mparams,
const DataVecCoord x1,
const DataVecCoord x2 
) 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 must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.

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

template<class DataTypes >
const sofa::helper::vector< Spring >& sofa::component::interactionforcefield::SpringForceField< DataTypes >::getSprings ( ) const
inline
template<class DataTypes >
SReal sofa::component::interactionforcefield::SpringForceField< DataTypes >::getStiffness ( ) const
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::handleTopologyChange ( core::topology::Topology t)
overridevirtual

Handle topological Changes from a given Topology

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

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::init ( void  )
overridevirtual

Initialization method called at graph creation and modification, during top-down traversal.

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

Reimplemented in sofa::component::interactionforcefield::StiffSpringForceField< DataTypes >.

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::initGnuplot ( const std::string  path)
overridevirtual

initialization to export kinetic, potential energy and force intensity to gnuplot files format

Reimplemented from sofa::core::behavior::BaseInteractionForceField.

template<class DataTypes >
bool sofa::component::interactionforcefield::SpringForceField< DataTypes >::load ( const char *  filename)
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::reinit ( )
overridevirtual

Update method called when variables used in precomputation are modified.

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

template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::removeSpring ( unsigned int  idSpring)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::setArrowSize ( float  s)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::setDamping ( SReal  _kd)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::setDrawMode ( int  m)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::setStiffness ( SReal  _ks)
inline
template<class DataTypes >
void sofa::component::interactionforcefield::SpringForceField< DataTypes >::updateForceMask ( )
overridevirtual

Useful when the forcefield is applied only on a subset of dofs. It is automatically called by addForce.

That way, we can optimize the time spent to transfer quantities through the mechanical mappings. Every Dofs are inserted by default. The forcefields using only a subset of dofs should only insert these dofs in the mask.

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

Related details

template<class DataTypes >
friend class SpringForceFieldInternalData< DataTypes >
friend