SOFA API  b11f9b8c
Open source framework for multi-physics simuation
sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes > Class Template Reference

#include <MeshSpringForceField.h>

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

Protected Attributes

Data< Reald_linesStiffness
 Stiffness for the Lines. More...
 
Data< Reald_linesDamping
 Damping for the Lines. More...
 
Data< Reald_trianglesStiffness
 Stiffness for the Triangles. More...
 
Data< Reald_trianglesDamping
 Damping for the Triangles. More...
 
Data< Reald_quadsStiffness
 Stiffness for the Quads. More...
 
Data< Reald_quadsDamping
 Damping for the Quads. More...
 
Data< Reald_tetrahedraStiffness
 Stiffness for the Tetrahedra. More...
 
Data< Reald_tetrahedraDamping
 Damping for the Tetrahedra. More...
 
Data< Reald_cubesStiffness
 Stiffness for the Cubes. More...
 
Data< Reald_cubesDamping
 Damping for the Cubes. More...
 
Data< boold_noCompression
 Only consider elongation. More...
 
Data< Reald_drawMinElongationRange
 Min range of elongation (red eongation - blue neutral - green compression) More...
 
Data< Reald_drawMaxElongationRange
 Max range of elongation (red eongation - blue neutral - green compression) More...
 
Data< Reald_drawSpringSize
 Size of drawed lines. More...
 
Data< type::Vec< 2, sofa::Index > > d_localRange
 optional range of local DOF indices. Any computation involving only indices outside of this range are discarded (useful for parallelization using mesh partitionning) More...
 
SingleLink< MeshSpringForceField< DataTypes >, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKl_topology
 Link to be set to the topology container in the component graph. More...
 
- Protected Attributes inherited from sofa::component::solidmechanics::spring::StiffSpringForceField< DataTypes >
sofa::type::vector< Matdfdx
 
- Protected Attributes inherited from sofa::component::solidmechanics::spring::SpringForceField< DataTypes >
core::objectmodel::DataFileName fileSprings
 
std::array< sofa::core::topology::TopologySubsetIndices, 2 > d_springsIndices
 
bool areSpringIndicesDirty { true }
 
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::StateAccessor
MultiLink< StateAccessor, BaseMechanicalState, BaseLink::FLAG_DUPLICATEl_mechanicalStates
 
- 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
std::map< std::string, sofa::core::DataTrackerCallbackm_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< DataTypes1, DataTypes2 >
SingleLink< PairStateAccessor< DataTypes1, DataTypes2 >, MechanicalState< DataTypes1 >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKmstate1
 
SingleLink< PairStateAccessor< DataTypes1, DataTypes2 >, MechanicalState< DataTypes2 >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKmstate2
 

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE(MeshSpringForceField, DataTypes), SOFA_TEMPLATE(StiffSpringForceField, DataTypes))
 
Real getStiffness () const
 
Real getLinesStiffness () const
 
Real getTrianglesStiffness () const
 
Real getQuadsStiffness () const
 
Real getTetrahedraStiffness () const
 
Real getCubesStiffness () const
 
void setStiffness (Real val)
 
void setLinesStiffness (Real val)
 
void setTrianglesStiffness (Real val)
 
void setQuadsStiffness (Real val)
 
void setTetrahedraStiffness (Real val)
 
void setCubesStiffness (Real val)
 
Real getDamping () const
 
Real getLinesDamping () const
 
Real getTrianglesDamping () const
 
Real getQuadsDamping () const
 
Real getTetrahedraDamping () const
 
Real getCubesDamping () const
 
void setDamping (Real val)
 
void setLinesDamping (Real val)
 
void setTrianglesDamping (Real val)
 
void setQuadsDamping (Real val)
 
void setTetrahedraDamping (Real val)
 
void setCubesDamping (Real val)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. More...
 
- Public Member Functions inherited from sofa::component::solidmechanics::spring::StiffSpringForceField< DataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(StiffSpringForceField, DataTypes), SOFA_TEMPLATE(SpringForceField, DataTypes))
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void addForce (const sofa::core::MechanicalParams *mparams, DataVecDeriv &data_f1, DataVecDeriv &data_f2, const DataVecCoord &data_x1, const DataVecCoord &data_x2, const DataVecDeriv &data_v1, const DataVecDeriv &data_v2) override
 Accumulate f corresponding to x,v. More...
 
void addDForce (const core::MechanicalParams *mparams, DataVecDeriv &data_df1, DataVecDeriv &data_df2, const DataVecDeriv &data_dx1, const DataVecDeriv &data_dx2) override
 Accumulate df corresponding to dx. More...
 
void addKToMatrix (const sofa::core::MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Compute the system matrix corresponding to $ k K $. More...
 
void buildStiffnessMatrix (core::behavior::StiffnessMatrix *matrix) override
 
- Public Member Functions inherited from sofa::component::solidmechanics::spring::SpringForceField< DataTypes >
 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::type::vector< Spring > & getSprings () const
 
void reinit () override
 Update method called when variables used in precomputation are modified. More...
 
SReal getPotentialEnergy (const core::MechanicalParams *, const DataVecCoord &data_x1, const DataVecCoord &data_x2) const override
 
virtual void addKToMatrix (sofa::linearalgebra::BaseMatrix *, SReal, unsigned int &)
 
void buildDampingMatrix (core::behavior::DampingMatrix *) override
 
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 computeBBox (const core::ExecParams *params, bool onlyVisible=false) override
 
void clear (sofa::Size reserve=0)
 
void removeSpring (sofa::Index idSpring)
 
void addSpring (sofa::Index m1, sofa::Index m2, SReal ks, SReal kd, SReal initlen)
 
void addSpring (const Spring &spring)
 
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_CLASS2 (SOFA_TEMPLATE(PairInteractionForceField, DataTypes), BaseInteractionForceField, SOFA_TEMPLATE2(PairStateAccessor, DataTypes, DataTypes))
 
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...
 
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)
 
virtual BaseMechanicalStategetMechModel1 ()
 
virtual BaseMechanicalStategetMechModel2 ()
 
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, 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 $ b B $. More...
 
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 const sofa::linearalgebra::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::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)
 
BasefindLinkDestClass (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 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)
 
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...
 
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
 
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::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 (::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 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)
 
- Public Member Functions inherited from sofa::core::behavior::PairStateAccessor< DataTypes1, DataTypes2 >
 SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE2(PairStateAccessor, DataTypes1, DataTypes2), StateAccessor)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
MechanicalState< DataTypes1 > * getMState1 ()
 Retrieve the associated MechanicalState #1. More...
 
const MechanicalState< DataTypes1 > * getMState1 () const
 Retrieve the associated MechanicalState #1. More...
 
BaseMechanicalStategetMechModel1 ()
 Retrieve the associated MechanicalState #1 as a BaseMechanicalState. More...
 
const BaseMechanicalStategetMechModel1 () const
 Retrieve the associated MechanicalState #1 as a BaseMechanicalState. More...
 
MechanicalState< DataTypes2 > * getMState2 ()
 Retrieve the associated MechanicalState #2. More...
 
const MechanicalState< DataTypes2 > * getMState2 () const
 Retrieve the associated MechanicalState #2. More...
 
BaseMechanicalStategetMechModel2 ()
 Retrieve the associated MechanicalState #2 as a BaseMechanicalState. More...
 
const BaseMechanicalStategetMechModel2 () const
 Retrieve the associated MechanicalState #2 as a BaseMechanicalState. More...
 

Protected Member Functions

void addSpring (std::set< std::pair< sofa::Index, sofa::Index > > &sset, sofa::Index m1, sofa::Index m2, Real stiffness, Real damping)
 
 MeshSpringForceField ()
 
virtual ~MeshSpringForceField ()
 
- Protected Member Functions inherited from sofa::component::solidmechanics::spring::StiffSpringForceField< DataTypes >
void addSpringForce (Real &potentialEnergy, VecDeriv &f1, const VecCoord &p1, const VecDeriv &v1, VecDeriv &f2, const VecCoord &p2, const VecDeriv &v2, sofa::Index i, const Spring &spring) override
 Accumulate the spring force and compute and store its stiffness. More...
 
std::unique_ptr< SpringForcecomputeSpringForce (const VecCoord &p1, const VecDeriv &v1, const VecCoord &p2, const VecDeriv &v2, const Spring &spring) override
 
virtual void addSpringDForce (VecDeriv &df1, const VecDeriv &dx1, VecDeriv &df2, const VecDeriv &dx2, sofa::Index i, const Spring &spring, SReal kFactor, SReal bFactor)
 Apply the stiffness, i.e. accumulate df given dx. More...
 
virtual DataTypes::DPos computeSpringDForce (VecDeriv &df1, const VecDeriv &dx1, VecDeriv &df2, const VecDeriv &dx2, sofa::Index i, const Spring &spring, SReal kFactor, SReal bFactor)
 
 StiffSpringForceField (SReal ks=100.0, SReal kd=5.0)
 
 StiffSpringForceField (MechanicalState *object1, MechanicalState *object2, SReal ks=100.0, SReal kd=5.0)
 
void createSpringsFromInputs ()
 Will create the set of springs using. More...
 
- Protected Member Functions inherited from sofa::component::solidmechanics::spring::SpringForceField< DataTypes >
void initializeTopologyHandler (sofa::core::topology::TopologySubsetIndices &indices, core::topology::BaseMeshTopology *topology, sofa::Index mstateId)
 
void updateTopologyIndicesFromSprings ()
 
void applyRemovedPoints (const sofa::core::topology::PointsRemoved *pointsRemoved, sofa::Index mstateId)
 
void applyRemovedEdges (const sofa::core::topology::EdgesRemoved *edgesRemoved, sofa::Index mstateId)
 
 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=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< DataTypes1, DataTypes2 >
 PairStateAccessor (MechanicalState< DataTypes1 > *mm1, MechanicalState< DataTypes2 > *mm2)
 
 ~PairStateAccessor () override=default
 

Additional Inherited Members

- Public Attributes inherited from sofa::component::solidmechanics::spring::StiffSpringForceField< DataTypes >
SetIndex d_indices1
 Indices of the source points on the first model. More...
 
SetIndex d_indices2
 Indices of the fixed points on the second model. More...
 
core::objectmodel::Data< sofa::type::vector< SReal > > d_lengths
 List of lengths to create the springs. Must have the same than indices1 & indices2, or if only one element, it will be applied to all springs. If empty, 0 will be applied everywhere. More...
 
- Public Attributes inherited from sofa::component::solidmechanics::spring::SpringForceField< DataTypes >
Data< SReal > ks
 uniform stiffness for the all springs More...
 
Data< SReal > kd
 uniform damping for the all springs More...
 
Data< floatshowArrowSize
 size of the axis More...
 
Data< int > drawMode
 
Data< sofa::type::vector< Spring > > springs
 Draw Mode: 0=Line - 1=Cylinder - 2=Arrow. More...
 
- Public Attributes inherited from sofa::core::behavior::BaseForceField
Data< SReal > rayleighStiffness
 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
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
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::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 
- Static Public Attributes inherited from sofa::component::solidmechanics::spring::StiffSpringForceField< DataTypes >
static constexpr auto N = DataTypes::spatial_dimensions
 
- 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 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 BaseClassGetClass ()
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 
- Static Protected Member Functions inherited from sofa::component::solidmechanics::spring::StiffSpringForceField< DataTypes >
template<class Matrix >
static void addToMatrix (Matrix *globalMatrix, const unsigned int offsetRow, const unsigned int offsetCol, const Mat &localMatrix)
 

Attribute details

◆ d_cubesDamping

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_cubesDamping
protected

Damping for the Cubes.

◆ d_cubesStiffness

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_cubesStiffness
protected

Stiffness for the Cubes.

◆ d_drawMaxElongationRange

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_drawMaxElongationRange
protected

Max range of elongation (red eongation - blue neutral - green compression)

◆ d_drawMinElongationRange

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_drawMinElongationRange
protected

Min range of elongation (red eongation - blue neutral - green compression)

◆ d_drawSpringSize

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_drawSpringSize
protected

Size of drawed lines.

◆ d_linesDamping

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_linesDamping
protected

Damping for the Lines.

◆ d_linesStiffness

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_linesStiffness
protected

Stiffness for the Lines.

◆ d_localRange

template<class DataTypes >
Data< type::Vec<2, sofa::Index> > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_localRange
protected

optional range of local DOF indices. Any computation involving only indices outside of this range are discarded (useful for parallelization using mesh partitionning)

◆ d_noCompression

template<class DataTypes >
Data< bool > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_noCompression
protected

Only consider elongation.

◆ d_quadsDamping

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_quadsDamping
protected

Damping for the Quads.

◆ d_quadsStiffness

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_quadsStiffness
protected

Stiffness for the Quads.

◆ d_tetrahedraDamping

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_tetrahedraDamping
protected

Damping for the Tetrahedra.

◆ d_tetrahedraStiffness

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_tetrahedraStiffness
protected

Stiffness for the Tetrahedra.

◆ d_trianglesDamping

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_trianglesDamping
protected

Damping for the Triangles.

◆ d_trianglesStiffness

template<class DataTypes >
Data< Real > sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::d_trianglesStiffness
protected

Stiffness for the Triangles.

◆ l_topology

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

Constructor details

◆ MeshSpringForceField()

◆ ~MeshSpringForceField()

Function details

◆ addSpring()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::addSpring ( std::set< std::pair< sofa::Index, sofa::Index > > &  sset,
sofa::Index  m1,
sofa::Index  m2,
Real  stiffness,
Real  damping 
)
protected

◆ draw()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::draw ( const core::visual::VisualParams )
overridevirtual

Render internal data of this object, for debugging purposes.

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

◆ getCubesDamping()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getCubesDamping ( ) const
inline

◆ getCubesStiffness()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getCubesStiffness ( ) const
inline

◆ getDamping()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getDamping ( ) const
inline

◆ getLinesDamping()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getLinesDamping ( ) const
inline

◆ getLinesStiffness()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getLinesStiffness ( ) const
inline

◆ getQuadsDamping()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getQuadsDamping ( ) const
inline

◆ getQuadsStiffness()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getQuadsStiffness ( ) const
inline

◆ getStiffness()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getStiffness ( ) const
inline

◆ getTetrahedraDamping()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getTetrahedraDamping ( ) const
inline

◆ getTetrahedraStiffness()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getTetrahedraStiffness ( ) const
inline

◆ getTrianglesDamping()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getTrianglesDamping ( ) const
inline

◆ getTrianglesStiffness()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::getTrianglesStiffness ( ) const
inline

◆ init()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::init ( void  )
overridevirtual

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

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

◆ setCubesDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setCubesDamping ( Real  val)
inline

◆ setCubesStiffness()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setCubesStiffness ( Real  val)
inline

◆ setDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setDamping ( Real  val)
inline

◆ setLinesDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setLinesDamping ( Real  val)
inline

◆ setLinesStiffness()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setLinesStiffness ( Real  val)
inline

◆ setQuadsDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setQuadsDamping ( Real  val)
inline

◆ setQuadsStiffness()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setQuadsStiffness ( Real  val)
inline

◆ setStiffness()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setStiffness ( Real  val)
inline

◆ setTetrahedraDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setTetrahedraDamping ( Real  val)
inline

◆ setTetrahedraStiffness()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setTetrahedraStiffness ( Real  val)
inline

◆ setTrianglesDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setTrianglesDamping ( Real  val)
inline

◆ setTrianglesStiffness()

template<class DataTypes >
void sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::setTrianglesStiffness ( Real  val)
inline

◆ SOFA_CLASS()

template<class DataTypes >
sofa::component::solidmechanics::spring::MeshSpringForceField< DataTypes >::SOFA_CLASS ( SOFA_TEMPLATE(MeshSpringForceField< DataTypes >, DataTypes ,
SOFA_TEMPLATE(StiffSpringForceField, DataTypes  
)