#include <MatrixProjectionMethod.h>

Inheritance diagram for sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >:

Detailed Description

template<class TMatrix>
class sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >

The component is a @MatrixMapping computing the matrix projection using the Eigen library.

Protected Attributes
Data< bool >	d_areJacobiansConstant
	True if mapping jacobians are considered constant over time. They are computed only the first time. More...

std::optional< sofa::type::fixed_array< MappingJacobians< TMatrix >, 2 > >	m_mappingJacobians

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

Public Member Functions
	SOFA_CLASS (SOFA_TEMPLATE(MatrixProjectionMethod, TMatrix), SOFA_TEMPLATE(BaseMatrixProjectionMethod, TMatrix))

	~MatrixProjectionMethod () override

void	computeMatrixJacobians (const core::MechanicalParams mparams, const MappingGraph &mappingGraph, TMatrix matrixToProject)

Public Member Functions inherited from sofa::component::linearsystem::BaseMatrixProjectionMethod< TMatrix >
	SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE(BaseMatrixProjectionMethod, TMatrix), core::behavior::StateAccessor)

	~BaseMatrixProjectionMethod () override

virtual bool	hasPairStates (const PairMechanicalStates &pairStates) const

void	setPairStates (const PairMechanicalStates &pairStates)

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)

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

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

virtual bool	insertInNode (BaseNode *)

virtual bool	removeInNode (BaseNode *)

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	init ()
	Initialization method called at graph creation and modification, during top-down traversal. More...

virtual void	bwdInit ()
	Initialization method called at graph creation and modification, during bottom-up traversal. More...

void	updateInternal ()
	Update method called when variables (used to compute other internal variables) are modified. More...

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

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

virtual void	cleanup ()

Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const 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)

Protected Member Functions
	MatrixProjectionMethod (const PairMechanicalStates &states)

	MatrixProjectionMethod ()

void	reinit () override
	Update method called when variables used in precomputation are modified. More...

virtual void	computeMatrixProduct (const MappingGraph &mappingGraph, TMatrix matrixToProject, linearalgebra::BaseMatrix globalMatrix)

virtual void	projectMatrixToGlobalMatrix (const core::MechanicalParams mparams, const MappingGraph &mappingGraph, TMatrix matrixToProject, linearalgebra::BaseMatrix *globalMatrix) override
	The main function of the component: it compute the mappings jacobian matrices, then the projection of the provided matrix. More...

std::vector< unsigned int >	identifyAffectedDoFs (BaseMechanicalState mstate, TMatrix crs)
	Given a Mechanical State and its matrix, identifies the nodes affected by the matrix. More...

MappingJacobians< TMatrix >	computeJacobiansFrom (BaseMechanicalState mstate, const core::MechanicalParams mparams, const MappingGraph &mappingGraph, TMatrix *crs)

core::objectmodel::BaseContext *	getSolveContext ()

void	addMappedMatrixToGlobalMatrixEigen (sofa::type::fixed_array< core::behavior::BaseMechanicalState , 2 > mstatePair, TMatrix mappedMatrix, sofa::type::fixed_array< MappingJacobians< TMatrix >, 2 > jacobians, const MappingGraph &mappingGraph, linearalgebra::BaseMatrix *globalMatrix)

Eigen::Map< Eigen::SparseMatrix< Block, Eigen::RowMajor > >	makeEigenMap (const TMatrix &matrix)

virtual void	computeProjection (const Eigen::Map< Eigen::SparseMatrix< Block, Eigen::RowMajor > > KMap, const sofa::type::fixed_array< std::shared_ptr< TMatrix >, 2 > J, Eigen::SparseMatrix< Block, Eigen::RowMajor > &JT_K_J)

Protected Member Functions inherited from sofa::component::linearsystem::BaseMatrixProjectionMethod< TMatrix >
	BaseMatrixProjectionMethod (const PairMechanicalStates &states)

	BaseMatrixProjectionMethod ()=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...

Additional Inherited Members
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}

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_areJacobiansConstant

template<class TMatrix >

Data<bool> sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::d_areJacobiansConstant

protected

True if mapping jacobians are considered constant over time. They are computed only the first time.

◆ m_mappingJacobians

template<class TMatrix >

std::optional<sofa::type::fixed_array<MappingJacobians<TMatrix>, 2> > sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::m_mappingJacobians

protected

Constructor details

◆ ~MatrixProjectionMethod()

template<class TMatrix >

sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::~MatrixProjectionMethod ( )

overridedefault

◆ MatrixProjectionMethod() [1/2]

template<class TMatrix >

sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::MatrixProjectionMethod ( const PairMechanicalStates & states )

explicitprotected

◆ MatrixProjectionMethod() [2/2]

template<class TMatrix >

sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::MatrixProjectionMethod

protected

Function details

◆ addMappedMatrixToGlobalMatrixEigen()

template<class TMatrix >

void sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::addMappedMatrixToGlobalMatrixEigen	(	sofa::type::fixed_array< core::behavior::BaseMechanicalState *, 2 >	mstatePair,
		TMatrix *	mappedMatrix,
		sofa::type::fixed_array< MappingJacobians< TMatrix >, 2 >	jacobians,
		const MappingGraph &	mappingGraph,
		linearalgebra::BaseMatrix *	globalMatrix
	)

protected

Add the local matrix which has been built locally to the main global matrix, using the Eigen library

Remarks: Eigen manages the matrix operations better than CompressedRowSparseMatrix. In terms of performances, it is preferable to go with Eigen.

Parameters

mstatePair	The mapped mechanical state which the local matrix is associated
mappedMatrix	The local matrix
jacobians	The required mapping jacobians to project from a mechanical state toward the top most mechanical states
mappingGraph	The mapping graph used to know the relationships between mechanical states. In particular, it is used to know where in the global matrix the local matrix must be added.
globalMatrix	Matrix in which the local matrix is added.

◆ computeJacobiansFrom()

template<class TMatrix >

MappingJacobians< TMatrix > sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::computeJacobiansFrom	(	BaseMechanicalState *	mstate,
		const core::MechanicalParams *	mparams,
		const MappingGraph &	mappingGraph,
		TMatrix *	crs
	)

protected

Build the jacobian matrices of mappings from a mapped state to its top most parents (in the sense of mappings)

◆ computeMatrixJacobians()

template<class TMatrix >

void sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::computeMatrixJacobians	(	const core::MechanicalParams *	mparams,
		const MappingGraph &	mappingGraph,
		TMatrix *	matrixToProject
	)

◆ computeMatrixProduct()

template<class TMatrix >

void sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::computeMatrixProduct	(	const MappingGraph &	mappingGraph,
		TMatrix *	matrixToProject,
		linearalgebra::BaseMatrix *	globalMatrix
	)

protectedvirtual

◆ computeProjection()

template<class TMatrix >

void sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::computeProjection	(	const Eigen::Map< Eigen::SparseMatrix< Block, Eigen::RowMajor > >	KMap,
		const sofa::type::fixed_array< std::shared_ptr< TMatrix >, 2 >	J,
		Eigen::SparseMatrix< Block, Eigen::RowMajor > &	JT_K_J
	)

protectedvirtual

◆ getSolveContext()

template<class TMatrix >

core::objectmodel::BaseContext * sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::getSolveContext

protected

◆ identifyAffectedDoFs()

template<class TMatrix >

std::vector< unsigned > sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::identifyAffectedDoFs	(	BaseMechanicalState *	mstate,
		TMatrix *	crs
	)

protected

Given a Mechanical State and its matrix, identifies the nodes affected by the matrix.

◆ makeEigenMap()

template<class TMatrix >

Eigen::Map< Eigen::SparseMatrix< typename MatrixProjectionMethod< TMatrix >::Block, Eigen::RowMajor > > sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::makeEigenMap ( const TMatrix & matrix )

protected

◆ projectMatrixToGlobalMatrix()

template<class TMatrix >

void sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::projectMatrixToGlobalMatrix	(	const core::MechanicalParams *	mparams,
		const MappingGraph &	mappingGraph,
		TMatrix *	matrixToProject,
		linearalgebra::BaseMatrix *	globalMatrix
	)

overrideprotectedvirtual

The main function of the component: it compute the mappings jacobian matrices, then the projection of the provided matrix.

Parameters

mparams
mappingGraph	The current mapping graph linking all the @BaseMechanicalState
matrixToProject	The matrix to project. Its size must be compatible with the sizes of the @BaseMechanicalState's
globalMatrix	The product is added into this matrix

Implements sofa::component::linearsystem::BaseMatrixProjectionMethod< TMatrix >.

◆ reinit()

template<class TMatrix >

void sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::reinit

overrideprotectedvirtual

Update method called when variables used in precomputation are modified.

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

◆ SOFA_CLASS()

template<class TMatrix >

sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >::SOFA_CLASS	(	SOFA_TEMPLATE(MatrixProjectionMethod< TMatrix >, TMatrix)	,
		SOFA_TEMPLATE(BaseMatrixProjectionMethod< TMatrix >, TMatrix)
	)

Detailed Description

template<class TMatrix> class sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >

Protected Attributes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Attribute details

◆ d_areJacobiansConstant

◆ m_mappingJacobians

Constructor details

◆ ~MatrixProjectionMethod()

◆ MatrixProjectionMethod() [1/2]

◆ MatrixProjectionMethod() [2/2]

Function details

◆ addMappedMatrixToGlobalMatrixEigen()

◆ computeJacobiansFrom()

◆ computeMatrixJacobians()

◆ computeMatrixProduct()

◆ computeProjection()

◆ getSolveContext()

◆ identifyAffectedDoFs()

◆ makeEigenMap()

◆ projectMatrixToGlobalMatrix()

◆ reinit()

◆ SOFA_CLASS()

template<class TMatrix>
class sofa::component::linearsystem::MatrixProjectionMethod< TMatrix >