SOFA API  ca665544
Open source framework for multi-physics simuation
sofa::component::mass::UniformMass< DataTypes > Class Template Reference

#include <UniformMass.h>

Inheritance diagram for sofa::component::mass::UniformMass< DataTypes >:

Public Attributes

Data< MassTyped_vertexMass
 single value defining the mass of each particle More...
 
Data< SReald_totalMass
 if >0 : total mass of this body More...
 
sofa::core::objectmodel::DataFileName d_filenameMass
 a .rigid file to automatically load the inertia matrix and other parameters More...
 
Data< boold_showCenterOfGravity
 display the center of gravity of the system More...
 
Data< floatd_showAxisSize
 factor length of the axis displayed (only used for rigids) More...
 
Data< boold_computeMappingInertia
 to be used if the mass is placed under a mapping More...
 
Data< boold_showInitialCenterOfGravity
 display the initial center of gravity of the system More...
 
Data< boold_showX0
 display the rest positions More...
 
Data< type::Vec< 2, int > > d_localRange
 
DataSetIndex d_indices
 optional local DOF indices. Any computation involving only indices outside of this list are discarded More...
 
Data< boold_preserveTotalMass
 Prevent totalMass from decreasing when removing particles. More...
 
bool m_isTotalMassUsed
 Boolean specifying whether the data totalMass has been initially given (else vertexMass vector is being used) More...
 
SingleLink< UniformMass< 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...
 
- Public Attributes inherited from sofa::core::behavior::BaseForceField
Data< SRealrayleighStiffness
 Rayleigh Damping stiffness matrix coefficient. More...
 
objectmodel::lifecycle::DeprecatedData isCompliance
 Considered as compliance, else considered as stiffness (default to false) More...
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< 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 object belongs to More...
 
Data< sofa::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 
- Public Attributes inherited from sofa::core::behavior::BaseMass
Data< boolm_separateGravity
 
Data< SRealrayleighMass
 Rayleigh Damping mass matrix coefficient. More...
 

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE(UniformMass, DataTypes), SOFA_TEMPLATE(core::behavior::Mass, DataTypes))
 
sofa::core::objectmodel::ComponentState updateFromTotalMass ()
 Functions updating data. More...
 
sofa::core::objectmodel::ComponentState updateFromVertexMass ()
 
void addMDx (const core::MechanicalParams *mparams, DataVecDeriv &f, const DataVecDeriv &dx, SReal factor) override
 
void accFromF (const core::MechanicalParams *mparams, DataVecDeriv &a, const DataVecDeriv &f) override
 
void addForce (const core::MechanicalParams *mparams, DataVecDeriv &f, const DataVecCoord &x, const DataVecDeriv &v) override
 
SReal getKineticEnergy (const core::MechanicalParams *mparams, const DataVecDeriv &d_v) const override
 vMv/2 using dof->getV() override More...
 
SReal getPotentialEnergy (const core::MechanicalParams *mparams, const DataVecCoord &x) const override
 Mgx potential in a uniform gravity field, null at origin. More...
 
type::Vec6 getMomentum (const core::MechanicalParams *mparams, const DataVecCoord &x, const DataVecDeriv &v) const override
 (Mv,cross(x,Mv)+Iw) override More...
 
void addMDxToVector (linearalgebra::BaseVector *resVect, const VecDeriv *dx, SReal mFact, unsigned int &offset)
 
void addGravityToV (const core::MechanicalParams *mparams, DataVecDeriv &d_v) override
 
void addMToMatrix (sofa::linearalgebra::BaseMatrix *mat, SReal mFact, unsigned int &offset) override
 Add Mass contribution to global Matrix assembling. More...
 
void buildMassMatrix (sofa::core::behavior::MassMatrixAccumulator *matrices) override
 Add Mass contribution to global Matrix assembling. More...
 
void buildStiffnessMatrix (core::behavior::StiffnessMatrix *) override
 
void buildDampingMatrix (core::behavior::DampingMatrix *) override
 
SReal getElementMass (sofa::Index index) const override
 Get the mass relative to the DOF at index. More...
 
void getElementMass (sofa::Index index, linearalgebra::BaseMatrix *m) const override
 Get the matrix relative to the DOF at index. More...
 
bool isDiagonal () const override
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. More...
 
void parse (sofa::core::objectmodel::BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
template<class T >
void loadFromFileRigidImpl (const string &filename)
 
template<class T >
Vec6 getMomentumRigid3DImpl (const MechanicalParams *, const DataVecCoord &d_x, const DataVecDeriv &d_v) const
 
template<class T >
Vec6 getMomentumVec3DImpl (const MechanicalParams *, const DataVecCoord &d_x, const DataVecDeriv &d_v) const
 
SOFA_COMPONENT_MASS_API void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
SOFA_COMPONENT_MASS_API void loadRigidMass (const string &filename)
 
SOFA_COMPONENT_MASS_API void draw (const VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
SOFA_COMPONENT_MASS_API void draw (const VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
SOFA_COMPONENT_MASS_API SReal getPotentialEnergy (const MechanicalParams *params, const DataVecCoord &d_x) const
 
SOFA_COMPONENT_MASS_API SReal getPotentialEnergy (const MechanicalParams *params, const DataVecCoord &vx) const
 
SOFA_COMPONENT_MASS_API void draw (const core::visual::VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
SOFA_COMPONENT_MASS_API void addMDxToVector (linearalgebra::BaseVector *resVect, const VecDeriv *dx, SReal mFact, unsigned int &offset)
 
SOFA_COMPONENT_MASS_API Vec6 getMomentum (const MechanicalParams *params, const DataVecCoord &d_x, const DataVecDeriv &d_v) const
 
SOFA_COMPONENT_MASS_API Vec6 getMomentum (const MechanicalParams *params, const DataVecCoord &d_x, const DataVecDeriv &d_v) const
 
void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void loadRigidMass (const std::string &)
 
void draw (const core::visual::VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
void draw (const core::visual::VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
SReal getPotentialEnergy (const core::MechanicalParams *, const DataVecCoord &x) const
 
SReal getPotentialEnergy (const core::MechanicalParams *, const DataVecCoord &x) const
 
void draw (const core::visual::VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
Read and write access functions in mass information
void setMass (const MassType &d_vertexMass)
 
const MassTypegetVertexMass () const
 
const MassTypegetMass () const
 
SReal getTotalMass () const
 
void setTotalMass (SReal m)
 
void setFileMass (const std::string &file)
 }@ More...
 
std::string getFileMass () const
 
void loadRigidMass (const std::string &filename)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void initDefaultImpl ()
 
Check and standard initialization functions from mass information
virtual bool checkVertexMass ()
 
virtual void initFromVertexMass ()
 
virtual bool checkTotalMass ()
 
virtual void initFromTotalMass ()
 
- Public Member Functions inherited from sofa::core::behavior::Mass< DataTypes >
 SOFA_CLASS2 (SOFA_TEMPLATE(Mass, DataTypes), SOFA_TEMPLATE(ForceField, DataTypes), BaseMass)
 
void initGnuplot (const std::string path) override
 initialization to export kinetic and potential energy to gnuplot files format More...
 
void exportGnuplot (const MechanicalParams *mparams, SReal time) override
 export kinetic and potential energy state at "time" to a gnuplot file More...
 
void addGravityToV (const MechanicalParams *mparams, MultiVecDerivId) override
 perform v += dt*g operation. Used if mass wants to added G separately from the other forces to v. More...
 
SReal getElementMass (sofa::Index) const override
 recover the mass of an element More...
 
void getElementMass (sofa::Index index, linearalgebra::BaseMatrix *m) const override
 Get the matrix relative to the DOF at index. More...
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
void addMDx (const MechanicalParams *mparams, MultiVecDerivId fid, SReal factor) override
 f += factor M dx More...
 
void accFromF (const MechanicalParams *mparams, MultiVecDerivId aid) override
 
void addDForce (const MechanicalParams *, DataVecDeriv &, const DataVecDeriv &) override
 Mass forces (gravity) often have null derivative. More...
 
void addMBKdx (const MechanicalParams *mparams, MultiVecDerivId dfId) override
 
SReal getKineticEnergy (const MechanicalParams *mparams) const override
 
SReal getPotentialEnergy (const MechanicalParams *mparams) const override
 
type::Vec6 getMomentum (const MechanicalParams *mparams) const override
 
void addKToMatrix (sofa::linearalgebra::BaseMatrix *, SReal, unsigned int &) override
 
void addBToMatrix (sofa::linearalgebra::BaseMatrix *, SReal, unsigned int &) override
 
void addMToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Add Mass contribution to global Matrix assembling. More...
 
void addMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 
- 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
 
virtual void addClambda (const MechanicalParams *mparams, DataVecDeriv &df, const DataVecDeriv &lambda, SReal cFactor)
 
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...
 
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 $ k K $. More...
 
void addBToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Compute the system matrix corresponding to $ b B $. More...
 
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)
 
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...
 
virtual void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
void updateInternal ()
 Update method called when variables (used to compute other internal variables) are modified. More...
 
virtual void storeResetState ()
 Save the initial state for later uses in reset() More...
 
virtual void reset ()
 Reset to initial state. More...
 
virtual void cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const 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::SingleStateAccessor< DataTypes >
 SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE(SingleStateAccessor, DataTypes), StateAccessor)
 
MechanicalState< DataTypes > * getMState ()
 
const MechanicalState< DataTypes > * getMState () const
 
- Public Member Functions inherited from sofa::core::behavior::BaseMass
 SOFA_ABSTRACT_CLASS (BaseMass, StateAccessor)
 

Protected Member Functions

 UniformMass ()
 
 ~UniformMass ()
 
void constructor_message ()
 
SOFA_COMPONENT_MASS_API void constructor_message ()
 
- Protected Member Functions inherited from sofa::core::behavior::Mass< DataTypes >
 Mass (MechanicalState< DataTypes > *mm=nullptr)
 
 ~Mass () override
 
- 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
 
- Protected Member Functions inherited from sofa::core::behavior::BaseMass
 BaseMass ()
 
 ~BaseMass () override=default
 

Additional Inherited Members

- Protected Attributes inherited from sofa::core::behavior::Mass< DataTypes >
std::unique_ptr< std::ofstream > m_gnuplotFileEnergy
 stream to export Kinematic, Potential and Mechanical 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::SingleStateAccessor< DataTypes >
SingleLink< SingleStateAccessor< DataTypes >, MechanicalState< DataTypes >, BaseLink::FLAG_STRONGLINKmstate
 
- 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 BaseClassGetClass ()
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

◆ d_computeMappingInertia

template<class DataTypes >
Data<bool> sofa::component::mass::UniformMass< DataTypes >::d_computeMappingInertia

to be used if the mass is placed under a mapping

◆ d_filenameMass

a .rigid file to automatically load the inertia matrix and other parameters

◆ d_indices

template<class DataTypes >
DataSetIndex sofa::component::mass::UniformMass< DataTypes >::d_indices

optional local DOF indices. Any computation involving only indices outside of this list are discarded

◆ d_localRange

template<class DataTypes >
Data< type::Vec<2,int> > sofa::component::mass::UniformMass< DataTypes >::d_localRange

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

◆ d_preserveTotalMass

template<class DataTypes >
Data<bool> sofa::component::mass::UniformMass< DataTypes >::d_preserveTotalMass

Prevent totalMass from decreasing when removing particles.

◆ d_showAxisSize

template<class DataTypes >
Data<float> sofa::component::mass::UniformMass< DataTypes >::d_showAxisSize

factor length of the axis displayed (only used for rigids)

◆ d_showCenterOfGravity

template<class DataTypes >
Data<bool> sofa::component::mass::UniformMass< DataTypes >::d_showCenterOfGravity

display the center of gravity of the system

◆ d_showInitialCenterOfGravity

template<class DataTypes >
Data<bool> sofa::component::mass::UniformMass< DataTypes >::d_showInitialCenterOfGravity

display the initial center of gravity of the system

◆ d_showX0

template<class DataTypes >
Data<bool> sofa::component::mass::UniformMass< DataTypes >::d_showX0

display the rest positions

◆ d_totalMass

template<class DataTypes >
Data<SReal> sofa::component::mass::UniformMass< DataTypes >::d_totalMass

if >0 : total mass of this body

◆ d_vertexMass

template<class DataTypes >
Data<MassType> sofa::component::mass::UniformMass< DataTypes >::d_vertexMass

single value defining the mass of each particle

◆ l_topology

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

◆ m_isTotalMassUsed

template<class DataTypes >
bool sofa::component::mass::UniformMass< DataTypes >::m_isTotalMassUsed

Boolean specifying whether the data totalMass has been initially given (else vertexMass vector is being used)

Constructor details

◆ UniformMass()

template<class DataTypes >
sofa::component::mass::UniformMass< DataTypes >::UniformMass
protected

◆ ~UniformMass()

template<class DataTypes >
sofa::component::mass::UniformMass< DataTypes >::~UniformMass
protected

Function details

◆ accFromF()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::accFromF ( const core::MechanicalParams mparams,
DataVecDeriv a,
const DataVecDeriv f 
)
overridevirtual

◆ addForce()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::addForce ( const core::MechanicalParams ,
DataVecDeriv f,
const DataVecCoord x,
const DataVecDeriv v 
)
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 is the method that should be implemented by the component

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

◆ addGravityToV()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::addGravityToV ( const core::MechanicalParams mparams,
DataVecDeriv d_v 
)
overridevirtual

◆ addMDx()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::addMDx ( const core::MechanicalParams mparams,
DataVecDeriv f,
const DataVecDeriv dx,
SReal  factor 
)
overridevirtual

◆ addMDxToVector() [1/2]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Vec3Types >::addMDxToVector ( linearalgebra::BaseVector resVect,
const VecDeriv dx,
SReal  mFact,
unsigned int &  offset 
)

◆ addMDxToVector() [2/2]

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::addMDxToVector ( linearalgebra::BaseVector resVect,
const VecDeriv dx,
SReal  mFact,
unsigned int &  offset 
)

◆ addMToMatrix()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::addMToMatrix ( sofa::linearalgebra::BaseMatrix mat,
SReal  mFact,
unsigned int &  offset 
)
overridevirtual

Add Mass contribution to global Matrix assembling.

Reimplemented from sofa::core::behavior::Mass< DataTypes >.

◆ buildDampingMatrix()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::buildDampingMatrix ( core::behavior::DampingMatrix )
inlineoverridevirtual

◆ buildMassMatrix()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::buildMassMatrix ( sofa::core::behavior::MassMatrixAccumulator matrices)
overridevirtual

Add Mass contribution to global Matrix assembling.

Reimplemented from sofa::core::behavior::BaseMass.

◆ buildStiffnessMatrix()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::buildStiffnessMatrix ( core::behavior::StiffnessMatrix )
inlineoverridevirtual

◆ checkTotalMass()

template<class DataTypes >
bool sofa::component::mass::UniformMass< DataTypes >::checkTotalMass
virtual

◆ checkVertexMass()

template<class DataTypes >
bool sofa::component::mass::UniformMass< DataTypes >::checkVertexMass
virtual

◆ constructor_message() [1/2]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Rigid3Types >::constructor_message ( )
protected

◆ constructor_message() [2/2]

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::constructor_message
protected

◆ draw() [1/7]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Vec6Types >::draw ( const core::visual::VisualParams )
virtual

Render internal data of this object, for debugging purposes.

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

◆ draw() [2/7]

Render internal data of this object, for debugging purposes.

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

◆ draw() [3/7]

Render internal data of this object, for debugging purposes.

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

◆ draw() [4/7]

Render internal data of this object, for debugging purposes.

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

◆ draw() [5/7]

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::draw ( const core::visual::VisualParams )
overridevirtual

Render internal data of this object, for debugging purposes.

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

◆ draw() [6/7]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Rigid3Types >::draw ( const VisualParams )
virtual

Render internal data of this object, for debugging purposes.

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

◆ draw() [7/7]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Rigid2Types >::draw ( const VisualParams )
virtual

Render internal data of this object, for debugging purposes.

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

◆ getElementMass() [1/2]

template<class DataTypes >
SReal sofa::component::mass::UniformMass< DataTypes >::getElementMass ( sofa::Index  index) const
overridevirtual

Get the mass relative to the DOF at index.

Implements sofa::core::behavior::BaseMass.

◆ getElementMass() [2/2]

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::getElementMass ( sofa::Index  index,
linearalgebra::BaseMatrix m 
) const
overridevirtual

Get the matrix relative to the DOF at index.

Implements sofa::core::behavior::BaseMass.

◆ getFileMass()

template<class DataTypes >
std::string sofa::component::mass::UniformMass< DataTypes >::getFileMass ( ) const
inline

◆ getKineticEnergy()

template<class DataTypes >
SReal sofa::component::mass::UniformMass< DataTypes >::getKineticEnergy ( const core::MechanicalParams mparams,
const DataVecDeriv d_v 
) const
overridevirtual

vMv/2 using dof->getV() override

Reimplemented from sofa::core::behavior::Mass< DataTypes >.

◆ getMass()

template<class DataTypes >
const MassType& sofa::component::mass::UniformMass< DataTypes >::getMass ( ) const
inline

◆ getMomentum() [1/3]

template<class DataTypes >
type::Vec6 sofa::component::mass::UniformMass< DataTypes >::getMomentum ( const core::MechanicalParams mparams,
const DataVecCoord x,
const DataVecDeriv v 
) const
overridevirtual

(Mv,cross(x,Mv)+Iw) override

Reimplemented from sofa::core::behavior::Mass< DataTypes >.

◆ getMomentum() [2/3]

SOFA_COMPONENT_MASS_API Vec6 sofa::component::mass::UniformMass< Vec3Types >::getMomentum ( const MechanicalParams params,
const DataVecCoord d_x,
const DataVecDeriv d_v 
) const
virtual

◆ getMomentum() [3/3]

SOFA_COMPONENT_MASS_API Vec6 sofa::component::mass::UniformMass< Rigid3Types >::getMomentum ( const MechanicalParams params,
const DataVecCoord d_x,
const DataVecDeriv d_v 
) const
virtual

◆ getMomentumRigid3DImpl()

template<class DataTypes >
template<class T >
Vec6 sofa::component::mass::UniformMass< DataTypes >::getMomentumRigid3DImpl ( const MechanicalParams ,
const DataVecCoord d_x,
const DataVecDeriv d_v 
) const

◆ getMomentumVec3DImpl()

template<class DataTypes >
template<class T >
Vec6 sofa::component::mass::UniformMass< DataTypes >::getMomentumVec3DImpl ( const MechanicalParams ,
const DataVecCoord d_x,
const DataVecDeriv d_v 
) const

◆ getPotentialEnergy() [1/5]

SReal sofa::component::mass::UniformMass< defaulttype::Rigid3Types >::getPotentialEnergy ( const core::MechanicalParams ,
const DataVecCoord x 
) const
virtual

◆ getPotentialEnergy() [2/5]

SReal sofa::component::mass::UniformMass< defaulttype::Rigid2Types >::getPotentialEnergy ( const core::MechanicalParams ,
const DataVecCoord x 
) const
virtual

◆ getPotentialEnergy() [3/5]

template<class DataTypes >
SReal sofa::component::mass::UniformMass< DataTypes >::getPotentialEnergy ( const core::MechanicalParams mparams,
const DataVecCoord x 
) const
overridevirtual

Mgx potential in a uniform gravity field, null at origin.

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

◆ getPotentialEnergy() [4/5]

SOFA_COMPONENT_MASS_API SReal sofa::component::mass::UniformMass< Rigid3Types >::getPotentialEnergy ( const MechanicalParams params,
const DataVecCoord d_x 
) const
virtual

◆ getPotentialEnergy() [5/5]

SOFA_COMPONENT_MASS_API SReal sofa::component::mass::UniformMass< Rigid2Types >::getPotentialEnergy ( const MechanicalParams params,
const DataVecCoord vx 
) const
virtual

◆ getTotalMass()

template<class DataTypes >
SReal sofa::component::mass::UniformMass< DataTypes >::getTotalMass ( ) const
inline

◆ getVertexMass()

template<class DataTypes >
const MassType& sofa::component::mass::UniformMass< DataTypes >::getVertexMass ( ) const
inline

◆ init() [1/3]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Rigid3Types >::init ( void  )
virtual

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

Reimplemented from sofa::core::behavior::SingleStateAccessor< DataTypes >.

◆ init() [2/3]

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

Reimplemented from sofa::core::behavior::SingleStateAccessor< DataTypes >.

◆ init() [3/3]

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::init ( void  )
overridevirtual

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

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

◆ initDefaultImpl()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::initDefaultImpl

◆ initFromTotalMass()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::initFromTotalMass
virtual

◆ initFromVertexMass()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::initFromVertexMass
virtual

◆ isDiagonal()

template<class DataTypes >
bool sofa::component::mass::UniformMass< DataTypes >::isDiagonal ( ) const
inlineoverridevirtual

◆ loadFromFileRigidImpl()

template<class DataTypes >
template<class T >
void sofa::component::mass::UniformMass< DataTypes >::loadFromFileRigidImpl ( const string &  filename)

◆ loadRigidMass() [1/3]

void sofa::component::mass::UniformMass< defaulttype::Rigid3Types >::loadRigidMass ( const std::string &  )

◆ loadRigidMass() [2/3]

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::loadRigidMass ( const std::string &  filename)

◆ loadRigidMass() [3/3]

SOFA_COMPONENT_MASS_API void sofa::component::mass::UniformMass< Rigid3Types >::loadRigidMass ( const string &  filename)

◆ parse()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::parse ( sofa::core::objectmodel::BaseObjectDescription arg)
inlineoverridevirtual

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

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

◆ setFileMass()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::setFileMass ( const std::string &  file)
inline

}@

◆ setMass()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::setMass ( const MassType d_vertexMass)

◆ setTotalMass()

template<class DataTypes >
void sofa::component::mass::UniformMass< DataTypes >::setTotalMass ( SReal  m)

◆ SOFA_CLASS()

template<class DataTypes >
sofa::component::mass::UniformMass< DataTypes >::SOFA_CLASS ( SOFA_TEMPLATE(UniformMass< DataTypes >, DataTypes ,
SOFA_TEMPLATE(core::behavior::Mass, DataTypes  
)

◆ updateFromTotalMass()

template<class DataTypes >
sofa::core::objectmodel::ComponentState sofa::component::mass::UniformMass< DataTypes >::updateFromTotalMass

Functions updating data.

◆ updateFromVertexMass()

template<class DataTypes >
sofa::core::objectmodel::ComponentState sofa::component::mass::UniformMass< DataTypes >::updateFromVertexMass