#include <SurfacePressureForceField.h>

SurfacePressureForceField Class. More...

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

Detailed Description

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

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

Public Attributes
Data< Real >	m_pressure
	Scalar pressure value applied on the surfaces. More...

Data< Coord >	m_min
	Lower bound of the pressured box. More...

Data< Coord >	m_max
	Upper bound of the pressured box. More...

Data< VecIndex >	m_triangleIndices
	Specify triangles by indices. More...

Data< VecIndex >	m_quadIndices
	Specify quads by indices. More...

Data< bool >	m_pulseMode
	In this mode, the pressure increases (or decreases) from 0 to m_pressure cyclicly. More...

Data< Real >	m_pressureLowerBound
	In pulseMode, the pressure increases(or decreases) from m_pressureLowerBound to m_pressure cyclicly. More...

Data< Real >	m_pressureSpeed
	Pressure variation in Pascal by second. More...

Data< bool >	m_volumeConservationMode
	In this mode, pressure variation is related to the object volume variation. More...

Data< bool >	m_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< Real >	m_defaultVolume
	Default Volume. More...

Data< Deriv >	m_mainDirection
	Main axis for pressure application. More...

Data< Real >	m_drawForceScale
	scale used to render force vectors More...

Public Attributes inherited from sofa::core::behavior::BaseForceField
Data< SReal >	rayleighStiffness
	Rayleigh Damping stiffness matrix coefficient. More...

Data< bool >	isCompliance
	Considered as compliance, else considered as stiffness (default to false) More...

Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool >	f_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< bool >	f_printLog
	if true, emits extra messages at runtime. More...

Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the objet belongs to More...

Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...

Data< sofa::core::objectmodel::ComponentState >	d_componentState
	the object state More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Protected Attributes
type::vector< Deriv >	m_f
	store forces for visualization More...

SingleLink< SurfacePressureForceField< DataTypes >, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	l_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::BaseMeshTopology *	m_topology

Protected Attributes inherited from sofa::core::behavior::StateAccessor
MultiLink< StateAccessor, BaseMechanicalState, BaseLink::FLAG_DUPLICATE >	l_mechanicalStates

Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context

LinkSlaves	l_slaves

SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK >	l_master

Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_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_STRONGLINK >	mstate

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 . More...

void	buildStiffnessMatrix (core::behavior::StiffnessMatrix *matrix) override

void	buildDampingMatrix (core::behavior::DampingMatrix *) final

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)

void	addDForce (const core::MechanicalParams *mparams, DataVecDeriv &d_df, const DataVecDeriv &d_dx)

void	addDForce (const core::MechanicalParams *mparams, DataVecDeriv &, const DataVecDeriv &)

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

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 . More...

virtual void	addKToMatrix (sofa::linearalgebra::BaseMatrix *matrix, SReal kFact, unsigned int &offset)

void	addBToMatrix (const MechanicalParams mparams, const sofa::core::behavior::MultiMatrixAccessor matrix) override
	Compute the system matrix corresponding to . More...

virtual void	addBToMatrix (sofa::linearalgebra::BaseMatrix *matrix, SReal bFact, unsigned int &offset)

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)

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 . More...

virtual const sofa::linearalgebra::BaseMatrix *	getComplianceMatrix (const MechanicalParams *)

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)

Base *	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...

SReal	getTime () const
	Current time. More...

const BaseContext *	getContext () const

BaseContext *	getContext ()

const BaseObject *	getMaster () const

BaseObject *	getMaster ()

const VecSlaves &	getSlaves () const

BaseObject *	getSlave (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 BaseClass *	getClass () 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::TagSet &	getTags () 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=" ")

BaseData *	findData (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...

BaseLink *	findLink (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 VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...

const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...

const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...

const MapLink &	getLinkAliases () 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)

void	init () override
	Initialization method called at graph creation and modification, during top-down traversal. More...

MechanicalState< DataTypes > *	getMState ()

const MechanicalState< DataTypes > *	getMState () const

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...

Real	computePulseModePressure ()
	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)

SurfacePressureForceField< defaulttype::Rigid3Types >::Real	computeMeshVolume (const VecDeriv &, const VecCoord &x)

void	addTriangleSurfacePressure (unsigned int triId, VecDeriv &f, const VecCoord &x, const VecDeriv &, const Real &pressure, bool computeDerivatives)

void	addQuadSurfacePressure (unsigned int quadId, VecDeriv &f, const VecCoord &x, const VecDeriv &, const Real &pressure)

void	verifyDerivative (VecDeriv &, VecDeriv &, VecVec3DerivValues &, VecVec3DerivIndices &, const VecDeriv &)

SurfacePressureForceField< defaulttype::Rigid3Types >::Real	computeMeshVolume (const VecDeriv &f, const VecCoord &x)

void	addTriangleSurfacePressure (unsigned int triId, VecDeriv &, const VecCoord &, const VecDeriv &, const Real &, bool computeDerivatives)

void	addQuadSurfacePressure (unsigned int quadId, VecDeriv &, const VecCoord &, const VecDeriv &, const Real &)

void	verifyDerivative (VecDeriv &v_plus, VecDeriv &v, VecVec3DerivValues &DVval, VecVec3DerivIndices &DVind, const VecDeriv &Din)

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

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 BaseClass *	GetClass ()

template<class T >
static std::string	shortName (const T ptr=nullptr, BaseObjectDescription =nullptr)

Attribute details

◆ derivTriNormalIndices

template<class DataTypes >

VecVec3DerivIndices sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::derivTriNormalIndices

protected

◆ derivTriNormalValues

template<class DataTypes >

VecVec3DerivValues sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::derivTriNormalValues

protected

Computation of the derivative values.

◆ l_topology

template<class DataTypes >

SingleLink<SurfacePressureForceField<DataTypes>, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::l_topology

protected

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

◆ m_defaultVolume

template<class DataTypes >

Data<Real> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_defaultVolume

Default Volume.

◆ m_drawForceScale

template<class DataTypes >

Data<Real> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_drawForceScale

scale used to render force vectors

◆ m_f

template<class DataTypes >

type::vector<Deriv> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_f

protected

store forces for visualization

◆ m_mainDirection

template<class DataTypes >

Data<Deriv> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_mainDirection

Main axis for pressure application.

◆ m_max

template<class DataTypes >

Data<Coord> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_max

Upper bound of the pressured box.

◆ m_min

template<class DataTypes >

Data<Coord> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_min

Lower bound of the pressured box.

◆ m_pressure

template<class DataTypes >

Data<Real> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_pressure

Scalar pressure value applied on the surfaces.

◆ m_pressureLowerBound

template<class DataTypes >

Data<Real> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_pressureLowerBound

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

◆ m_pressureSpeed

template<class DataTypes >

Data<Real> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_pressureSpeed

Pressure variation in Pascal by second.

◆ m_pulseMode

template<class DataTypes >

Data<bool> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_pulseMode

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

◆ m_pulseModePressure

template<class DataTypes >

Real sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_pulseModePressure

protected

Current pressure computed in pulse mode.

◆ m_quadIndices

template<class DataTypes >

Data<VecIndex> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_quadIndices

Specify quads by indices.

◆ m_topology

template<class DataTypes >

sofa::core::topology::BaseMeshTopology* sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_topology

protected

◆ m_triangleIndices

template<class DataTypes >

Data<VecIndex> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_triangleIndices

Specify triangles by indices.

◆ m_useTangentStiffness

template<class DataTypes >

Data<bool> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_useTangentStiffness

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

◆ m_volumeConservationMode

template<class DataTypes >

Data<bool> sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::m_volumeConservationMode

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

◆ state

template<class DataTypes >

State sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::state

protected

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

Constructor details

◆ SurfacePressureForceField()

template<class DataTypes >

sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::SurfacePressureForceField

protected

◆ ~SurfacePressureForceField()

template<class DataTypes >

sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::~SurfacePressureForceField

protectedvirtual

Function details

◆ addDForce() [1/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::addDForce	(	const core::MechanicalParams *	mparams,
		DataVecDeriv &	df,
		const DataVecDeriv &	dx
	)

virtual

Internal addDForce Overloaded function, usually called from the generic addDForce version. This addDForce version directly gives access to df and dx vectors through its parameters.

Parameters

mparams
df	Output vector to fill, result of
dx	Input vector used to compute

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

◆ addDForce() [2/3]

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::addDForce	(	const core::MechanicalParams *	mparams,
		DataVecDeriv &	df,
		const DataVecDeriv &	dx
	)

overridevirtual

Internal addDForce Overloaded function, usually called from the generic addDForce version. This addDForce version directly gives access to df and dx vectors through its parameters.

Parameters

mparams
df	Output vector to fill, result of
dx	Input vector used to compute

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

◆ addDForce() [3/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::addDForce	(	const core::MechanicalParams *	mparams,
		DataVecDeriv &	df,
		const DataVecDeriv &	dx
	)

virtual

Internal addDForce Overloaded function, usually called from the generic addDForce version. This addDForce version directly gives access to df and dx vectors through its parameters.

Parameters

mparams
df	Output vector to fill, result of
dx	Input vector used to compute

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

◆ addForce()

template<class DataTypes >

void sofa::component::mechanicalload::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 >.

◆ addKToMatrix()

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::addKToMatrix	(	const core::MechanicalParams *	mparams,
		const sofa::core::behavior::MultiMatrixAccessor *	matrix
	)

overridevirtual

Compute the system matrix corresponding to $ k K $ .

Parameters

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

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

◆ addQuadSurfacePressure() [1/3]

template<class DataTypes >

void sofa::component::mechanicalload::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.

◆ addQuadSurfacePressure() [2/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::addQuadSurfacePressure	(	unsigned int	quadId,
		VecDeriv &	,
		const VecCoord &	,
		const VecDeriv &	,
		const Real &
	)

protected

◆ addQuadSurfacePressure() [3/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::addQuadSurfacePressure	(	unsigned int	quadId,
		VecDeriv &	f,
		const VecCoord &	x,
		const VecDeriv &	,
		const Real &	pressure
	)

protected

◆ addTriangleSurfacePressure() [1/3]

template<class DataTypes >

void sofa::component::mechanicalload::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.

◆ addTriangleSurfacePressure() [2/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::addTriangleSurfacePressure	(	unsigned int	triId,
		VecDeriv &	,
		const VecCoord &	,
		const VecDeriv &	,
		const Real &	,
		bool	computeDerivatives
	)

protected

◆ addTriangleSurfacePressure() [3/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::addTriangleSurfacePressure	(	unsigned int	triId,
		VecDeriv &	f,
		const VecCoord &	x,
		const VecDeriv &	,
		const Real &	pressure,
		bool	computeDerivatives
	)

protected

◆ buildDampingMatrix()

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::buildDampingMatrix ( core::behavior::DampingMatrix * )

finalvirtual

Reimplemented from sofa::core::behavior::BaseForceField.

◆ buildStiffnessMatrix()

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::buildStiffnessMatrix ( core::behavior::StiffnessMatrix * matrix )

overridevirtual

Reimplemented from sofa::core::behavior::BaseForceField.

◆ computeMeshVolume() [1/3]

SurfacePressureForceField< defaulttype::Rigid3Types >::Real sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::computeMeshVolume	(	const VecDeriv &	,
		const VecCoord &	x
	)

protected

◆ computeMeshVolume() [2/3]

template<class DataTypes >

SurfacePressureForceField< DataTypes >::Real sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::computeMeshVolume	(	const VecDeriv &	f,
		const VecCoord &	x
	)

protected

Compute mesh volume.

◆ computeMeshVolume() [3/3]

SurfacePressureForceField< defaulttype::Rigid3Types >::Real sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::computeMeshVolume	(	const VecDeriv &	f,
		const VecCoord &	x
	)

protected

◆ computePulseModePressure()

template<class DataTypes >

SurfacePressureForceField< DataTypes >::Real sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::computePulseModePressure

protected

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

◆ draw()

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::draw ( const core::visual::VisualParams * )

overridevirtual

Render internal data of this object, for debugging purposes.

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

◆ getPotentialEnergy()

template<class DataTypes >

SReal sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::getPotentialEnergy	(	const core::MechanicalParams *	,
		const DataVecCoord &
	)		const

overridevirtual

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

◆ init()

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::init ( void )

overridevirtual

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

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

◆ isInPressuredBox()

template<class DataTypes >

bool sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::isInPressuredBox ( const Coord & x ) const

inlineprotected

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

◆ setPressure()

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::setPressure ( const Real _pressure )

◆ SOFA_CLASS()

template<class DataTypes >

sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::SOFA_CLASS	(	SOFA_TEMPLATE(SurfacePressureForceField< DataTypes >, DataTypes)	,
		SOFA_TEMPLATE(core::behavior::ForceField, DataTypes)
	)

◆ verifyDerivative() [1/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::verifyDerivative	(	VecDeriv &	,
		VecDeriv &	,
		VecVec3DerivValues &	,
		VecVec3DerivIndices &	,
		const VecDeriv &
	)

protected

◆ verifyDerivative() [2/3]

template<class DataTypes >

void sofa::component::mechanicalload::SurfacePressureForceField< DataTypes >::verifyDerivative	(	VecDeriv &	v_plus,
		VecDeriv &	v,
		VecVec3DerivValues &	DVval,
		VecVec3DerivIndices &	DVind,
		const VecDeriv &	Din
	)

protected

◆ verifyDerivative() [3/3]

void sofa::component::mechanicalload::SurfacePressureForceField< defaulttype::Rigid3Types >::verifyDerivative	(	VecDeriv &	v_plus,
		VecDeriv &	v,
		VecVec3DerivValues &	DVval,
		VecVec3DerivIndices &	DVind,
		const VecDeriv &	Din
	)

protected

Enum details

◆ State

template<class DataTypes >

enum sofa::component::mechanicalload::SurfacePressureForceField::State

Enumerator
INCREASE
DECREASE

Detailed Description

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

Public Attributes

Protected Attributes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Attribute details

◆ derivTriNormalIndices

◆ derivTriNormalValues

◆ l_topology

◆ m_defaultVolume

◆ m_drawForceScale

◆ m_f

◆ m_mainDirection

◆ m_max

◆ m_min

◆ m_pressure

◆ m_pressureLowerBound

◆ m_pressureSpeed

◆ m_pulseMode

◆ m_pulseModePressure

◆ m_quadIndices

◆ m_topology

◆ m_triangleIndices

◆ m_useTangentStiffness

◆ m_volumeConservationMode

◆ state

Constructor details

◆ SurfacePressureForceField()

◆ ~SurfacePressureForceField()

Function details

◆ addDForce() [1/3]

◆ addDForce() [2/3]

◆ addDForce() [3/3]

◆ addForce()

◆ addKToMatrix()

◆ addQuadSurfacePressure() [1/3]

◆ addQuadSurfacePressure() [2/3]

◆ addQuadSurfacePressure() [3/3]

◆ addTriangleSurfacePressure() [1/3]

◆ addTriangleSurfacePressure() [2/3]

◆ addTriangleSurfacePressure() [3/3]

◆ buildDampingMatrix()

◆ buildStiffnessMatrix()

◆ computeMeshVolume() [1/3]

◆ computeMeshVolume() [2/3]

◆ computeMeshVolume() [3/3]

◆ computePulseModePressure()

◆ draw()

◆ getPotentialEnergy()

◆ init()

◆ isInPressuredBox()

◆ setPressure()

◆ SOFA_CLASS()

◆ verifyDerivative() [1/3]

◆ verifyDerivative() [2/3]

◆ verifyDerivative() [3/3]

Enum details

◆ State

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