SOFA API  6dc60b15
Open source framework for multi-physics simuation
sofa::component::forcefield::SurfacePressureForceField< DataTypes > Class Template Reference

#include <SurfacePressureForceField.h>

SurfacePressureForceField Class. More...

Inheritance diagram for sofa::component::forcefield::SurfacePressureForceField< DataTypes >:

Detailed Description

template<class DataTypes>
class sofa::component::forcefield::SurfacePressureForceField< DataTypes >

SurfacePressureForceField Class.

Implements a pressure force applied on a triangle or quad surface. Each surfel receives a pressure in the direction of its normal.

Protected Attributes

Data< Realm_pressure
 Scalar pressure value applied on the surfaces. More...
 
Data< Coordm_min
 Lower bound of the pressured box. More...
 
Data< Coordm_max
 Upper bound of the pressured box. More...
 
Data< VecIndexm_triangleIndices
 Specify triangles by indices. More...
 
Data< VecIndexm_quadIndices
 Specify quads by indices. More...
 
Data< boolm_pulseMode
 In this mode, the pressure increases (or decreases) from 0 to m_pressure cyclicly. More...
 
Data< Realm_pressureLowerBound
 In pulseMode, the pressure increases(or decreases) from m_pressureLowerBound to m_pressure cyclicly. More...
 
Data< Realm_pressureSpeed
 Pressure variation in Pascal by second. More...
 
Data< boolm_volumeConservationMode
 In this mode, pressure variation is related to the object volume variation. More...
 
Data< boolm_useTangentStiffness
 The tangent stiffness matrix is not symmetric and could create issues with some linear solvers. Set to false to not use it. More...
 
Data< Realm_defaultVolume
 Default Volume. More...
 
Data< Derivm_mainDirection
 Main axis for pressure application. More...
 
Data< Realm_drawForceScale
 scale used to render force vectors More...
 
helper::vector< Derivm_f
 store forces for visualization More...
 
SingleLink< SurfacePressureForceField< 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...
 
State state
 In pulse mode, says wether pressure is increasing or decreasing. More...
 
Real m_pulseModePressure
 Current pressure computed in pulse mode. More...
 
VecVec3DerivValues derivTriNormalValues
 Computation of the derivative values. More...
 
VecVec3DerivIndices derivTriNormalIndices
 
sofa::core::topology::BaseMeshTopologym_topology
 
- 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_TEMPLATE(SurfacePressureForceField, DataTypes), SOFA_TEMPLATE(core::behavior::ForceField, DataTypes))
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void addForce (const core::MechanicalParams *mparams, DataVecDeriv &d_f, const DataVecCoord &d_x, const DataVecDeriv &d_v) override
 
void addDForce (const core::MechanicalParams *mparams, DataVecDeriv &, const DataVecDeriv &) override
 
void addKToMatrix (const core::MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix) override
 Compute the system matrix corresponding to k K. More...
 
SReal getPotentialEnergy (const core::MechanicalParams *, const DataVecCoord &) const override
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. More...
 
void setPressure (const Real _pressure)
 
template<>
void addDForce (const core::MechanicalParams *mparams, DataVecDeriv &, const DataVecDeriv &)
 
template<>
void addDForce (const core::MechanicalParams *mparams, DataVecDeriv &d_df, const DataVecDeriv &d_dx)
 
- Public Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(ForceField, DataTypes), BaseForceField)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
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...
 
virtual void addKToMatrix (sofa::defaulttype::BaseMatrix *matrix, SReal kFact, unsigned int &offset)
 
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...
 
virtual void addBToMatrix (sofa::defaulttype::BaseMatrix *matrix, SReal bFact, unsigned int &offset)
 
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)
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
virtual void addMBKdx (const MechanicalParams *mparams, MultiVecDerivId dfId)
 Accumulate the contribution of M, B, and/or K matrices multiplied by the dx vector with the given coefficients. More...
 
virtual void addMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix)
 Compute the system matrix corresponding to m M + b B + k K. More...
 
virtual void addSubMBKToMatrix (const MechanicalParams *mparams, const sofa::core::behavior::MultiMatrixAccessor *matrix, const helper::vector< unsigned > subMatrixIndex)
 addMBKToMatrix only on the subMatrixIndex More...
 
virtual const sofa::defaulttype::BaseMatrixgetComplianceMatrix (const MechanicalParams *)
 
- 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 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 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)
 

Protected Member Functions

 SurfacePressureForceField ()
 
virtual ~SurfacePressureForceField ()
 
Real computeMeshVolume (const VecDeriv &f, const VecCoord &x)
 Compute mesh volume. More...
 
virtual void addTriangleSurfacePressure (unsigned int triId, VecDeriv &, const VecCoord &, const VecDeriv &, const Real &, bool computeDerivatives)
 Triangle based surface pressure computation method. Each vertice receives a force equal to 1/3 of the pressure applied on its belonging triangle. More...
 
virtual void addQuadSurfacePressure (unsigned int quadId, VecDeriv &, const VecCoord &, const VecDeriv &, const Real &)
 Quad based surface pressure computation method. Each vertice receives a force equal to 1/4 of the pressure applied on its belonging quad. More...
 
bool isInPressuredBox (const Coord &) const
 Returns true if the x parameters belongs to the pressured box. More...
 
const Real computePulseModePressure (void)
 Returns next pressure value in pulse mode. Pressure is computed according to the pressureSpeed attribute and the simulation time step. More...
 
void verifyDerivative (VecDeriv &v_plus, VecDeriv &v, VecVec3DerivValues &DVval, VecVec3DerivIndices &DVind, const VecDeriv &Din)
 
template<>
SurfacePressureForceField< defaulttype::Rigid3Types >::Real computeMeshVolume (const VecDeriv &f, const VecCoord &x)
 
template<>
void addTriangleSurfacePressure (unsigned int triId, VecDeriv &, const VecCoord &, const VecDeriv &, const Real &, bool computeDerivatives)
 
template<>
void addQuadSurfacePressure (unsigned int quadId, VecDeriv &, const VecCoord &, const VecDeriv &, const Real &)
 
template<>
void verifyDerivative (VecDeriv &v_plus, VecDeriv &v, VecVec3DerivValues &DVval, VecVec3DerivIndices &DVind, const VecDeriv &Din)
 
template<>
SurfacePressureForceField< defaulttype::Rigid3Types >::Real computeMeshVolume (const VecDeriv &, const VecCoord &x)
 
template<>
void addTriangleSurfacePressure (unsigned int triId, VecDeriv &f, const VecCoord &x, const VecDeriv &, const Real &pressure, bool computeDerivatives)
 
template<>
void addQuadSurfacePressure (unsigned int quadId, VecDeriv &f, const VecCoord &x, const VecDeriv &, const Real &pressure)
 
template<>
void verifyDerivative (VecDeriv &, VecDeriv &, VecVec3DerivValues &, VecVec3DerivIndices &, const VecDeriv &)
 
- 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
 
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...
 

Additional Inherited Members

- 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}
 
- 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>
VecVec3DerivIndices sofa::component::forcefield::SurfacePressureForceField< DataTypes >::derivTriNormalIndices
protected
template<class DataTypes>
VecVec3DerivValues sofa::component::forcefield::SurfacePressureForceField< DataTypes >::derivTriNormalValues
protected

Computation of the derivative values.

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

template<class DataTypes>
Data< Real > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_defaultVolume
protected

Default Volume.

template<class DataTypes>
Data< Real > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_drawForceScale
protected

scale used to render force vectors

store forces for visualization

template<class DataTypes>
Data< Deriv > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_mainDirection
protected

Main axis for pressure application.

template<class DataTypes>
Data< Coord > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_max
protected

Upper bound of the pressured box.

template<class DataTypes>
Data< Coord > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_min
protected

Lower bound of the pressured box.

template<class DataTypes>
Data< Real > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_pressure
protected

Scalar pressure value applied on the surfaces.

template<class DataTypes>
Data< Real > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_pressureLowerBound
protected

In pulseMode, the pressure increases(or decreases) from m_pressureLowerBound to m_pressure cyclicly.

template<class DataTypes>
Data< Real > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_pressureSpeed
protected

Pressure variation in Pascal by second.

template<class DataTypes>
Data< bool > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_pulseMode
protected

In this mode, the pressure increases (or decreases) from 0 to m_pressure cyclicly.

template<class DataTypes>
Real sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_pulseModePressure
protected

Current pressure computed in pulse mode.

template<class DataTypes>
Data< VecIndex > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_quadIndices
protected

Specify quads by indices.

template<class DataTypes>
Data< VecIndex > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_triangleIndices
protected

Specify triangles by indices.

template<class DataTypes>
Data< bool > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_useTangentStiffness
protected

The tangent stiffness matrix is not symmetric and could create issues with some linear solvers. Set to false to not use it.

template<class DataTypes>
Data< bool > sofa::component::forcefield::SurfacePressureForceField< DataTypes >::m_volumeConservationMode
protected

In this mode, pressure variation is related to the object volume variation.

template<class DataTypes>
State sofa::component::forcefield::SurfacePressureForceField< DataTypes >::state
protected

In pulse mode, says wether pressure is increasing or decreasing.

Constructor details

Function details

template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::addDForce ( const core::MechanicalParams mparams,
DataVecDeriv d_df,
const DataVecDeriv d_dx 
)
overridevirtual
template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< 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 >.

template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::addKToMatrix ( const core::MechanicalParams mparams,
const sofa::core::behavior::MultiMatrixAccessor matrix 
)
overridevirtual

Compute the system matrix corresponding to k K.

Parameters
mparamsmparams->kFactor() is the coefficient for stiffness contributions (i.e. DOFs term in the ODE)
matrixthe matrix to add the result to

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

template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::addQuadSurfacePressure ( unsigned int  quadId,
VecDeriv f,
const VecCoord x,
const VecDeriv ,
const Real pressure 
)
protectedvirtual

Quad based surface pressure computation method. Each vertice receives a force equal to 1/4 of the pressure applied on its belonging quad.

template<>
void sofa::component::forcefield::SurfacePressureForceField< defaulttype::Rigid3Types >::addQuadSurfacePressure ( unsigned int  quadId,
VecDeriv ,
const VecCoord ,
const VecDeriv ,
const Real  
)
protected
template<>
void sofa::component::forcefield::SurfacePressureForceField< defaulttype::Rigid3Types >::addQuadSurfacePressure ( unsigned int  quadId,
VecDeriv f,
const VecCoord x,
const VecDeriv ,
const Real pressure 
)
protected
template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::addTriangleSurfacePressure ( unsigned int  triId,
VecDeriv f,
const VecCoord x,
const VecDeriv ,
const Real pressure,
bool  computeDerivatives 
)
protectedvirtual

Triangle based surface pressure computation method. Each vertice receives a force equal to 1/3 of the pressure applied on its belonging triangle.

template<>
void sofa::component::forcefield::SurfacePressureForceField< defaulttype::Rigid3Types >::addTriangleSurfacePressure ( unsigned int  triId,
VecDeriv ,
const VecCoord ,
const VecDeriv ,
const Real ,
bool  computeDerivatives 
)
protected
template<>
void sofa::component::forcefield::SurfacePressureForceField< defaulttype::Rigid3Types >::addTriangleSurfacePressure ( unsigned int  triId,
VecDeriv f,
const VecCoord x,
const VecDeriv ,
const Real pressure,
bool  computeDerivatives 
)
protected
template<class DataTypes >
SurfacePressureForceField< DataTypes >::Real sofa::component::forcefield::SurfacePressureForceField< DataTypes >::computeMeshVolume ( const VecDeriv f,
const VecCoord x 
)
protected

Compute mesh volume.

template<class DataTypes >
const SurfacePressureForceField< DataTypes >::Real sofa::component::forcefield::SurfacePressureForceField< DataTypes >::computePulseModePressure ( void  )
protected

Returns next pressure value in pulse mode. Pressure is computed according to the pressureSpeed attribute and the simulation time step.

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

Render internal data of this object, for debugging purposes.

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

template<class DataTypes >
SReal sofa::component::forcefield::SurfacePressureForceField< DataTypes >::getPotentialEnergy ( const core::MechanicalParams ,
const DataVecCoord  
) const
overridevirtual
template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::init ( void  )
overridevirtual

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

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

template<class DataTypes >
bool sofa::component::forcefield::SurfacePressureForceField< DataTypes >::isInPressuredBox ( const Coord x) const
inlineprotected

Returns true if the x parameters belongs to the pressured box.

template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::setPressure ( const Real  _pressure)
template<class DataTypes>
sofa::component::forcefield::SurfacePressureForceField< DataTypes >::SOFA_CLASS ( SOFA_TEMPLATE(SurfacePressureForceField< DataTypes >, DataTypes ,
SOFA_TEMPLATE(core::behavior::ForceField, DataTypes  
)
template<class DataTypes >
void sofa::component::forcefield::SurfacePressureForceField< DataTypes >::verifyDerivative ( VecDeriv v_plus,
VecDeriv v,
VecVec3DerivValues DVval,
VecVec3DerivIndices DVind,
const VecDeriv Din 
)
protected
template<>
void sofa::component::forcefield::SurfacePressureForceField< defaulttype::Rigid3Types >::verifyDerivative ( VecDeriv v_plus,
VecDeriv v,
VecVec3DerivValues DVval,
VecVec3DerivIndices DVind,
const VecDeriv Din 
)
protected
template<>
void sofa::component::forcefield::SurfacePressureForceField< defaulttype::Rigid3Types >::verifyDerivative ( VecDeriv ,
VecDeriv ,
VecVec3DerivValues ,
VecVec3DerivIndices ,
const VecDeriv  
)
protected

Enum details

Enumerator
INCREASE 
DECREASE