base class for all interface classes More...

#include <src/interfaces/UnknownInterface.hpp>

Inheritance diagram for MoFEM::UnknownInterface:

Collaboration diagram for MoFEM::UnknownInterface:

Classes
struct	NotKnownClass

struct	UIdTypeMap

Public Member Functions
virtual MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const =0

template<class IFACE >
MoFEMErrorCode	registerInterface (bool error_if_registration_failed=true)
	Register 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 ()=default

Static Public Member Functions
static MoFEMErrorCode	getLibVersion (Version &version)
	Get library version. More...

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

static MoFEMErrorCode	setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
	Get database major version. More...

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

Private Types
typedef multi_index_container< UIdTypeMap, indexed_by< 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 implementation to interface type name. More...

Detailed Description

base class for all interface classes

Examples: EshelbianPlasticity.cpp, and forces_and_sources_testing_users_base.cpp.

Definition at line 34 of file UnknownInterface.hpp.

Member Typedef Documentation

◆ iFaceTypeMap_multiIndex

typedef multi_index_container< UIdTypeMap, indexed_by< 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 294 of file UnknownInterface.hpp.

Constructor & Destructor Documentation

◆ ~UnknownInterface()

virtual MoFEM::UnknownInterface::~UnknownInterface ( )

virtualdefault

Member Function Documentation

◆ getFileVersion()

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

static

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

Examples: mortar_contact_thermal.cpp, and simple_contact_thermal.cpp.

Definition at line 16 of file UnknownInterface.cpp.

                                                                   {
   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/5]

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

IFACE MoFEM::UnknownInterface::getInterface ( ) const

inline

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*>();

Returns: IFACE*

Definition at line 159 of file UnknownInterface.hpp.

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

◆ getInterface() [2/5]

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

IFACE MoFEM::UnknownInterface::getInterface ( ) const

inline

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&>();

Returns: IFACE&

Definition at line 192 of file UnknownInterface.hpp.

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

◆ getInterface() [3/5]

template<class IFACE >

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

inline

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

Returns: IFACE*

Definition at line 223 of file UnknownInterface.hpp.

                                                             {
     IFACE *iface = NULL;
     ierr = getInterface<IFACE>(iface);
     CHKERRABORT(PETSC_COMM_SELF, ierr);
     return iface;
   }

◆ getInterface() [4/5]

template<class IFACE >

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

inline

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

Examples: add_blockset.cpp, add_cubit_meshsets.cpp, adolc_plasticity.cpp, ADOLCPlasticityMaterialModels.hpp, analytical_nonlinear_poisson.cpp, analytical_poisson.cpp, analytical_poisson_field_split.cpp, approx_sphere.cpp, bernstein_bezier_generate_base.cpp, bone_adaptation.cpp, boundary_marker.cpp, build_large_problem.cpp, build_problems.cpp, child_and_parent.cpp, continuity_check_on_contact_prism_side_ele.cpp, continuity_check_on_skeleton_3d.cpp, continuity_check_on_skeleton_with_simple_2d_for_h1.cpp, continuity_check_on_skeleton_with_simple_2d_for_hcurl.cpp, continuity_check_on_skeleton_with_simple_2d_for_hdiv.cpp, cubit_bc_test.cpp, dg_projection.cpp, dm_build_partitioned_mesh.cpp, dm_create_subdm.cpp, dm_partitioned_no_field.cpp, dynamic_first_order_con_law.cpp, eigen_elastic.cpp, elasticity.cpp, elasticity_mixed_formulation.cpp, ep.cpp, EshelbianPlasticity.cpp, field_blas.cpp, field_evaluator.cpp, field_to_vertices.cpp, forces_and_sources_testing_edge_element.cpp, forces_and_sources_testing_flat_prism_element.cpp, forces_and_sources_testing_users_base.cpp, free_surface.cpp, hanging_node_approx.cpp, hcurl_check_approx_in_2d.cpp, hcurl_curl_operator.cpp, hcurl_divergence_operator_2d.cpp, hdiv_divergence_operator.cpp, heat_equation.cpp, heat_method.cpp, hello_world.cpp, helmholtz.cpp, higher_derivatives.cpp, level_set.cpp, loop_entities.cpp, lorentz_force.cpp, MagneticElement.hpp, mesh_cut.cpp, mesh_insert_interface_atom.cpp, mesh_smoothing.cpp, meshset_to_vtk.cpp, minimal_surface_area.cpp, mixed_poisson.cpp, mortar_contact.cpp, mortar_contact_thermal.cpp, node_merge.cpp, nonlinear_dynamics.cpp, nonlinear_elastic.cpp, NonlinearElasticElementInterface.hpp, operators_tests.cpp, partition_mesh.cpp, phase.cpp, photon_diffusion.cpp, plastic.cpp, PlasticOps.hpp, plot_base.cpp, poisson_2d_dis_galerkin.cpp, poisson_2d_homogeneous.cpp, prism_elements_from_surface.cpp, prism_polynomial_approximation.cpp, quad_polynomial_approximation.cpp, reaction_diffusion.cpp, remove_entities_from_problem.cpp, remove_entities_from_problem_not_partitioned.cpp, scalar_check_approximation.cpp, seepage.cpp, shallow_wave.cpp, simple_contact.cpp, simple_contact_thermal.cpp, simple_elasticity.cpp, simple_interface.cpp, simple_l2_only.cpp, split_sideset.cpp, tensor_divergence_operator.cpp, test_cache_on_entities.cpp, test_jacobian_of_simple_contact_element.cpp, testing_jacobian_of_hook_element.cpp, testing_jacobian_of_hook_scaled_with_density_element.cpp, thermo_elastic.cpp, ThermoElasticOps.hpp, unsaturated_transport.cpp, UnsaturatedFlow.hpp, and wave_equation.cpp.

Definition at line 93 of file UnknownInterface.hpp.

                                                           {
     MoFEMFunctionBegin;
     UnknownInterface *ptr;
     CHKERR query_interface(boost::typeindex::type_id<IFACE>(), &ptr);
     if (!(iface = static_cast<IFACE *>(ptr)))
       SETERRQ(PETSC_COMM_SELF, MOFEM_IMPOSSIBLE_CASE, "Cast Impossible");
     MoFEMFunctionReturn(0);
   }

◆ getInterface() [5/5]

template<class IFACE >

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

inline

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 130 of file UnknownInterface.hpp.

                                                                 {
     return getInterface<IFACE>(*iface);
   }

◆ getInterfaceVersion()

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

static

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 59 of file UnknownInterface.cpp.

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

◆ getLibVersion()

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

static

Get library version.

This is library version.

Returns: error code

Definition at line 9 of file UnknownInterface.cpp.

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

◆ query_interface()

virtual MoFEMErrorCode MoFEM::UnknownInterface::query_interface	(	boost::typeindex::type_index	type_index,
		UnknownInterface **	iface
	)		const

pure virtual

Implemented in MoFEM::BaseFunctionUnknownInterface, MoFEM::DMCtx, MoFEM::DofMethod, MoFEM::EntityMethod, MoFEM::FEMethod, MoFEM::CoreTmp< 0 >, MoFEM::BasicMethod, MoFEM::TSMethod, MoFEM::MeshsetsManager, MoFEM::SnesMethod, MoFEM::IntegratedJacobiPolynomial, MoFEM::KernelLobattoPolynomial, MoFEM::KspMethod, MoFEM::IntegratedJacobiPolynomialCtx, MoFEM::FatPrismPolynomialBase, MoFEM::JacobiPolynomial, MoFEM::KernelLobattoPolynomialCtx, MoFEM::LogManager, MoFEM::LegendrePolynomial, MoFEM::FlatPrismPolynomialBase, SomeUserPolynomialBase, MoFEM::LobattoPolynomial, MoFEM::BaseFunctionCtx, MoFEM::Simple, MoFEM::MeshRefinement, MoFEM::BcManager, MoFEM::SeriesRecorder, MoFEM::PipelineManager, MoFEM::FatPrismPolynomialBaseCtx, MoFEM::ISManager, MoFEM::MedInterface, MoFEM::PrismInterface, MoFEM::TetGenInterface, MoFEM::VecManager, MoFEM::EntPolynomialBaseCtx, MoFEM::FlatPrismPolynomialBaseCtx, MoFEM::QuadPolynomialBase, MoFEM::BitRefManager, MoFEM::CommInterface, MoFEM::FieldBlas, MoFEM::FieldEvaluatorInterface, MoFEM::MatrixManager, MoFEM::OperatorsTester, MoFEM::ProblemsManager, MoFEM::EdgePolynomialBase, MoFEM::HexPolynomialBase, MoFEM::TetPolynomialBase, MoFEM::CutMeshInterface, MoFEM::Tools, MoFEM::NodeMergerInterface, MoFEM::JacobiPolynomialCtx, MoFEM::LegendrePolynomialCtx, MoFEM::LobattoPolynomialCtx, MoFEM::TriPolynomialBase, MoFEM::PrismsFromSurfaceInterface, MoFEM::PetscData, MoFEM::BaseFunction, FractureMechanics::CPSolvers, FractureMechanics::CPMeshCut, and DMMGViaApproxOrdersCtx.

Examples: cell_forces.cpp.

◆ registerInterface()

template<class IFACE >

MoFEMErrorCode MoFEM::UnknownInterface::registerInterface ( bool error_if_registration_failed = true )

inline

Register interface.

Example:

ierr = regSubInterface<Simple>(IDD_MOFEMSimple);

CHKERRABORT(PETSC_COMM_SELF, ierr);

Parameters

uuid
true

Returns: MoFEMErrorCode

Definition at line 54 of file UnknownInterface.hpp.

                                                                              {
     MoFEMFunctionBeginHot;
     auto p =
         iFaceTypeMap.insert(UIdTypeMap(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);
   }

◆ setFileVersion()

MoFEMErrorCode MoFEM::UnknownInterface::setFileVersion	(	moab::Interface &	moab,
		Version	version = `Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD)`
	)

static

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 41 of file UnknownInterface.cpp.

                                                                  {
   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;
   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] = version.majorVersion;
   version_ptr[1] = version.minorVersion;
   version_ptr[2] = version.buildVersion;
   MoFEMFunctionReturn(0);
 }

Member Data Documentation

◆ iFaceTypeMap

iFaceTypeMap_multiIndex MoFEM::UnknownInterface::iFaceTypeMap

mutableprivate

Maps implementation to interface type name.

Definition at line 297 of file UnknownInterface.hpp.

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

src/interfaces/UnknownInterface.hpp
src/interfaces/impl/UnknownInterface.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ iFaceTypeMap_multiIndex

Constructor & Destructor Documentation

◆ ~UnknownInterface()

Member Function Documentation

◆ getFileVersion()

◆ getInterface() [1/5]

◆ getInterface() [2/5]

◆ getInterface() [3/5]

◆ getInterface() [4/5]

◆ getInterface() [5/5]

◆ getInterfaceVersion()

◆ getLibVersion()

◆ query_interface()

◆ registerInterface()

◆ setFileVersion()

Member Data Documentation

◆ iFaceTypeMap