MoFEM::UnknownInterface Struct Reference

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.
template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface reference to pointer of interface.
template<class IFACE >
MoFEMErrorCode	getInterface (IFACE **const iface) const
	Get interface pointer to pointer of interface.
template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get interface pointer to pointer of interface.
template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get reference to interface.
template<class IFACE >
IFACE *	getInterface () const
	Function returning pointer to interface.
virtual	~UnknownInterface ()=default

Static Public Member Functions
static MoFEMErrorCode	getLibVersion (Version &version)
	Get library version.
static MoFEMErrorCode	getFileVersion (moab::Interface &moab, Version &version)
	Get database major version.
static MoFEMErrorCode	setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
	Get database major version.
static MoFEMErrorCode	getInterfaceVersion (Version &version)
	Get database major version.

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.

Private Attributes
iFaceTypeMap_multiIndex	iFaceTypeMap
	Maps implementation to interface type name.

Detailed Description

base class for all interface classes

Examples

mofem/atom_tests/forces_and_sources_testing_users_base.cpp.

Definition at line 44 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 307 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

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);
// Access 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*

Examples

mofem/tutorials/adv-4_dynamic_first_order_con_law/dynamic_first_order_con_law.cpp.

Definition at line 172 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);
// Access 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 205 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);
// Access 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 236 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 reference 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);
// Access 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

mofem/atom_tests/add_blockset.cpp, mofem/atom_tests/add_cubit_meshsets.cpp, mofem/atom_tests/bernstein_bezier_generate_base.cpp, mofem/atom_tests/boundary_marker.cpp, mofem/atom_tests/build_composite_problem.cpp, mofem/atom_tests/build_large_problem.cpp, mofem/atom_tests/build_problems.cpp, mofem/atom_tests/child_and_parent.cpp, mofem/atom_tests/continuity_check_on_contact_prism_side_ele.cpp, mofem/atom_tests/continuity_check_on_skeleton_3d.cpp, mofem/atom_tests/continuity_check_on_skeleton_with_simple_2d_for_h1.cpp, mofem/atom_tests/continuity_check_on_skeleton_with_simple_2d_for_hcurl.cpp, mofem/atom_tests/continuity_check_on_skeleton_with_simple_2d_for_hdiv.cpp, mofem/atom_tests/cubit_bc_test.cpp, mofem/atom_tests/dg_projection.cpp, mofem/atom_tests/dm_build_partitioned_mesh.cpp, mofem/atom_tests/dm_create_subdm.cpp, mofem/atom_tests/dm_partitioned_no_field.cpp, mofem/atom_tests/field_blas.cpp, mofem/atom_tests/field_blas_axpy.cpp, mofem/atom_tests/field_evaluator.cpp, mofem/atom_tests/forces_and_sources_testing_edge_element.cpp, mofem/atom_tests/forces_and_sources_testing_flat_prism_element.cpp, mofem/atom_tests/forces_and_sources_testing_users_base.cpp, mofem/atom_tests/hanging_node_approx.cpp, mofem/atom_tests/hcurl_check_approx_in_2d.cpp, mofem/atom_tests/hcurl_curl_operator.cpp, mofem/atom_tests/hcurl_divergence_operator_2d.cpp, mofem/atom_tests/hdiv_check_approx_in_3d.cpp, mofem/atom_tests/hdiv_divergence_operator.cpp, mofem/atom_tests/higher_derivatives.cpp, mofem/atom_tests/loop_entities.cpp, mofem/atom_tests/mesh_insert_interface_atom.cpp, mofem/atom_tests/mesh_refine_atom.cpp, mofem/atom_tests/node_merge.cpp, mofem/atom_tests/operators_tests.cpp, mofem/atom_tests/partition_mesh.cpp, mofem/atom_tests/prism_elements_from_surface.cpp, mofem/atom_tests/prism_polynomial_approximation.cpp, mofem/atom_tests/quad_polynomial_approximation.cpp, mofem/atom_tests/remove_entities_from_problem.cpp, mofem/atom_tests/remove_entities_from_problem_not_partitioned.cpp, mofem/atom_tests/scalar_check_approximation.cpp, mofem/atom_tests/schur_test_diag_mat.cpp, mofem/atom_tests/simple_interface.cpp, mofem/atom_tests/simple_l2_only.cpp, mofem/atom_tests/tensor_divergence_operator.cpp, mofem/atom_tests/test_broken_space.cpp, mofem/atom_tests/test_cache_on_entities.cpp, mofem/tools/extrude_prisms.cpp, mofem/tools/field_to_vertices.cpp, mofem/tools/mesh_cut.cpp, mofem/tools/mesh_smoothing.cpp, mofem/tools/meshset_to_vtk.cpp, mofem/tools/split_sideset.cpp, mofem/tutorials/adv-0_plasticity/plastic.cpp, mofem/tutorials/adv-0_plasticity/src/PlasticOps.hpp, mofem/tutorials/adv-0_plasticity/src/PlasticOpsMonitor.hpp, mofem/tutorials/adv-3_level_set/level_set.cpp, mofem/tutorials/adv-4_dynamic_first_order_con_law/dynamic_first_order_con_law.cpp, mofem/tutorials/adv-5_poroelasticity/seepage.cpp, mofem/tutorials/adv-6_dg_projection/between_meshes_dg_projection.cpp, mofem/tutorials/clx-0_acoustics/helmholtz.cpp, mofem/tutorials/cor-0to1_unsaturated_transport/src/UnsaturatedFlow.hpp, mofem/tutorials/cor-0to1_unsaturated_transport/unsaturated_transport.cpp, mofem/tutorials/cor-10_navier_stokes/navier_stokes.cpp, mofem/tutorials/cor-12_cohesive_interface/arc_length_interface.cpp, mofem/tutorials/cor-2to5_analytical_poisson/analytical_nonlinear_poisson.cpp, mofem/tutorials/cor-2to5_analytical_poisson/analytical_poisson.cpp, mofem/tutorials/cor-2to5_analytical_poisson/analytical_poisson_field_split.cpp, mofem/tutorials/cor-6_simple_elasticity/simple_elasticity.cpp, mofem/tutorials/cor-7_elasticity_mixed_formulation/elasticity_mixed_formulation.cpp, mofem/tutorials/cor-9_reaction_diffusion/reaction_diffusion.cpp, mofem/tutorials/fun-0_hello_world/hello_world.cpp, mofem/tutorials/fun-1_integration/integration.cpp, mofem/tutorials/fun-2_plot_base/plot_base.cpp, mofem/tutorials/max-0_magnetostatics/src/MagneticElement.hpp, mofem/tutorials/max-1_lorentz_force//lorentz_force.cpp, mofem/tutorials/mix-0_mixed_poisson/mixed_poisson.cpp, mofem/tutorials/mix-1_light_intensity_equation/phase.cpp, mofem/tutorials/scl-0_least_squares/approximation.cpp, mofem/tutorials/scl-12_electrostatics/electrostatics.cpp, mofem/tutorials/scl-1_poisson_2d_homogeneous/poisson_2d_homogeneous.cpp, mofem/tutorials/scl-6_heat_equation/heat_equation.cpp, mofem/tutorials/scl-7_wave_equation/wave_equation.cpp, mofem/tutorials/scl-8_heat_radiation/radiation.cpp, mofem/tutorials/scl-9_heat_method/heat_method.cpp, mofem/tutorials/vec-10_elasticity_schur/schur_elastic.cpp, mofem/tutorials/vec-11_elastic_tie_mesh/elastic_tie_mesh.cpp, mofem/tutorials/vec-1_eigen_elasticity/eigen_elastic.cpp, mofem/tutorials/vec-2_nonlinear_elasticity/src/HenckyOps.hpp, mofem/tutorials/vec-2_nonlinear_elasticity/src/NonlinearElasticExample.hpp, mofem/tutorials/vec-3_nonlinear_dynamics/nonlinear_dynamic_elastic.cpp, mofem/tutorials/vec-4_shallow_wave/approx_sphere.cpp, mofem/tutorials/vec-4_shallow_wave/shallow_wave.cpp, mofem/tutorials/vec-5_free_surface/free_surface.cpp, mofem/tutorials/vec-6_dg_kirchhoff_plate/plate.cpp, mofem/tutorials/vec-7_shape_optimisation/adjoint.cpp, mofem/tutorials/vec-9_arc_length/src/ArcLengthExample.hpp, mofem/users_modules/adolc-plasticity/adolc_plasticity.cpp, mofem/users_modules/adolc-plasticity/src/ADOLCPlasticityMaterialModels.hpp, mofem/users_modules/basic_finite_elements/atom_tests/testing_jacobian_of_hook_element.cpp, mofem/users_modules/basic_finite_elements/atom_tests/testing_jacobian_of_hook_scaled_with_density_element.cpp, mofem/users_modules/basic_finite_elements/elasticity/elasticity.cpp, mofem/users_modules/basic_finite_elements/nonlinear_elastic_materials/src/NonlinearElasticElementInterface.hpp, mofem/users_modules/basic_finite_elements/nonlinear_elasticity/nonlinear_dynamics.cpp, mofem/users_modules/bone_remodelling/bone_adaptation.cpp, mofem/users_modules/bone_remodelling/src/impl/Remodeling.cpp, and mofem/users_modules/minimal_surface_equation/minimal_surface_area.cpp.

Definition at line 103 of file UnknownInterface.hpp.

                                                          {
    MoFEMFunctionBegin;
    UnknownInterface *ptr;
    CHKERR query_interface(boost::typeindex::type_id<IFACE>(), &ptr);
    if (!(iface = dynamic_cast<IFACE *>(ptr)))
      SETERRQ(PETSC_COMM_SELF, MOFEM_IMPOSSIBLE_CASE,
               "Cast impossible %s -> %s",
               (boost::typeindex::type_id_runtime(*ptr).pretty_name()).c_str(),
               (boost::typeindex::type_id<IFACE>().pretty_name()).c_str());
    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);
// Access 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 143 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::BaseFunction, MoFEM::DMMGViaApproxOrdersCtx, SomeUserPolynomialBase, MoFEM::BaseFunctionCtx, MoFEM::EdgePolynomialBase, MoFEM::EntPolynomialBaseCtx, MoFEM::FatPrismPolynomialBaseCtx, MoFEM::FatPrismPolynomialBase, MoFEM::FlatPrismPolynomialBaseCtx, MoFEM::FlatPrismPolynomialBase, MoFEM::HexPolynomialBase, MoFEM::JacobiPolynomialCtx, MoFEM::JacobiPolynomial, MoFEM::IntegratedJacobiPolynomialCtx, MoFEM::IntegratedJacobiPolynomial, MoFEM::LegendrePolynomialCtx, MoFEM::LegendrePolynomial, MoFEM::LobattoPolynomialCtx, MoFEM::LobattoPolynomial, MoFEM::KernelLobattoPolynomialCtx, MoFEM::KernelLobattoPolynomial, MoFEM::QuadPolynomialBase, MoFEM::TetPolynomialBase, MoFEM::TriPolynomialBase, MoFEM::BcManager, MoFEM::BitRefManager, MoFEM::CommInterface, MoFEM::CoreTmp< 0 >, MoFEM::CutMeshInterface, MoFEM::FieldBlas, MoFEM::FieldEvaluatorInterface, MoFEM::ISManager, MoFEM::JsonConfigManager, MoFEM::LogManager, MoFEM::PetscData, MoFEM::KspMethod, MoFEM::SnesMethod, MoFEM::TSMethod, MoFEM::TaoMethod, MoFEM::MatrixManager, MoFEM::MedInterface, MoFEM::MeshRefinement, MoFEM::MeshsetsManager, MoFEM::NodeMergerInterface, MoFEM::OperatorsTester, MoFEM::PipelineGraph, MoFEM::PipelineManager, MoFEM::PrismInterface, MoFEM::PrismsFromSurfaceInterface, MoFEM::ProblemsManager, MoFEM::SeriesRecorder, MoFEM::Simple, MoFEM::TetGenInterface, MoFEM::Tools, MoFEM::VecManager, MoFEM::DMCtx, MoFEM::BaseFunctionUnknownInterface, MoFEM::BasicMethod, MoFEM::FEMethod, MoFEM::EntityMethod, and MoFEM::DofMethod.

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

                                                                             {
    MoFEMFunctionBeginHot;
    auto p =
        iFaceTypeMap.insert(UIdTypeMap(boost::typeindex::type_id<IFACE>()));
    if (error_if_registration_failed && (!p.second)) {
      SETERRQ(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 310 of file UnknownInterface.hpp.

---

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

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