SOFA API  180226c0
Open source framework for multi-physics simuation
sofa::component::topology::SubsetTopologicalMapping Class Reference

#include <SubsetTopologicalMapping.h>

Inheritance diagram for sofa::component::topology::SubsetTopologicalMapping:

Detailed Description

This class is a specific implementation of TopologicalMapping where the destination topology should be kept identical to the source topology. The implementation currently assumes that both topology have been initialized identically.

Public Attributes

Data< boolsamePoints
 True if the same set of points is used in both topologies. More...
 
Data< boolhandleEdges
 True if edges events and mapping should be handled. More...
 
Data< boolhandleTriangles
 True if triangles events and mapping should be handled. More...
 
Data< boolhandleQuads
 True if quads events and mapping should be handled. More...
 
Data< boolhandleTetrahedra
 True if tetrahedra events and mapping should be handled. More...
 
Data< boolhandleHexahedra
 True if hexahedra events and mapping should be handled. More...
 
Data< SetIndexpointS2D
 Internal source -> destination topology points map. More...
 
Data< SetIndexpointD2S
 Internal destination -> source topology points map (link to SubsetMapping::indices to handle the mechanical-side of the mapping. More...
 
Data< SetIndexedgeS2D
 Internal source -> destination topology edges map. More...
 
Data< SetIndexedgeD2S
 Internal destination -> source topology edges map. More...
 
Data< SetIndextriangleS2D
 Internal source -> destination topology triangles map. More...
 
Data< SetIndextriangleD2S
 Internal destination -> source topology triangles map. More...
 
Data< SetIndexquadS2D
 Internal source -> destination topology quads map. More...
 
Data< SetIndexquadD2S
 Internal destination -> source topology quads map. More...
 
Data< SetIndextetrahedronS2D
 Internal source -> destination topology tetrahedra map. More...
 
Data< SetIndextetrahedronD2S
 Internal destination -> source topology tetrahedra map. More...
 
Data< SetIndexhexahedronS2D
 Internal source -> destination topology hexahedra map. More...
 
Data< SetIndexhexahedronD2S
 Internal destination -> source topology hexahedra map. More...
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
helper::system::SofaOStream< helper::logging::Message::Warningserr
 
helper::system::SofaOStream< helper::logging::Message::Infosout
 
helper::system::SofaEndl< Basesendl
 runs the stream processing More...
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet belongs to More...
 
Data< sofa::defaulttype::BoundingBoxf_bbox
 this object bounding box More...
 
Data< ComponentStated_componentstate
 the object state More...
 
Data< ComponentState > & m_componentstate {d_componentstate}
 TODO bruno: uncomment once c++17 is enabled in SOFA. More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Public Member Functions

 SOFA_CLASS (SubsetTopologicalMapping, sofa::core::topology::TopologicalMapping)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void updateTopologicalMappingTopDown () override
 Translates the TopologyChange objects from the source to the target. More...
 
bool isTheOutputTopologySubdividingTheInputOne () override
 return true if the output topology subdivide the input one. (the topology uses the Loc2GlobVec/Glob2LocMap/In2OutMap structs and share the same DOFs) More...
 
unsigned int getGlobIndex (unsigned int ind) override
 
unsigned int getFromIndex (unsigned int ind) override
 
- Public Member Functions inherited from sofa::core::topology::TopologicalMapping
 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)
 
IngetFrom ()
 Accessor to the INPUT topology of the TopologicalMapping : More...
 
OutgetTo ()
 Accessor to the OUTPUT topology of the TopologicalMapping : 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...
 
const std::map< unsigned int, unsigned int > & getGlob2LocMap ()
 Accessor to index maps : More...
 
Data< sofa::helper::vector< unsigned int > > & getLoc2GlobVec ()
 
void dumpGlob2LocMap ()
 
void dumpLoc2GlobVec ()
 
virtual bool checkTopologies ()
 Method to check the topology mapping maps regarding the upper topology. More...
 
virtual void getFromIndex (helper::vector< unsigned int > &, const unsigned int) const
 
const std::map< unsigned int, sofa::helper::vector< unsigned int > > & 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)
 
void * findLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const
 Return the full path name of this object. More...
 
virtual bool insertInNode (BaseNode *)
 
virtual bool removeInNode (BaseNode *)
 
template<class T >
T::SPtr searchLocal () const
 Local search of an object of the given type. More...
 
template<class T >
T::SPtr searchUp () const
 Upward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchDown () const
 Downward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchFromRoot () const
 
template<class T >
T::SPtr searchInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal () const
 Local search of all objects of the given type. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp () const
 Upward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown () const
 Downward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot () const
 Search of all objects of the given type, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const Tag &t) const
 Local search of all objects of the given type with a given Tag. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const Tag &t) const
 Upward search of all objects of the given type with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const Tag &t) const
 Downward search of all objects of the given typee with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const Tag &t) const
 Search of all objects of the given typee with a given Tag, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const Tag &t) const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const TagSet &t) const
 Local search of all objects of the given type with a given TagSet. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const TagSet &t) const
 Upward search of all objects of the given type with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const TagSet &t) const
 Downward search of all objects of the given typee with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const TagSet &t) const
 Search of all objects of the given typee with a given TagSet, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const TagSet &t) const
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
void copyAspect (int destAspect, int srcAspect) override
 Copy the source aspect to the destination aspect for each Data in the component. More...
 
void releaseAspect (int aspect) override
 Release memory allocated for the specified aspect. More...
 
virtual void handleEvent (Event *)
 Handle an event. More...
 
virtual void handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
void parse (BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
virtual void bwdInit ()
 Initialization method called at graph creation and modification, during bottom-up traversal. More...
 
virtual void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
void updateInternal ()
 Update method called when variables (used to compute other internal variables) are modified. More...
 
virtual void storeResetState ()
 Save the initial state for later uses in reset() More...
 
virtual void reset ()
 Reset to initial state. More...
 
virtual void cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
const std::string & getName () const
 Accessor to the object name. More...
 
void setName (const std::string &n)
 Set the name of this object. More...
 
void setName (const std::string &n, int counter)
 Set the name of this object, adding an integer counter. More...
 
virtual std::string getTypeName () const
 Get the type name of this object (i.e. class and template types) More...
 
virtual std::string getClassName () const
 Get the class name of this object. More...
 
virtual std::string getTemplateName () const
 Get the template type names (if any) used to instantiate this object. More...
 
void setDefinitionSourceFileName (const std::string &sourceFileName)
 Set the source filename (where the component is implemented) More...
 
const std::string & getDefinitionSourceFileName () const
 Get the source filename (where the component is implemented) More...
 
void setDefinitionSourceFilePos (const int)
 Set the source location (where the component is implemented) More...
 
int getDefinitionSourceFilePos () const
 Get the source location (where the component is implemented) More...
 
void setInstanciationSourceFileName (const std::string &sourceFileName)
 
const std::string & getInstanciationSourceFileName () const
 
void setInstanciationSourceFilePos (const int)
 
int getInstanciationSourceFilePos () const
 
const std::string getWarnings () const
 
const std::string getOutputs () const
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearWarnings ()
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearOutputs ()
 use clearLoggedMessages() instead More...
 
void processStream (std::ostream &out)
 use clearLoggedMessages() instead More...
 
void addMessage (const sofa::helper::logging::Message &m) const
 
size_t countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
const std::deque< sofa::helper::logging::Message > & getLoggedMessages () const
 
const std::string getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
void clearLoggedMessages () const
 
bool notMuted () const
 
const sofa::core::objectmodel::TagSetgetTags () const
 Represents the subsets the object belongs to. More...
 
bool hasTag (Tag t) const
 Return true if the object belong to the given subset. More...
 
void addTag (Tag t)
 Add a subset qualification to the object. More...
 
void removeTag (Tag t)
 Remove a subset qualification to the object. More...
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
virtual bool parseField (const std::string &attribute, const std::string &value)
 Assign one field value (Data or Link) More...
 
virtual bool hasField (const std::string &attribute) const
 Check if a given Data field or Link exists. More...
 
void parseFields (const std::list< std::string > &str)
 Assign the field values stored in the given list of name + value pairs of strings. More...
 
virtual void parseFields (const std::map< std::string, std::string * > &str)
 Assign the field values stored in the given map of name -> value pairs. More...
 
void writeDatas (std::map< std::string, std::string * > &str)
 Write the current field values to the given map of name -> value pairs. More...
 
void writeDatas (std::ostream &out, const std::string &separator=" ")
 
BaseDatafindData (const std::string &name) const
 
std::vector< BaseData * > findGlobalField (const std::string &name) const
 Find data fields given a name: several can be found as we look into the alias map. More...
 
BaseLinkfindLink (const std::string &name) const
 
std::vector< BaseLink * > findLinks (const std::string &name) const
 Find link fields given a name: several can be found as we look into the alias map. More...
 
virtual void updateLinks (bool logErrors=true)
 Update pointers in case the pointed-to objects have appeared. More...
 
template<class T >
BaseData::BaseInitData initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
template<class T >
Data< T >::InitData initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
void addData (BaseData *f, const std::string &name)
 
void addData (BaseData *f)
 
void removeData (BaseData *f)
 Remove a data field. More...
 
void addAlias (BaseData *field, const char *alias)
 Add an alias to a Data. More...
 
void addLink (BaseLink *l)
 Add a link. More...
 
void removeLink (BaseLink *l)
 Remove a link. More...
 
void addAlias (BaseLink *link, const char *alias)
 Add an alias to a Link. More...
 
const VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
virtual bool findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
 
template<class T >
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 

Protected Member Functions

 SubsetTopologicalMapping ()
 
 ~SubsetTopologicalMapping () override
 
- Protected Member Functions inherited from sofa::core::topology::TopologicalMapping
 TopologicalMapping ()
 
 ~TopologicalMapping () override
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
virtual void doUpdateInternal ()
 Implementation of the internal update. More...
 
void changeContextLink (BaseContext *before, BaseContext *&after)
 
void changeSlavesLink (BaseObject::SPtr ptr, unsigned int, 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

- Protected Attributes inherited from sofa::core::topology::TopologicalMapping
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::helper::vector< unsigned int > > Loc2GlobDataVec
 
std::map< unsigned int, unsigned intGlob2LocMap
 
std::map< unsigned int, sofa::helper::vector< unsigned int > > In2OutMap
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
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...
 
- Static Public Member Functions inherited from sofa::core::topology::TopologicalMapping
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 MyClassGetClass ()
 
template<class T >
static void dynamicCast (T *&ptr, Base *b)
 
template<class T >
static std::string typeName (const T *ptr=nullptr)
 
template<class T >
static std::string className (const T *ptr=nullptr)
 
template<class T >
static std::string namespaceName (const T *ptr=nullptr)
 
template<class T >
static std::string templateName (const T *ptr=nullptr)
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::edgeD2S

Internal destination -> source topology edges map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::edgeS2D

Internal source -> destination topology edges map.

Data<bool> sofa::component::topology::SubsetTopologicalMapping::handleEdges

True if edges events and mapping should be handled.

Data<bool> sofa::component::topology::SubsetTopologicalMapping::handleHexahedra

True if hexahedra events and mapping should be handled.

Data<bool> sofa::component::topology::SubsetTopologicalMapping::handleQuads

True if quads events and mapping should be handled.

Data<bool> sofa::component::topology::SubsetTopologicalMapping::handleTetrahedra

True if tetrahedra events and mapping should be handled.

Data<bool> sofa::component::topology::SubsetTopologicalMapping::handleTriangles

True if triangles events and mapping should be handled.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::hexahedronD2S

Internal destination -> source topology hexahedra map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::hexahedronS2D

Internal source -> destination topology hexahedra map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::pointD2S

Internal destination -> source topology points map (link to SubsetMapping::indices to handle the mechanical-side of the mapping.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::pointS2D

Internal source -> destination topology points map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::quadD2S

Internal destination -> source topology quads map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::quadS2D

Internal source -> destination topology quads map.

Data<bool> sofa::component::topology::SubsetTopologicalMapping::samePoints

True if the same set of points is used in both topologies.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::tetrahedronD2S

Internal destination -> source topology tetrahedra map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::tetrahedronS2D

Internal source -> destination topology tetrahedra map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::triangleD2S

Internal destination -> source topology triangles map.

Data<SetIndex> sofa::component::topology::SubsetTopologicalMapping::triangleS2D

Internal source -> destination topology triangles map.

Constructor details

sofa::component::topology::SubsetTopologicalMapping::SubsetTopologicalMapping ( )
protected
sofa::component::topology::SubsetTopologicalMapping::~SubsetTopologicalMapping ( )
overrideprotected

Function details

unsigned int sofa::component::topology::SubsetTopologicalMapping::getFromIndex ( unsigned int  ind)
overridevirtual
unsigned int sofa::component::topology::SubsetTopologicalMapping::getGlobIndex ( unsigned int  ind)
overridevirtual
void sofa::component::topology::SubsetTopologicalMapping::init ( void  )
overridevirtual

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

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

bool sofa::component::topology::SubsetTopologicalMapping::isTheOutputTopologySubdividingTheInputOne ( )
inlineoverridevirtual

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

Reimplemented from sofa::core::topology::TopologicalMapping.

sofa::component::topology::SubsetTopologicalMapping::SOFA_CLASS ( SubsetTopologicalMapping  ,
sofa::core::topology::TopologicalMapping   
)
void sofa::component::topology::SubsetTopologicalMapping::updateTopologicalMappingTopDown ( )
overridevirtual

Translates the TopologyChange objects from the source to the target.

Translates each of the TopologyChange objects waiting in the source list so that they have a meaning and reflect the effects of the first topology changes on the second topology.

Implements sofa::core::topology::TopologicalMapping.