#include <TaitSurfacePressureForceField.h>

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

Detailed Description

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

This component computes the volume enclosed by a surface mesh and apply a pressure force following Tait's equation: $P = P_0 - B((V/V_0)^\gamma - 1)$. This ForceField can be used to apply :

a constant pressure (set $B=0$ and use $P_0$)
an ideal gas pressure (set $\gamma=1$ and use $B$)
a pressure from water (set $\gamma=7$ and use $B$)

Public Attributes
sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_p0

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_B

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_gamma

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_injectedVolume

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_maxInjectionRate

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_initialVolume

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_currentInjectedVolume

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_v0

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_currentVolume

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_currentPressure

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_currentStiffness

sofa::core::objectmodel::lifecycle::RenamedData< SeqTriangles >	m_pressureTriangles

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_initialSurfaceArea

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_currentSurfaceArea

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_drawForceScale

sofa::core::objectmodel::lifecycle::RenamedData< sofa::type::RGBAColor >	m_drawForceColor

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_volumeAfterTC

sofa::core::objectmodel::lifecycle::RenamedData< Real >	m_surfaceAreaAfterTC

Data< Real >	d_p0
	IN: Rest pressure when V = V0. More...

Data< Real >	d_B
	IN: Bulk modulus (resistance to uniform compression) More...

Data< Real >	d_gamma
	IN: Bulk modulus (resistance to uniform compression) More...

Data< Real >	d_injectedVolume
	IN: Injected (or extracted) volume since the start of the simulation. More...

Data< Real >	d_maxInjectionRate
	IN: Maximum injection rate (volume per second) More...

Data< Real >	d_initialVolume
	OUT: Initial volume, as computed from the surface rest position. More...

Data< Real >	d_currentInjectedVolume
	OUT: Current injected (or extracted) volume (taking into account maxInjectionRate) More...

Data< Real >	d_v0
	OUT: Rest volume (as computed from initialVolume + injectedVolume) More...

Data< Real >	d_currentVolume
	OUT: Current volume, as computed from the last surface position. More...

Data< Real >	d_currentPressure
	OUT: Current pressure, as computed from the last surface position. More...

Data< Real >	d_currentStiffness
	OUT: dP/dV at current volume and pressure. More...

Data< SeqTriangles >	d_pressureTriangles
	OUT: list of triangles where a pressure is applied (mesh triangles + tessellated quads) More...

Data< Real >	d_initialSurfaceArea
	OUT: Initial surface area, as computed from the surface rest position. More...

Data< Real >	d_currentSurfaceArea
	OUT: Current surface area, as computed from the last surface position. More...

Data< Real >	d_drawForceScale
	DEBUG: scale used to render force vectors. More...

Data< sofa::type::RGBAColor >	d_drawForceColor
	DEBUG: color used to render force vectors. More...

Data< Real >	d_volumeAfterTC
	OUT: Volume after a topology change. More...

Data< Real >	d_surfaceAreaAfterTC
	OUT: Surface area after a topology change. More...

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

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

objectmodel::lifecycle::DeprecatedData	isCompliance
	Considered as compliance, else considered as stiffness (default to false) More...

Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< 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 object belongs to More...

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

Data< sofa::core::objectmodel::ComponentState >	d_componentState
	The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Protected Attributes
sofa::core::topology::BaseMeshTopology *	m_topology

int	lastTopologyRevision

Real	reset_injectedVolume

Real	reset_currentInjectedVolume

VecDeriv	gradV

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(TaitSurfacePressureForceField, DataTypes), SOFA_TEMPLATE(core::behavior::ForceField, DataTypes))

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

void	storeResetState () override
	Save the initial state for later uses in reset() More...

void	reset () override
	Reset to initial state. More...

void	handleEvent (core::objectmodel::Event *event) override
	Handle an event. 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 &d_df, const DataVecDeriv &d_dx) override

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

SReal	getPotentialEnergy (const core::MechanicalParams *, const DataVecCoord &) const override

template<class MatrixWriter >
void	addKToMatrixT (const core::MechanicalParams *mparams, MatrixWriter mwriter)

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

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

void	draw (const core::visual::VisualParams *vparams) override
	Render internal data of this object, for debugging purposes. More...

Public Member Functions inherited from sofa::core::behavior::ForceField< DataTypes >
	SOFA_CLASS2 (SOFA_TEMPLATE(ForceField, DataTypes), BaseForceField, SOFA_TEMPLATE(SingleStateAccessor, DataTypes))

void	addForce (const MechanicalParams *mparams, MultiVecDerivId fId) override

void	addDForce (const MechanicalParams *mparams, MultiVecDerivId dfId) override

virtual void	addClambda (const MechanicalParams *mparams, DataVecDeriv &df, const DataVecDeriv &lambda, SReal cFactor)

virtual void	addClambda (const MechanicalParams *, MultiVecDerivId, MultiVecDerivId, SReal)
	Accumulate the contribution of the C compliant matrix multiplied by the given Lagrange multipliers lambda vector with the given cFactor coefficient. More...

SReal	getPotentialEnergy (const MechanicalParams *mparams) const override

void	addKToMatrix (const MechanicalParams mparams, const sofa::core::behavior::MultiMatrixAccessor matrix) override
	Compute the system matrix corresponding to . 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 *)

virtual void	addClambda (const MechanicalParams *, MultiVecDerivId, MultiVecDerivId, SReal)
	Accumulate the contribution of the C compliant matrix multiplied by the given Lagrange multipliers lambda vector with the given cFactor coefficient. More...

Public Member Functions inherited from sofa::core::behavior::StateAccessor
	SOFA_ABSTRACT_CLASS (StateAccessor, objectmodel::BaseObject)

virtual const MultiLink< StateAccessor, BaseMechanicalState, BaseLink::FLAG_DUPLICATE >::Container &	getMechanicalStates () const
	Return a list of mechanical states to which this component is associated. More...

void	computeBBox (const core::ExecParams *params, bool onlyVisible=false) override

Public Member Functions inherited from sofa::core::objectmodel::BaseObject
	SOFA_CLASS (BaseObject, Base)

void	setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
	Sets a source Object and parses it to collect dependent Data. More...

void	setSrc (const std::string &v, const BaseObject loader, std::vector< std::string > attributeList=nullptr)

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	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	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
	TaitSurfacePressureForceField ()

virtual	~TaitSurfacePressureForceField ()

virtual void	updateFromTopology ()

virtual void	computePressureTriangles ()

virtual void	computeMeshVolumeAndArea (Real &volume, Real &area, const helper::ReadAccessor< DataVecCoord > &x)

void	computePressureAndStiffness (Real &pressure, Real &stiffness, Real currentVolume, Real v0)

virtual void	computeStatistics (const helper::ReadAccessor< DataVecCoord > &x)

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::IntrusiveObject
virtual	~IntrusiveObject ()=default

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

◆ d_B

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_B

IN: Bulk modulus (resistance to uniform compression)

◆ d_currentInjectedVolume

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_currentInjectedVolume

OUT: Current injected (or extracted) volume (taking into account maxInjectionRate)

◆ d_currentPressure

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_currentPressure

OUT: Current pressure, as computed from the last surface position.

◆ d_currentStiffness

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_currentStiffness

OUT: dP/dV at current volume and pressure.

◆ d_currentSurfaceArea

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_currentSurfaceArea

OUT: Current surface area, as computed from the last surface position.

◆ d_currentVolume

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_currentVolume

OUT: Current volume, as computed from the last surface position.

◆ d_drawForceColor

template<class DataTypes >

Data< sofa::type::RGBAColor > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_drawForceColor

DEBUG: color used to render force vectors.

◆ d_drawForceScale

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_drawForceScale

DEBUG: scale used to render force vectors.

◆ d_gamma

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_gamma

IN: Bulk modulus (resistance to uniform compression)

◆ d_initialSurfaceArea

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_initialSurfaceArea

OUT: Initial surface area, as computed from the surface rest position.

◆ d_initialVolume

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_initialVolume

OUT: Initial volume, as computed from the surface rest position.

◆ d_injectedVolume

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_injectedVolume

IN: Injected (or extracted) volume since the start of the simulation.

◆ d_maxInjectionRate

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_maxInjectionRate

IN: Maximum injection rate (volume per second)

◆ d_p0

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_p0

IN: Rest pressure when V = V0.

◆ d_pressureTriangles

template<class DataTypes >

Data< SeqTriangles > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_pressureTriangles

OUT: list of triangles where a pressure is applied (mesh triangles + tessellated quads)

◆ d_surfaceAreaAfterTC

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_surfaceAreaAfterTC

OUT: Surface area after a topology change.

◆ d_v0

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_v0

OUT: Rest volume (as computed from initialVolume + injectedVolume)

◆ d_volumeAfterTC

template<class DataTypes >

Data< Real > sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::d_volumeAfterTC

OUT: Volume after a topology change.

◆ gradV

template<class DataTypes >

VecDeriv sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::gradV

protected

◆ l_topology

template<class DataTypes >

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

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

◆ lastTopologyRevision

template<class DataTypes >

int sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::lastTopologyRevision

protected

◆ m_B

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_B

◆ m_currentInjectedVolume

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_currentInjectedVolume

◆ m_currentPressure

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_currentPressure

◆ m_currentStiffness

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_currentStiffness

◆ m_currentSurfaceArea

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_currentSurfaceArea

◆ m_currentVolume

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_currentVolume

◆ m_drawForceColor

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<sofa::type::RGBAColor> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_drawForceColor

◆ m_drawForceScale

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_drawForceScale

◆ m_gamma

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_gamma

◆ m_initialSurfaceArea

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_initialSurfaceArea

◆ m_initialVolume

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_initialVolume

◆ m_injectedVolume

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_injectedVolume

◆ m_maxInjectionRate

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_maxInjectionRate

◆ m_p0

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_p0

◆ m_pressureTriangles

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<SeqTriangles> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_pressureTriangles

◆ m_surfaceAreaAfterTC

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_surfaceAreaAfterTC

◆ m_topology

template<class DataTypes >

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

protected

◆ m_v0

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_v0

◆ m_volumeAfterTC

template<class DataTypes >

sofa::core::objectmodel::lifecycle::RenamedData<Real> sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::m_volumeAfterTC

◆ reset_currentInjectedVolume

template<class DataTypes >

Real sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::reset_currentInjectedVolume

protected

◆ reset_injectedVolume

template<class DataTypes >

Real sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::reset_injectedVolume

protected

Constructor details

◆ TaitSurfacePressureForceField()

template<class DataTypes >

sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::TaitSurfacePressureForceField

protected

◆ ~TaitSurfacePressureForceField()

template<class DataTypes >

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

protectedvirtual

Function details

◆ addDForce()

template<class DataTypes >

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

◆ addForce()

template<class DataTypes >

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

◆ addKToMatrixT()

template<class DataTypes >

template<class MatrixWriter >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::addKToMatrixT	(	const core::MechanicalParams *	mparams,
		MatrixWriter	mwriter
	)

◆ buildDampingMatrix()

template<class DataTypes >

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

finalvirtual

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

◆ buildStiffnessMatrix()

template<class DataTypes >

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

overridevirtual

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

◆ computeMeshVolumeAndArea()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::computeMeshVolumeAndArea	(	Real &	volume,
		Real &	area,
		const helper::ReadAccessor< DataVecCoord > &	x
	)

protectedvirtual

◆ computePressureAndStiffness()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::computePressureAndStiffness	(	Real &	pressure,
		Real &	stiffness,
		Real	currentVolume,
		Real	v0
	)

protected

◆ computePressureTriangles()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::computePressureTriangles

protectedvirtual

◆ computeStatistics()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::computeStatistics ( const helper::ReadAccessor< DataVecCoord > & x )

protectedvirtual

◆ draw()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< 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::TaitSurfacePressureForceField< DataTypes >::getPotentialEnergy	(	const core::MechanicalParams *	,
		const DataVecCoord &
	)		const

overridevirtual

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

◆ handleEvent()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::handleEvent ( core::objectmodel::Event * )

overridevirtual

Handle an event.

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

◆ init()

template<class DataTypes >

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

overridevirtual

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

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

◆ reset()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::reset

overridevirtual

Reset to initial state.

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

◆ SOFA_CLASS()

template<class DataTypes >

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

◆ storeResetState()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::storeResetState

overridevirtual

Save the initial state for later uses in reset()

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

◆ updateFromTopology()

template<class DataTypes >

void sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >::updateFromTopology

protectedvirtual

Enum details

◆ anonymous enum

template<class DataTypes >

anonymous enum

Enumerator
DerivSize

Detailed Description

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

Public Attributes

Protected Attributes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Attribute details

◆ d_B

◆ d_currentInjectedVolume

◆ d_currentPressure

◆ d_currentStiffness

◆ d_currentSurfaceArea

◆ d_currentVolume

◆ d_drawForceColor

◆ d_drawForceScale

◆ d_gamma

◆ d_initialSurfaceArea

◆ d_initialVolume

◆ d_injectedVolume

◆ d_maxInjectionRate

◆ d_p0

◆ d_pressureTriangles

◆ d_surfaceAreaAfterTC

◆ d_v0

◆ d_volumeAfterTC

◆ gradV

◆ l_topology

◆ lastTopologyRevision

◆ m_B

◆ m_currentInjectedVolume

◆ m_currentPressure

◆ m_currentStiffness

◆ m_currentSurfaceArea

◆ m_currentVolume

◆ m_drawForceColor

◆ m_drawForceScale

◆ m_gamma

◆ m_initialSurfaceArea

◆ m_initialVolume

◆ m_injectedVolume

◆ m_maxInjectionRate

◆ m_p0

◆ m_pressureTriangles

◆ m_surfaceAreaAfterTC

◆ m_topology

◆ m_v0

◆ m_volumeAfterTC

◆ reset_currentInjectedVolume

◆ reset_injectedVolume

Constructor details

◆ TaitSurfacePressureForceField()

◆ ~TaitSurfacePressureForceField()

Function details

◆ addDForce()

◆ addForce()

◆ addKToMatrix()

◆ addKToMatrixT()

◆ buildDampingMatrix()

◆ buildStiffnessMatrix()

◆ computeMeshVolumeAndArea()

◆ computePressureAndStiffness()

◆ computePressureTriangles()

◆ computeStatistics()

◆ draw()

◆ getPotentialEnergy()

◆ handleEvent()

◆ init()

◆ reset()

◆ SOFA_CLASS()

◆ storeResetState()

◆ updateFromTopology()

Enum details

◆ anonymous enum

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