#include <TopologicalMapping.h>

This Interface is a new kind of Mapping, called TopologicalMapping, which converts an INPUT TOPOLOGY to an OUTPUT TOPOLOGY (both topologies are of type BaseTopology) More...

Inheritance diagram for sofa::core::topology::TopologicalMapping:

[legend]

Detailed Description

This Interface is a new kind of Mapping, called TopologicalMapping, which converts an INPUT TOPOLOGY to an OUTPUT TOPOLOGY (both topologies are of type BaseTopology)

It first initializes the mesh of the output topology from the mesh of the input topology, and it creates the two Index Maps that maintain the correspondence between the indices of their common elements.

Then, at each propagation of topological changes, it translates the topological change events that are propagated from the INPUT topology into specific actions that call element adding or element removal methods on the OUTPUT topology, and it updates the Index Maps.

So, at each time step, the geometrical and adjacency information are consistent in both topologies.

Public Attributes
SingleLink< TopologicalMapping, In, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	fromModel
	Input source BaseTopology. More...

SingleLink< TopologicalMapping, Out, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_STRONGLINK >	toModel
	Output target BaseTopology. More...

Data< sofa::type::vector< Index > >	Loc2GlobDataVec

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
std::map< Index, Index >	Glob2LocMap

std::map< Index, sofa::type::vector< Index > >	In2OutMap

ElementType	m_inputType = geometry::ElementType::UNKNOWN

ElementType	m_outputType = geometry::ElementType::UNKNOWN

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_ABSTRACT_CLASS (TopologicalMapping, objectmodel::BaseObject)

virtual void	setTopologies (In from, Out to)
	Specify the input and output models. More...

void	setPathInputObject (const std::string &o)
	Set the path to the objects mapped in the scene graph. More...

void	setPathOutputObject (const std::string &o)

In *	getFrom ()
	Accessor to the INPUT topology of the TopologicalMapping : More...

Out *	getTo ()
	Accessor to the OUTPUT topology of the TopologicalMapping : More...

virtual void	updateTopologicalMappingTopDown ()=0
	Method called at each topological changes propagation which comes from the INPUT topology to adapt the OUTPUT topology : More...

virtual void	updateTopologicalMappingBottomUp ()
	Method called at each topological changes propagation which comes from the OUTPUT topology to adapt the INPUT topology : More...

virtual bool	propagateFromInputToOutputModel ()
	Return true if this mapping is able to propagate topological changes from input to output model. More...

virtual bool	propagateFromOutputToInputModel ()
	Return true if this mapping is able to propagate topological changes from output to input model. More...

virtual bool	isTheOutputTopologySubdividingTheInputOne ()
	return true if the output topology subdivide the input one. (the topology uses the Loc2GlobVec/Glob2LocMap/In2OutMap structs and share the same DOFs) More...

const std::map< Index, Index > &	getGlob2LocMap ()
	Accessor to index maps : More...

virtual Index	getGlobIndex (Index ind)

virtual Index	getFromIndex (Index ind)

void	dumpGlob2LocMap ()

void	dumpLoc2GlobVec ()

virtual bool	checkTopologies ()
	Method to check the topology mapping maps regarding the upper topology. More...

virtual void	getFromIndex (type::vector< Index > &, const Index) const

const std::map< Index, sofa::type::vector< Index > > &	getIn2OutMap ()

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

virtual void	computeBBox (const core::ExecParams *, bool=false)

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

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

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

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)

Static Public Member Functions
template<class T >
static bool	canCreate (T &obj, core::objectmodel::BaseContext context, core::objectmodel::BaseObjectDescription *arg)

template<class T >
static T::SPtr	create (T , core::objectmodel::BaseContext context, core::objectmodel::BaseObjectDescription *arg)

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)

Protected Member Functions
	TopologicalMapping ()

	~TopologicalMapping () override

bool	checkTopologyInputTypes ()

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

Attribute details

◆ fromModel

SingleLink<TopologicalMapping, In, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> sofa::core::topology::TopologicalMapping::fromModel

Input source BaseTopology.

◆ Glob2LocMap

std::map<Index, Index> sofa::core::topology::TopologicalMapping::Glob2LocMap

protected

◆ In2OutMap

std::map<Index, sofa::type::vector<Index> > sofa::core::topology::TopologicalMapping::In2OutMap

protected

◆ Loc2GlobDataVec

Data<sofa::type::vector<Index> > sofa::core::topology::TopologicalMapping::Loc2GlobDataVec

◆ m_inputType

ElementType sofa::core::topology::TopologicalMapping::m_inputType = geometry::ElementType::UNKNOWN

protected

◆ m_outputType

ElementType sofa::core::topology::TopologicalMapping::m_outputType = geometry::ElementType::UNKNOWN

protected

◆ toModel

SingleLink<TopologicalMapping, Out, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> sofa::core::topology::TopologicalMapping::toModel

Output target BaseTopology.

Constructor details

◆ TopologicalMapping()

sofa::core::topology::TopologicalMapping::TopologicalMapping ( )

protected

◆ ~TopologicalMapping()

sofa::core::topology::TopologicalMapping::~TopologicalMapping ( )

inlineoverrideprotected

Function details

◆ canCreate()

template<class T >

static bool sofa::core::topology::TopologicalMapping::canCreate	(	T *&	obj,
		core::objectmodel::BaseContext *	context,
		core::objectmodel::BaseObjectDescription *	arg
	)

inlinestatic

Pre-construction check method called by ObjectFactory.

This implementation reads the "input" and "output" attributes and checks that the corresponding objects exist, and are not the same object.

◆ checkTopologies()

virtual bool sofa::core::topology::TopologicalMapping::checkTopologies ( )

inlinevirtual

Method to check the topology mapping maps regarding the upper topology.

Reimplemented in sofa::component::topology::mapping::Tetra2TriangleTopologicalMapping.

◆ checkTopologyInputTypes()

bool sofa::core::topology::TopologicalMapping::checkTopologyInputTypes ( )

protected

◆ create()

template<class T >

static T::SPtr sofa::core::topology::TopologicalMapping::create	(	T *	,
		core::objectmodel::BaseContext *	context,
		core::objectmodel::BaseObjectDescription *	arg
	)

inlinestatic

Construction method called by ObjectFactory.

This implementation read the object1 and object2 attributes to find the input and output topologies of this mapping.

◆ dumpGlob2LocMap()

void sofa::core::topology::TopologicalMapping::dumpGlob2LocMap ( )

◆ dumpLoc2GlobVec()

void sofa::core::topology::TopologicalMapping::dumpLoc2GlobVec ( )

◆ getFrom()

In* sofa::core::topology::TopologicalMapping::getFrom ( )

inline

Accessor to the INPUT topology of the TopologicalMapping :

◆ getFromIndex() [1/2]

Index sofa::core::topology::TopologicalMapping::getFromIndex ( Index ind )

virtual

◆ getFromIndex() [2/2]

virtual void sofa::core::topology::TopologicalMapping::getFromIndex	(	type::vector< Index > &	,
		const	Index
	)		const

inlinevirtual

return all the from indices in the 'In' topology corresponding to the index in the 'Out' topology. This function is used instead of the previous one when the function isTheOutputTopologySubdividingTheInputOne() returns false.

◆ getGlob2LocMap()

const std::map<Index, Index>& sofa::core::topology::TopologicalMapping::getGlob2LocMap ( )

inline

Accessor to index maps :

◆ getGlobIndex()

Index sofa::core::topology::TopologicalMapping::getGlobIndex ( Index ind )

virtual

Reimplemented in sofa::component::topology::mapping::SubsetTopologicalMapping, sofa::component::topology::mapping::CenterPointTopologicalMapping, and sofa::component::mapping::linear::Mesh2PointTopologicalMapping.

◆ getIn2OutMap()

const std::map<Index, sofa::type::vector<Index> >& sofa::core::topology::TopologicalMapping::getIn2OutMap ( )

inline

◆ getTo()

Out* sofa::core::topology::TopologicalMapping::getTo ( )

inline

Accessor to the OUTPUT topology of the TopologicalMapping :

◆ isTheOutputTopologySubdividingTheInputOne()

virtual bool sofa::core::topology::TopologicalMapping::isTheOutputTopologySubdividingTheInputOne ( )

inlinevirtual

return true if the output topology subdivide the input one. (the topology uses the Loc2GlobVec/Glob2LocMap/In2OutMap structs and share the same DOFs)

Reimplemented in sofa::component::topology::mapping::SubsetTopologicalMapping.

◆ propagateFromInputToOutputModel()

virtual bool sofa::core::topology::TopologicalMapping::propagateFromInputToOutputModel ( )

inlinevirtual

Return true if this mapping is able to propagate topological changes from input to output model.

Reimplemented in sofa::component::mapping::linear::SimpleTesselatedTetraTopologicalMapping.

◆ propagateFromOutputToInputModel()

virtual bool sofa::core::topology::TopologicalMapping::propagateFromOutputToInputModel ( )

inlinevirtual

Return true if this mapping is able to propagate topological changes from output to input model.

Reimplemented in sofa::component::mapping::linear::SimpleTesselatedTetraTopologicalMapping.

◆ setPathInputObject()

void sofa::core::topology::TopologicalMapping::setPathInputObject ( const std::string & o )

inline

Set the path to the objects mapped in the scene graph.

◆ setPathOutputObject()

void sofa::core::topology::TopologicalMapping::setPathOutputObject ( const std::string & o )

inline

◆ setTopologies()

void sofa::core::topology::TopologicalMapping::setTopologies	(	In *	from,
		Out *	to
	)

virtual

Specify the input and output models.

◆ SOFA_ABSTRACT_CLASS()

sofa::core::topology::TopologicalMapping::SOFA_ABSTRACT_CLASS	(	TopologicalMapping	,
		objectmodel::BaseObject
	)

◆ updateTopologicalMappingBottomUp()

virtual void sofa::core::topology::TopologicalMapping::updateTopologicalMappingBottomUp ( )

inlinevirtual

Method called at each topological changes propagation which comes from the OUTPUT topology to adapt the INPUT topology :

Reimplemented in sofa::component::mapping::linear::SimpleTesselatedTetraTopologicalMapping.

◆ updateTopologicalMappingTopDown()

virtual void sofa::core::topology::TopologicalMapping::updateTopologicalMappingTopDown ( )

pure virtual

Method called at each topological changes propagation which comes from the INPUT topology to adapt the OUTPUT topology :

Detailed Description

Public Attributes

Protected Attributes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Attribute details

◆ fromModel

◆ Glob2LocMap

◆ In2OutMap

◆ Loc2GlobDataVec

◆ m_inputType

◆ m_outputType

◆ toModel

Constructor details

◆ TopologicalMapping()

◆ ~TopologicalMapping()

Function details

◆ canCreate()

◆ checkTopologies()

◆ checkTopologyInputTypes()

◆ create()

◆ dumpGlob2LocMap()

◆ dumpLoc2GlobVec()

◆ getFrom()

◆ getFromIndex() [1/2]

◆ getFromIndex() [2/2]

◆ getGlob2LocMap()

◆ getGlobIndex()

◆ getIn2OutMap()

◆ getTo()

◆ isTheOutputTopologySubdividingTheInputOne()

◆ propagateFromInputToOutputModel()

◆ propagateFromOutputToInputModel()

◆ setPathInputObject()

◆ setPathOutputObject()

◆ setTopologies()

◆ SOFA_ABSTRACT_CLASS()

◆ updateTopologicalMappingBottomUp()

◆ updateTopologicalMappingTopDown()