SOFA API  6a688117
Open source framework for multi-physics simuation
sofa::component::mass::DiagonalMass< DataTypes, TMassType > Class Template Reference

#include <DiagonalMass.h>

Inheritance diagram for sofa::component::mass::DiagonalMass< DataTypes, TMassType >:

Classes

class  DMassPointHandler
 
class  Loader
 

Public Attributes

VecMass d_vertexMass
 values of the particles masses More...
 
Data< Reald_massDensity
 the mass density used to compute the mass from a mesh topology and geometry More...
 
Data< Reald_totalMass
 total mass of the object More...
 
Data< boold_computeMassOnRest
 if true, the mass of every element is computed based on the rest position rather than the position More...
 
Data< boold_showCenterOfGravity
 to display the center of gravity of the system More...
 
Data< floatd_showAxisSize
 factor length of the axis displayed (only used for rigids) More...
 
core::objectmodel::DataFileName d_fileMass
 an Xsp3.0 file to specify the mass parameters More...
 
DMassPointHandlerm_pointHandler
 
int m_initializationProcess
 value defining the initialization process of the mass (0 : totalMass, 1 : massDensity, 2 : vertexMass) More...
 
SingleLink< DiagonalMass< DataTypes, TMassType >, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKl_topology
 Link to be set to the topology container in the component graph. More...
 
sofa::component::topology::EdgeSetGeometryAlgorithms< GeometricalTypes > * edgeGeo
 
sofa::component::topology::TriangleSetGeometryAlgorithms< GeometricalTypes > * triangleGeo
 
sofa::component::topology::QuadSetGeometryAlgorithms< GeometricalTypes > * quadGeo
 
sofa::component::topology::TetrahedronSetGeometryAlgorithms< GeometricalTypes > * tetraGeo
 
sofa::component::topology::HexahedronSetGeometryAlgorithms< GeometricalTypes > * hexaGeo
 
- 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
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< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
DeprecatedAndRemoved m_componentstate
 
DeprecatedAndRemoved d_componentstate
 
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< SReal > rayleighMass
 Rayleigh Damping mass matrix coefficient. More...
 

Protected Attributes

TopologyType m_topologyType
 The type of topology to build the mass from the topology. More...
 
sofa::core::topology::BaseMeshTopologym_topology
 Pointer to the topology container. Will be set by link. More...
 
- Protected Attributes inherited from sofa::core::behavior::Mass< DataTypes >
std::ofstream * m_gnuplotFileEnergy
 stream to export Kinematic, Potential and Mechanical Energy to gnuplot files More...
 
- Protected Attributes inherited from sofa::core::behavior::ForceField< DataTypes >
SingleLink< ForceField< DataTypes >, MechanicalState< DataTypes >, BaseLink::FLAG_STRONGLINK > mstate
 
- 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...
 

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE2(DiagonalMass, DataTypes, TMassType), SOFA_TEMPLATE(core::behavior::Mass, DataTypes))
 
bool load (const char *filename)
 
void clear ()
 
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 handleEvent (sofa::core::objectmodel::Event *) override
 Handle an event. More...
 
void doUpdateInternal () override
 Implementation of the internal update. More...
 
TopologyType getMassTopologyType () const
 
Real getMassDensity () const
 
SReal getTotalMass () const
 
std::size_t getMassCount ()
 
void printMass ()
 Print key mass informations (totalMass, vertexMass and massDensity) More...
 
void computeMass ()
 Compute the mass from input values. More...
 
void addMass (const MassType &mass)
 
void resize (int vsize)
 
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 &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...
 
defaulttype::Vector6 getMomentum (const core::MechanicalParams *mparams, const DataVecCoord &x, const DataVecDeriv &v) const override
 (Mv,cross(x,Mv)+Iw) override More...
 
void addGravityToV (const core::MechanicalParams *mparams, DataVecDeriv &d_v) override
 
void addMToMatrix (const core::MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Add Mass contribution to global Matrix assembling. More...
 
SReal getElementMass (sofa::defaulttype::index_type index) const override
 Get the mass relative to the DOF at index. More...
 
void getElementMass (sofa::defaulttype::index_type, defaulttype::BaseMatrix *m) const override
 Get the matrix relative to the DOF at index. More...
 
bool isDiagonal () 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 >
SReal getPotentialEnergyRigidImpl (const MechanicalParams *mparams, const DataVecCoord &x) const
 
template<class T >
void drawRigid3dImpl (const VisualParams *vparams)
 
template<class T >
void drawRigid2dImpl (const VisualParams *vparams)
 
template<class T >
Vector6 getMomentumRigid3Impl (const MechanicalParams *, const DataVecCoord &vx, const DataVecDeriv &vv) const
 
template<class T >
Vector6 getMomentumVec3Impl (const MechanicalParams *, const DataVecCoord &vx, const DataVecDeriv &vv) const
 
template<>
SReal getPotentialEnergy (const MechanicalParams *mparams, const DataVecCoord &x) const
 
template<>
SReal getPotentialEnergy (const MechanicalParams *mparams, const DataVecCoord &x) const
 
template<>
void draw (const VisualParams *vparams)
 
template<>
void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
template<>
void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
template<>
void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
template<>
void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
template<>
void draw (const VisualParams *vparams)
 
template<>
Vector6 getMomentum (const MechanicalParams *mparams, const DataVecCoord &vx, const DataVecDeriv &vv) const
 
template<>
Vector6 getMomentum (const MechanicalParams *mparams, const DataVecCoord &vx, const DataVecDeriv &vv) const
 
template<>
SReal getPotentialEnergy (const core::MechanicalParams *mparams, const DataVecCoord &x) const
 
template<>
SReal getPotentialEnergy (const core::MechanicalParams *mparams, const DataVecCoord &x) const
 
template<>
void draw (const core::visual::VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
template<>
void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
template<>
void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
template<>
void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
template<>
void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
template<>
void draw (const core::visual::VisualParams *vparams)
 Render internal data of this object, for debugging purposes. More...
 
template<>
defaulttype::Vector6 getMomentum (const core::MechanicalParams *, const DataVecCoord &vx, const DataVecDeriv &vv) const
 
template<>
defaulttype::Vector6 getMomentum (const core::MechanicalParams *, const DataVecCoord &vx, const DataVecDeriv &vv) const
 
Read and write access functions in mass information
virtual const RealgetMassDensity ()
 
virtual const RealgetTotalMass ()
 
virtual void setVertexMass (sofa::helper::vector< Real > vertexMass)
 
virtual void setMassDensity (Real massDensityValue)
 
virtual void setTotalMass (Real totalMass)
 
Check and standard initialization functions from mass information
virtual bool checkVertexMass ()
 
virtual void initFromVertexMass ()
 
virtual bool checkMassDensity ()
 
virtual void initFromMassDensity ()
 
virtual bool checkTotalMass ()
 
virtual void checkTotalMassInit ()
 
virtual void initFromTotalMass ()
 
- Public Member Functions inherited from sofa::core::behavior::Mass< DataTypes >
 SOFA_CLASS2 (SOFA_TEMPLATE(Mass, DataTypes), SOFA_TEMPLATE(ForceField, DataTypes), BaseMass)
 
MechanicalState< DataTypes > * getMState ()
 Retrieve the associated MechanicalState. More...
 
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::defaulttype::index_type) const override
 recover the mass of an element More...
 
void getElementMass (sofa::defaulttype::index_type index, defaulttype::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
 
defaulttype::Vector6 getMomentum (const MechanicalParams *mparams) const override
 
void addKToMatrix (sofa::defaulttype::BaseMatrix *, SReal, unsigned int &) override
 
void addBToMatrix (sofa::defaulttype::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...
 
virtual void addMToMatrix (sofa::defaulttype::BaseMatrix *matrix, SReal mFact, unsigned int &offset)
 
void addMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 
void addSubMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > subMatrixIndex) override
 addMBKToMatrix only on the subMatrixIndex More...
 
- Public Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(ForceField, DataTypes), BaseForceField)
 
MechanicalState< DataTypes > * getMState ()
 Retrieve the associated MechanicalState. More...
 
const MechanicalState< DataTypes > * getMState () const
 
void addForce (const MechanicalParams *mparams, MultiVecDerivId fId) override
 
void addDForce (const MechanicalParams *mparams, MultiVecDerivId dfId) override
 
void addClambda (const MechanicalParams *mparams, MultiVecDerivId resId, MultiVecDerivId lambdaId, SReal cFactor) override
 
virtual void addClambda (const MechanicalParams *mparams, DataVecDeriv &df, const DataVecDeriv &lambda, SReal cFactor)
 
SReal getPotentialEnergy (const MechanicalParams *mparams) const override
 
void addKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Compute the system matrix corresponding to k K. More...
 
void addSubKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > &subMatrixIndex) override
 addToMatrix only on the subMatrixIndex More...
 
virtual void addSubKToMatrix (sofa::defaulttype::BaseMatrix *matrix, const helper::vector< unsigned > &subMatrixIndex, SReal kFact, unsigned int &offset)
 addToMatrix only on the subMatrixIndex More...
 
void addBToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Compute the system matrix corresponding to b B. More...
 
void addSubBToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > &subMatrixIndex) override
 addBToMatrix only on the subMatrixIndex More...
 
virtual void addSubBToMatrix (sofa::defaulttype::BaseMatrix *matrix, const helper::vector< unsigned > &subMatrixIndex, SReal bFact, unsigned int &offset)
 addBToMatrix only on the subMatrixIndex More...
 
void addToMatrix (sofa::defaulttype::BaseMatrix *bm, unsigned offset, const IndexArray &nodeIndex, const ElementMat &em, SReal scale)
 
void updateForceMask () override
 
- Public Member Functions inherited from sofa::core::behavior::BaseForceField
 SOFA_ABSTRACT_CLASS (BaseForceField, objectmodel::BaseObject)
 
virtual const sofa::defaulttype::BaseMatrixgetComplianceMatrix (const MechanicalParams *)
 
- 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 override
 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)
 
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 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...
 
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...
 
virtual std::string getTemplateName () const
 Get the template type names (if any) used to instantiate this object. More...
 
virtual 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
 
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
 
bool IsInheritingFromBase ()
 
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 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::BaseMass
 SOFA_ABSTRACT_CLASS (BaseMass, objectmodel::BaseObject)
 

Protected Member Functions

 DiagonalMass ()
 
 ~DiagonalMass () override
 
bool checkTopology ()
 
void initTopologyHandlers ()
 
void massInitialization ()
 
- 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
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
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::BaseMass
 BaseMass ()
 
 ~BaseMass () override
 

Additional Inherited Members

- Static Public Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
static bool canCreate (T *&obj, objectmodel::BaseContext *context, objectmodel::BaseObjectDescription *arg)
 
static std::string shortName (const T *ptr=nullptr, objectmodel::BaseObjectDescription *arg=nullptr)
 
- Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool canCreate (T *, BaseContext *, BaseObjectDescription *)
 Pre-construction check method called by ObjectFactory. More...
 
template<class T >
static T::SPtr create (T *, BaseContext *context, BaseObjectDescription *arg)
 Construction method called by ObjectFactory. More...
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClassGetClass ()
 
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, class TMassType>
Data< bool > sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_computeMassOnRest

if true, the mass of every element is computed based on the rest position rather than the position

template<class DataTypes, class TMassType>
core::objectmodel::DataFileName sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_fileMass

an Xsp3.0 file to specify the mass parameters

template<class DataTypes, class TMassType>
Data< Real > sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_massDensity

the mass density used to compute the mass from a mesh topology and geometry

template<class DataTypes, class TMassType>
Data< float > sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_showAxisSize

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

template<class DataTypes, class TMassType>
Data< bool > sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_showCenterOfGravity

to display the center of gravity of the system

template<class DataTypes, class TMassType>
Data< Real > sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_totalMass

total mass of the object

template<class DataTypes, class TMassType>
VecMass sofa::component::mass::DiagonalMass< DataTypes, TMassType >::d_vertexMass

values of the particles masses

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

template<class DataTypes, class TMassType>
int sofa::component::mass::DiagonalMass< DataTypes, TMassType >::m_initializationProcess

value defining the initialization process of the mass (0 : totalMass, 1 : massDensity, 2 : vertexMass)

template<class DataTypes, class TMassType>
DMassPointHandler* sofa::component::mass::DiagonalMass< DataTypes, TMassType >::m_pointHandler
template<class DataTypes, class TMassType>
sofa::core::topology::BaseMeshTopology* sofa::component::mass::DiagonalMass< DataTypes, TMassType >::m_topology
protected

Pointer to the topology container. Will be set by link.

See also
l_topology
template<class DataTypes, class TMassType>
TopologyType sofa::component::mass::DiagonalMass< DataTypes, TMassType >::m_topologyType
protected

The type of topology to build the mass from the topology.

Constructor details

template<class DataTypes , class MassType >
sofa::component::mass::DiagonalMass< DataTypes, MassType >::DiagonalMass ( )
protected
template<class DataTypes , class MassType >
sofa::component::mass::DiagonalMass< DataTypes, MassType >::~DiagonalMass ( )
overrideprotected

Function details

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::accFromF ( const core::MechanicalParams mparams,
DataVecDeriv a,
const DataVecDeriv f 
)
overridevirtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::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 >.

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::addGravityToV ( const core::MechanicalParams mparams,
DataVecDeriv d_v 
)
overridevirtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::addMass ( const MassType mass)
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::addMDx ( const core::MechanicalParams mparams,
DataVecDeriv f,
const DataVecDeriv dx,
SReal  factor 
)
overridevirtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::addMToMatrix ( const core::MechanicalParams mparams,
const sofa::core::behavior::MultiMatrixAccessor matrix 
)
overridevirtual

Add Mass contribution to global Matrix assembling.

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

template<class DataTypes , class MassType >
bool sofa::component::mass::DiagonalMass< DataTypes, MassType >::checkMassDensity ( )
virtual
template<class DataTypes , class MassType >
bool sofa::component::mass::DiagonalMass< DataTypes, MassType >::checkTopology ( )
protected
template<class DataTypes , class MassType >
bool sofa::component::mass::DiagonalMass< DataTypes, MassType >::checkTotalMass ( )
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::checkTotalMassInit ( )
virtual
template<class DataTypes , class MassType >
bool sofa::component::mass::DiagonalMass< DataTypes, MassType >::checkVertexMass ( )
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::clear ( )
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::computeMass ( )

Compute the mass from input values.

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::doUpdateInternal ( )
overridevirtual

Implementation of the internal update.

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

template<>
void sofa::component::mass::DiagonalMass< Rigid3Types, Rigid3Mass >::draw ( const VisualParams *  vparams)
template<>
void sofa::component::mass::DiagonalMass< Rigid2Types, Rigid2Mass >::draw ( const VisualParams *  vparams)
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::draw ( const core::visual::VisualParams )
overridevirtual

Render internal data of this object, for debugging purposes.

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

Render internal data of this object, for debugging purposes.

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

Render internal data of this object, for debugging purposes.

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

template<class DataTypes, class TMassType>
template<class T >
void sofa::component::mass::DiagonalMass< DataTypes, TMassType >::drawRigid2dImpl ( const VisualParams *  vparams)
template<class DataTypes, class TMassType>
template<class T >
void sofa::component::mass::DiagonalMass< DataTypes, TMassType >::drawRigid3dImpl ( const VisualParams *  vparams)
template<class DataTypes , class MassType >
SReal sofa::component::mass::DiagonalMass< DataTypes, MassType >::getElementMass ( sofa::defaulttype::index_type  index) const
overridevirtual

Get the mass relative to the DOF at index.

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

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::getElementMass ( sofa::defaulttype::index_type  index,
defaulttype::BaseMatrix m 
) const
overridevirtual

Get the matrix relative to the DOF at index.

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

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

vMv/2 using dof->getV() override

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

template<class DataTypes, class TMassType>
std::size_t sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getMassCount ( )
inline
template<class DataTypes, class TMassType>
Real sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getMassDensity ( ) const
inline
template<class DataTypes , class MassType >
const DiagonalMass< DataTypes, MassType >::Real & sofa::component::mass::DiagonalMass< DataTypes, MassType >::getMassDensity ( )
virtual
template<class DataTypes, class TMassType>
TopologyType sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getMassTopologyType ( ) const
inline
template<>
Vector6 sofa::component::mass::DiagonalMass< Vec3Types, double >::getMomentum ( const MechanicalParams *  mparams,
const DataVecCoord vx,
const DataVecDeriv vv 
) const
template<>
Vector6 sofa::component::mass::DiagonalMass< Rigid3Types, Rigid3Mass >::getMomentum ( const MechanicalParams *  mparams,
const DataVecCoord vx,
const DataVecDeriv vv 
) const
template<class DataTypes , class MassType >
defaulttype::Vector6 sofa::component::mass::DiagonalMass< DataTypes, MassType >::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 >.

template<>
defaulttype::Vector6 sofa::component::mass::DiagonalMass< defaulttype::Vec3Types, double >::getMomentum ( const core::MechanicalParams ,
const DataVecCoord vx,
const DataVecDeriv vv 
) const
virtual
template<>
defaulttype::Vector6 sofa::component::mass::DiagonalMass< defaulttype::Rigid3Types, defaulttype::Rigid3Mass >::getMomentum ( const core::MechanicalParams ,
const DataVecCoord vx,
const DataVecDeriv vv 
) const
virtual
template<class DataTypes, class TMassType>
template<class T >
Vector6 sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getMomentumRigid3Impl ( const MechanicalParams *  ,
const DataVecCoord vx,
const DataVecDeriv vv 
) const
template<class DataTypes, class TMassType>
template<class T >
Vector6 sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getMomentumVec3Impl ( const MechanicalParams *  ,
const DataVecCoord vx,
const DataVecDeriv vv 
) const
template<>
SReal sofa::component::mass::DiagonalMass< Rigid3Types, Rigid3Mass >::getPotentialEnergy ( const MechanicalParams *  mparams,
const DataVecCoord x 
) const
template<>
SReal sofa::component::mass::DiagonalMass< Rigid2Types, Rigid2Mass >::getPotentialEnergy ( const MechanicalParams *  mparams,
const DataVecCoord x 
) const
template<class DataTypes , class MassType >
SReal sofa::component::mass::DiagonalMass< DataTypes, MassType >::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 >.

template<>
SReal sofa::component::mass::DiagonalMass< defaulttype::Rigid3Types, defaulttype::Rigid3Mass >::getPotentialEnergy ( const core::MechanicalParams mparams,
const DataVecCoord x 
) const
virtual
template<>
SReal sofa::component::mass::DiagonalMass< defaulttype::Rigid2Types, defaulttype::Rigid2Mass >::getPotentialEnergy ( const core::MechanicalParams mparams,
const DataVecCoord x 
) const
virtual
template<class DataTypes, class TMassType>
template<class T >
SReal sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getPotentialEnergyRigidImpl ( const MechanicalParams *  mparams,
const DataVecCoord x 
) const
template<class DataTypes, class TMassType>
SReal sofa::component::mass::DiagonalMass< DataTypes, TMassType >::getTotalMass ( ) const
inline
template<class DataTypes , class MassType >
const DiagonalMass< DataTypes, MassType >::Real & sofa::component::mass::DiagonalMass< DataTypes, MassType >::getTotalMass ( )
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::handleEvent ( sofa::core::objectmodel::Event )
overridevirtual

Handle an event.

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

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::init ( void  )
overridevirtual

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

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

template<>
void sofa::component::mass::DiagonalMass< Rigid3Types, Rigid3Mass >::init ( void  )
virtual

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

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

template<>
void sofa::component::mass::DiagonalMass< Rigid2Types, Rigid2Mass >::init ( void  )
virtual

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

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

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

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

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

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

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::initFromMassDensity ( )
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::initFromTotalMass ( )
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::initFromVertexMass ( )
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::initTopologyHandlers ( )
protected
template<class DataTypes, class TMassType>
bool sofa::component::mass::DiagonalMass< DataTypes, TMassType >::isDiagonal ( )
inlineoverridevirtual

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

template<class DataTypes , class MassType >
bool sofa::component::mass::DiagonalMass< DataTypes, MassType >::load ( const char *  filename)
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::massInitialization ( )
protected
template<class DataTypes, class TMassType>
void sofa::component::mass::DiagonalMass< DataTypes, TMassType >::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.

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::printMass ( )

Print key mass informations (totalMass, vertexMass and massDensity)

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::reinit ( )
overridevirtual

Update method called when variables used in precomputation are modified.

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

template<>
void sofa::component::mass::DiagonalMass< Rigid3Types, Rigid3Mass >::reinit ( )
virtual

Update method called when variables used in precomputation are modified.

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

template<>
void sofa::component::mass::DiagonalMass< Rigid2Types, Rigid2Mass >::reinit ( )
virtual

Update method called when variables used in precomputation are modified.

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

Update method called when variables used in precomputation are modified.

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

Update method called when variables used in precomputation are modified.

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

template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::resize ( int  vsize)
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::setMassDensity ( Real  massDensityValue)
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::setTotalMass ( Real  totalMass)
virtual
template<class DataTypes , class MassType >
void sofa::component::mass::DiagonalMass< DataTypes, MassType >::setVertexMass ( sofa::helper::vector< Real vertexMass)
virtual
template<class DataTypes, class TMassType>
sofa::component::mass::DiagonalMass< DataTypes, TMassType >::SOFA_CLASS ( SOFA_TEMPLATE2(DiagonalMass< DataTypes, TMassType >, DataTypes, TMassType)  ,
SOFA_TEMPLATE(core::behavior::Mass, DataTypes  
)

Enum details

template<class DataTypes, class TMassType>
enum sofa::component::mass::DiagonalMass::TopologyType
Enumerator
TOPOLOGY_UNKNOWN 
TOPOLOGY_EDGESET 
TOPOLOGY_TRIANGLESET 
TOPOLOGY_TETRAHEDRONSET 
TOPOLOGY_QUADSET 
TOPOLOGY_HEXAHEDRONSET