base class for all interface classes More...

#include <src/interfaces/UnknownInterface.hpp>

Inheritance diagram for MoFEM::UnknownInterface:

Classes
struct	HashMOFEMuuid

struct	NotKnownClass

struct	UIdTypeMap

Public Member Functions
virtual MoFEMErrorCode	query_interface (const MOFEMuuid &uuid, UnknownInterface **iface) const =0

template<class IFACE >
MoFEMErrorCode	registerInterface (const MOFEMuuid &uuid, bool error_if_registration_failed=true)
	Register interface. More...

template<class IFACE , bool VERIFY = false>
MoFEMErrorCode	getInterface (const MOFEMuuid &uuid, IFACE *&iface) const
	Get interface by uuid and return reference to pointer of interface. More...

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface refernce to pointer of interface. More...

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE **const iface) const
	Get interface pointer to pointer of interface. More...

template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get interface pointer to pointer of interface. More...

template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get reference to interface. More...

template<class IFACE >
IFACE *	getInterface () const
	Function returning pointer to interface. More...

virtual	~UnknownInterface ()

virtual MoFEMErrorCode	getLibVersion (Version &version) const
	Get library version. More...

virtual const MoFEMErrorCode	getFileVersion (moab::Interface &moab, Version &version) const
	Get database major version. More...

virtual MoFEMErrorCode	getInterfaceVersion (Version &version) const
	Get database major version. More...

template<>
MoFEMErrorCode	getInterface (const MOFEMuuid &uuid, UnknownInterface *&iface) const

Protected Member Functions
boost::typeindex::type_index	getClassIdx (const MOFEMuuid &uid) const
	Get type name for interface Id. More...

MOFEMuuid	getUId (const boost::typeindex::type_index &class_idx) const
	Get interface Id for class name. More...

Private Types
typedef multi_index_container< UIdTypeMap, indexed_by< hashed_unique< member< UIdTypeMap, MOFEMuuid, &UIdTypeMap::uID >, HashMOFEMuuid >, hashed_unique< member< UIdTypeMap, boost::typeindex::type_index, &UIdTypeMap::classIdx > > > >	iFaceTypeMap_multiIndex
	Data structure for interfaces Id and class names. More...

Private Attributes
iFaceTypeMap_multiIndex	iFaceTypeMap
	Maps MOFEMuuid to interface type name. More...

Detailed Description

base class for all interface classes

Definition at line 75 of file UnknownInterface.hpp.

Member Typedef Documentation

◆ iFaceTypeMap_multiIndex

typedef multi_index_container< UIdTypeMap, indexed_by< hashed_unique< member<UIdTypeMap, MOFEMuuid, &UIdTypeMap::uID>, HashMOFEMuuid >, hashed_unique< member<UIdTypeMap, boost::typeindex::type_index, &UIdTypeMap::classIdx> > > > MoFEM::UnknownInterface::iFaceTypeMap_multiIndex

private

Data structure for interfaces Id and class names.

Definition at line 423 of file UnknownInterface.hpp.

Constructor & Destructor Documentation

◆ ~UnknownInterface()

virtual MoFEM::UnknownInterface::~UnknownInterface ( )

virtual

Definition at line 300 of file UnknownInterface.hpp.

300 {}

Member Function Documentation

◆ getClassIdx()

boost::typeindex::type_index MoFEM::UnknownInterface::getClassIdx ( const MOFEMuuid & uid ) const

protected

Get type name for interface Id.

Parameters

uid	interface Id

Returns: class name

Definition at line 373 of file UnknownInterface.hpp.

                                                                           {
     iFaceTypeMap_multiIndex::nth_index<0>::type::iterator it;
     it = iFaceTypeMap.get<0>().find(uid);
     if (it != iFaceTypeMap.get<0>().end()) {
       return it->classIdx;
     }
     return boost::typeindex::type_id<NotKnownClass>();
   }

◆ getFileVersion()

virtual const MoFEMErrorCode MoFEM::UnknownInterface::getFileVersion	(	moab::Interface &	moab,
		Version &	version
	)		const

virtual

Get database major version.

This is database version. MoFEM can read DataBase from file created by older version. Then library version and database version could be different.

Returns: error code

Definition at line 324 of file UnknownInterface.hpp.

                                                                       {
     MoFEMFunctionBegin;
     const EntityHandle root_meshset = 0;
     const int def_version[] = {-1, -1, -1};
     Tag th;
     rval = moab.tag_get_handle("MOFEM_VERSION", 3, MB_TYPE_INTEGER, th,
                                MB_TAG_CREAT | MB_TAG_MESH, &def_version);
     int *version_ptr;
     if (rval == MB_ALREADY_ALLOCATED) {
       const void *tag_data[1];
       CHKERR moab.tag_get_by_ptr(th, &root_meshset, 1, tag_data);
       version_ptr = (int *)tag_data[0];
     } else {
       const void *tag_data[1];
       CHKERR moab.tag_get_by_ptr(th, &root_meshset, 1, tag_data);
       version_ptr = (int *)tag_data[0];
       version_ptr[0] = MoFEM_VERSION_MAJOR;
       version_ptr[1] = MoFEM_VERSION_MINOR;
       version_ptr[2] = MoFEM_VERSION_BUILD;
     }
     version = Version(version_ptr);
     MoFEMFunctionReturn(0);
   }

◆ getInterface() [1/7]

template<class IFACE , bool VERIFY = false>

MoFEMErrorCode MoFEM::UnknownInterface::getInterface	(	const MOFEMuuid &	uuid,
		IFACE *&	iface
	)		const

Get interface by uuid and return reference to pointer of interface.

Note: uuid of interface and interface are verified, if second template parameter is true. Function throw error if both do not match.; Do not use this function directly, it is called by other overload getInterface methods.

Parameters

uuid
iface	reference to a interface pointer

Returns: MoFEMErrorCode

Examples:: analytical_nonlinear_poisson.cpp, analytical_poisson.cpp, analytical_poisson_field_split.cpp, cubit_bc_test.cpp, elasticity.cpp, field_to_vertices.cpp, forces_and_sources_testing_edge_element.cpp, hello_world.cpp, MagneticElement.hpp, mesh_cut.cpp, mesh_smoothing.cpp, minimal_surface_area.cpp, simple_elasticity.cpp, simple_interface.cpp, split_sideset.cpp, and unsaturated_transport.cpp.

Definition at line 122 of file UnknownInterface.hpp.

                                                           {
     MoFEMFunctionBeginHot;
     iface = NULL;
     if (VERIFY) {
       if (boost::typeindex::type_id<IFACE>()!=getClassIdx(uuid)) {
         SETERRQ(PETSC_COMM_SELF, MOFEM_INVALID_DATA,
                  "Inconsistency between interface Id and type");
       }
     }
     UnknownInterface *ptr;
     ierr = getInterface<UnknownInterface, false>(uuid, ptr);
     CHKERRG(ierr);
     iface = static_cast<IFACE *>(ptr);
     MoFEMFunctionReturnHot(0);
   }

◆ getInterface() [2/7]

template<class IFACE >

MoFEMErrorCode MoFEM::UnknownInterface::getInterface ( IFACE *& iface ) const

Get interface refernce to pointer of interface.

// Create moab database
moab::Core mb_instance;
// Access moab database by interface
moab::Interface &moab = mb_instance;
// Create MoFEM database
MoFEM::Core core(moab);
// Acces MoFEM database by Interface
MoFEM::Interface &m_field = core;
// Get interface
// Get simple interface is simplified version enabling quick and
// easy construction of problem.
Simple *simple_interface;
// Query interface and get pointer to Simple interface
 CHKERR m_field.getInterface(simple_interface);

Parameters

iface reference to a interface pointer

Returns: MoFEMErrorCode

Definition at line 166 of file UnknownInterface.hpp.

                                                           {
     return getInterface<IFACE, false>(
         getUId(boost::typeindex::type_id<IFACE>()), iface);
   }

◆ getInterface() [3/7]

template<class IFACE >

MoFEMErrorCode MoFEM::UnknownInterface::getInterface ( IFACE **const iface ) const

Get interface pointer to pointer of interface.

// Create moab database
moab::Core mb_instance;
// Access moab database by interface
moab::Interface &moab = mb_instance;
// Create MoFEM database
MoFEM::Core core(moab);
// Acces MoFEM database by Interface
MoFEM::Interface &m_field = core;
// Get interface
// Get simple interface is simplified version enabling quick and
// easy construction of problem.
Simple *simple_interface;
// Query interface and get pointer to Simple interface
 CHKERR m_field.getInterface(&simple_interface);

Parameters

iface const pointer to a interface pointer

Returns: MoFEMErrorCode

Definition at line 199 of file UnknownInterface.hpp.

                                                                 {
     return getInterface<IFACE, false>(boost::typeindex::type_id<IFACE>(),
                                       *iface);
   }

◆ getInterface() [4/7]

template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>

IFACE MoFEM::UnknownInterface::getInterface ( ) const

Get interface pointer to pointer of interface.

// Create moab database
moab::Core mb_instance;
// Access moab database by interface
moab::Interface &moab = mb_instance;
// Create MoFEM database
MoFEM::Core core(moab);
// Acces MoFEM database by Interface
MoFEM::Interface &m_field = core;
// Get interface
// Get simple interface is simplified version enabling quick and
// easy construction of problem.
Simple *simple_interface = m_field.getInterface<Simple*,0>();

Returns: IFACE*

Definition at line 229 of file UnknownInterface.hpp.

                                     {
     typedef typename boost::remove_pointer<IFACE>::type IFaceType;
     IFaceType* iface = NULL;
     ierr = getInterface<IFaceType, false>(
         getUId(boost::typeindex::type_id<IFaceType>()), iface);
     CHKERRABORT(PETSC_COMM_SELF, ierr);
     return iface;
   }

◆ getInterface() [5/7]

template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>

IFACE MoFEM::UnknownInterface::getInterface ( ) const

Get reference to interface.

// Create moab database
moab::Core mb_instance;
// Access moab database by interface
moab::Interface &moab = mb_instance;
// Create MoFEM database
MoFEM::Core core(moab);
// Acces MoFEM database by Interface
MoFEM::Interface &m_field = core;
// Get interface
// Get simple interface is simplified version enabling quick and
// easy construction of problem.
Simple &simple_interface = m_field.getInterface<Simple&,0>();

Returns: IFACE&

Definition at line 263 of file UnknownInterface.hpp.

                                     {
     typedef typename boost::remove_reference<IFACE>::type IFaceType;
     IFaceType* iface = NULL;
     ierr = getInterface<IFaceType, false>(
         getUId(boost::typeindex::type_id<IFaceType>()), iface);
     CHKERRABORT(PETSC_COMM_SELF, ierr);
     return *iface;
   }

◆ getInterface() [6/7]

template<class IFACE >

IFACE* MoFEM::UnknownInterface::getInterface ( ) const

Function returning pointer to interface.

// Create moab database
moab::Core mb_instance;
// Access moab database by interface
moab::Interface &moab = mb_instance;
// Create MoFEM database
MoFEM::Core core(moab);
// Acces MoFEM database by Interface
MoFEM::Interface &m_field = core;
// Get interface
// Get simple interface is simplified version enabling quick and
// easy construction of problem.
Simple *simple_interface = m_field.getInterface<Simple,0>();

Returns: IFACE*

Definition at line 296 of file UnknownInterface.hpp.

                                      {
     return getInterface<IFACE*,0>();
   }

◆ getInterface() [7/7]

template<>

MoFEMErrorCode MoFEM::UnknownInterface::getInterface	(	const MOFEMuuid &	uuid,
		UnknownInterface *&	iface
	)		const

Definition at line 430 of file UnknownInterface.hpp.

                                                            {
   return query_interface(uuid, &iface);
 }

◆ getInterfaceVersion()

virtual MoFEMErrorCode MoFEM::UnknownInterface::getInterfaceVersion ( Version & version ) const

virtual

Get database major version.

Implementation of particular interface could be different than main lib. For example user could use older interface, to keep back compatibility.

Returns: error code

Definition at line 357 of file UnknownInterface.hpp.

                                                                      {
     MoFEMFunctionBeginHot;
     version =
         Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD);
     MoFEMFunctionReturnHot(0);
   }

◆ getLibVersion()

virtual MoFEMErrorCode MoFEM::UnknownInterface::getLibVersion ( Version & version ) const

virtual

Get library version.

This is library version.

Returns: error code

Definition at line 309 of file UnknownInterface.hpp.

                                                                {
     MoFEMFunctionBeginHot;
     version =
         Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD);
     MoFEMFunctionReturnHot(0);
   }

◆ getUId()

MOFEMuuid MoFEM::UnknownInterface::getUId ( const boost::typeindex::type_index & class_idx ) const

protected

Get interface Id for class name.

Parameters

class_name

Returns: Id

Definition at line 387 of file UnknownInterface.hpp.

                                                                            {
     iFaceTypeMap_multiIndex::nth_index<1>::type::iterator it;
     it = iFaceTypeMap.get<1>().find(class_idx);
     if (it != iFaceTypeMap.get<1>().end()) {
       return it->uID;
     }
     return IDD_MOFEMUnknown;
   }

◆ query_interface()

virtual MoFEMErrorCode MoFEM::UnknownInterface::query_interface	(	const MOFEMuuid &	uuid,
		UnknownInterface **	iface
	)		const

pure virtual

Implemented in MoFEM::DMCtx, MoFEM::DofMethod, MoFEM::EntityMethod, MoFEM::FEMethod, MoFEM::BasicMethod, MoFEM::TSMethod, MoFEM::Core, MoFEM::MeshsetsManager, MoFEM::SnesMethod, MoFEM::IntegratedJacobiPolynomial, MoFEM::KernelLobattoPolynomial, MoFEM::IntegratedJacobiPolynomialCtx, MoFEM::KernelLobattoPolynomialCtx, MoFEM::FatPrismPolynomialBase, MoFEM::LegendrePolynomial, MoFEM::JacobiPolynomial, MoFEM::FlatPrismPolynomialBase, MoFEM::LobattoPolynomial, MoFEM::BaseFunction, MoFEM::KspMethod, MoFEM::MeshRefinement, MoFEM::EntPolynomialBaseCtx, MoFEM::PrismInterface, MoFEM::SeriesRecorder, MoFEM::TetGenInterface, MoFEM::MedInterface, MoFEM::VecManager, MoFEM::BitRefManager, MoFEM::FieldBlas, MoFEM::ProblemsManager, MoFEM::EdgePolynomialBase, MoFEM::FatPrismPolynomialBaseCtx, MoFEM::FlatPrismPolynomialBaseCtx, MoFEM::TriPolynomialBase, MoFEM::ISManager, MoFEM::Simple, MoFEM::BaseFunctionCtx, MoFEM::JacobiPolynomialCtx, MoFEM::LobattoPolynomialCtx, MoFEM::BitLevelCoupler, MoFEM::CutMeshInterface, MoFEM::LegendrePolynomialCtx, MoFEM::TetPolynomialBase, MoFEM::CoordSystemsManager, MoFEM::Tools, MoFEM::NodeMergerInterface, and MoFEM::PrismsFromSurfaceInterface.

◆ registerInterface()

template<class IFACE >

MoFEMErrorCode MoFEM::UnknownInterface::registerInterface	(	const MOFEMuuid &	uuid,
		bool	error_if_registration_failed = `true`
	)

Register interface.

Example:

ierr = regSubInterface<Simple>(IDD_MOFEMSimple);

CHKERRABORT(PETSC_COMM_SELF, ierr);

Parameters

uuid
true

Returns: MoFEMErrorCode

Definition at line 94 of file UnknownInterface.hpp.

                                                                              {
     MoFEMFunctionBeginHot;
     std::pair<iFaceTypeMap_multiIndex::iterator, bool> p;
     p = iFaceTypeMap.insert(
         UIdTypeMap(uuid, boost::typeindex::type_id<IFACE>()));
     if (error_if_registration_failed && (!p.second)) {
       SETERRQ1(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "Registration of interface typeid(IFACE).name() = %s failed",
                typeid(IFACE).name());
     }
     MoFEMFunctionReturnHot(0);
   }

Member Data Documentation

◆ iFaceTypeMap

iFaceTypeMap_multiIndex MoFEM::UnknownInterface::iFaceTypeMap

mutableprivate

Maps MOFEMuuid to interface type name.

Definition at line 426 of file UnknownInterface.hpp.

The documentation for this struct was generated from the following file:

src/interfaces/UnknownInterface.hpp

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ iFaceTypeMap_multiIndex

Constructor & Destructor Documentation

◆ ~UnknownInterface()

Member Function Documentation

◆ getClassIdx()

◆ getFileVersion()

◆ getInterface() [1/7]

◆ getInterface() [2/7]

◆ getInterface() [3/7]

◆ getInterface() [4/7]

◆ getInterface() [5/7]

◆ getInterface() [6/7]

◆ getInterface() [7/7]

◆ getInterfaceVersion()

◆ getLibVersion()

◆ getUId()

◆ query_interface()

◆ registerInterface()

Member Data Documentation

◆ iFaceTypeMap