definitions.h

Go to the documentation of this file.

/** \file definitions.h
 * \brief useful compiler directives and definitions
 */

/* MoFEM is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * MoFEM is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with MoFEM. If not, see <http://www.gnu.org/licenses/>
*/

#ifndef __DEFINITONS_H__
#define __DEFINITONS_H__

//taken from http://stackoverflow.com/questions/295120/c-mark-as-deprecated
#ifdef __GNUC__
  #define DEPRECATED __attribute__((deprecated))
#elif defined(_MSC_VER)
  #define DEPRECATED __declspec(deprecated)
#else
  #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
  #define DEPRECATED
#endif


/** \brief Interfaces IDs
  *
  * To manage different complexities related to field, finite elements mesh
  * refinements, etc. a appropriate interfaces related to each complexities are
  * created. Interfaces by itself could vary by functionality or the same function
  * can me managed with two interfaces with waring level of abstraction.
  *
  */
enum Interfaces {
  UNKNOWNINTERFACE              = 1<<0,
  //Field Interface
  CORE_INTERFACE                = 1<<0|1<<1,
  PROBLEMSMANAGER_INTERFACE     = 1<<0|1<<2,
  SIMPLE_INTERFACE              = 1<<0|1<<3,
  MESH_REFINE                   = 1<<1|1<<2,
  PRISM_INTEFACE                = 1<<1|1<<3,
  SERIES_RECORDER               = 1<<1|1<<4,
  ISMANAGER_INTERFACE           = 1<<1|1<<5,
  VECMANAGER_INTERFACE          = 1<<1|1<<6,
  FIELDBLAS_INTERFACE           = 1<<1|1<<7,
  BITREFMANAGER_INTERFACE       = 1<<1|1<<8,
  //Independent Interfaces
  TETGEN_INTERFACE              = 1<<3|1<<4,    ///< used to generate mesh using TetGen
  MED_INTERFACE                 = 1<<3|1<<5,      ///< interface to med data format
  NODEMERGER_INTERFACE          = 1<<3|1<<6,      ///< used to merge nodes
  BITLEVELCOUPLER_INTERFACE     = 1<<3|1<<7,    ///< used to couple bit levels by finding parent children relation
  PRISMSFROMSURFACE_INTERFACE   = 1<<3|1<<8,    ///< create prisms from surface elements
  MESHSETSMANAGER_INTERFACE     = 1<<3|1<<9,    ///< Interface to manage meshsets with materials and boundary conditions
  COORDSSYSTEMMANAGER_INTERFACE = 1<<3|1<<10,   ///< Interface to manage coordinate systems
  CUTMESH_INTERFACE             = 1<<3|1<<11    ///< Cutting mesh
};

enum LoopInterfaces {
  //Loop Methods
  KSP_METHOD    = 1<<0,
  SNES_METHOD   = 1<<1,
  TS_METHOD     = 1<<2,
  BASIC_METHOD  = 1<<0|1<<1|1<<2,
  FE_METHOD     = 1<<0|1<<1|1<<2|1<<3,
  ENT_METHOD    = 1<<0|1<<1|1<<2|1<<4
};

/**
 * \brief interfaces for PETSc DM interfaces
 */
enum DMInterfaces {
  UNKNOWN_DM_INTERFACE = 1<<0,
  DMCTX_INTERFACE = 1<<1
};

/**
 * \brief Interfaces uses to manage base functions
 */
enum BaseIntefaces {
  UNKNOWN_BASE_FUNCTION_INTERFACE     = 1<<0,
  LEGENDRE_BASE_FUNCTION_INTERFACE    = 1<<1,
  LOBATTO_BASE_FUNCTION_INTERFACE     = 1<<2,
  KERNEL_BASE_FUNCTION_INTERFACE      = 1<<3,
  JACOBI_BASE_FUNCTION_INTERFACE      = 1<<4,
  ENT_BASE_FUNCTION_INTERFACE         = 1<<5,
  TET_BASE_FUNCTION_INTERFACE         = 1<<1|1<<3|1<<3,
  TRI_BASE_FUNCTION_INTERFACE         = 1<<1|1<<3|1<<4,
  EDGE_BASE_FUNCTION_INTERFACE        = 1<<1|1<<3|1<<5,
  FATPRISM_BASE_FUNCTION_INTERFACE    = 1<<1|1<<3|1<<6,
  FLATPRISM_BASE_FUNCTION_INTERFACE   = 1<<1|1<<3|1<<7
};

/** \brief Error handling
  *
  * This is complementary to PETSC error codes. The numerical values for
  * these are defined in include/petscerror.h. The names are defined in err.c
  *
  * MoAB error messages are defined in naob/Types.hpp
  *
  */
enum MoFEMErrorCodes {
  MOFEM_SUCESS                  = 0,
  MOFEM_DATA_INCONSISTENCY      = 100,
  MOFEM_NOT_IMPLEMENTED         = 101,
  MOFEM_NOT_FOUND               = 102,
  MOFEM_OPERATION_UNSUCCESSFUL  = 103,
  MOFEM_IMPOSIBLE_CASE          = 104,
  MOFEM_MOFEMEXCEPTION_THROW    = 105,
  MOFEM_STD_EXCEPTION_THROW     = 106,
  MOFEM_INVALID_DATA            = 107,
  MOFEM_ATOM_TEST_INVALID       = 108,
  MOFEM_MOAB_ERROR              = 109
};

/// \brief approximation base
enum FieldApproximationBase {
  NOBASE = 0,
  AINSWORTH_LEGENDRE_BASE = 1,   ///< Ainsworth Cole (Legendre) approx. base \cite NME:NME847
  AINSWORTH_LOBBATO_BASE,        ///< Like AINSWORTH_LEGENDRE_BASE but with Lobatto base instead Legendre \cite beriot2015efficient
  AINSWORTH_BERNSTEIN_BEZIER_BASE,   ///< Not yet implemented, in implementation we will follow \cite ainsworth2011bernstein
  DEMKOWICZ_JACOBI_BASE,             ///< Construction of base is by Demkowicz \cite fuentes2015orientation
  USER_BASE,               ///< user implemented approximation base
  LASTBASE
};

const static char * const ApproximationBaseNames[] = {
  "NOBASE",
  "AINSWORTH_LEGENDRE_BASE",
  "AINSWORTH_LOBBATO_BASE",
  "AINSWORTH_BERNSTEIN_BEZIER_BASE",
  "DEMKOWICZ_JACOBI_BASE",
  "USER_BASE",
  "LASTBASE"
};

#ifdef __cplusplus
const static FieldApproximationBase ApproximationBaseArray[] = {
  NOBASE,
  AINSWORTH_LEGENDRE_BASE,
  AINSWORTH_LOBBATO_BASE,
  AINSWORTH_BERNSTEIN_BEZIER_BASE,
  DEMKOWICZ_JACOBI_BASE,
  USER_BASE,
  LASTBASE
};
#endif // __cplusplus

/// \brief approximation spaces
enum FieldSpace {
  NOSPACE = 0,
  NOFIELD = 1,  ///< scalar or vector of scalars describe (no true field)
  H1,                                 ///< continuous field
  HDIV,                               ///< field with continuous normal traction
  HCURL,              ///< field with continuous tangents
  L2,                                   ///< field with C-1 continuity
  LASTSPACE       ///< FieldSpace in [ 0, LASTSPACE )
};

const static char * const FieldSpaceNames[] = {
  "NOSPACE",
  "NOFIELD",
  "H1",
  "HDIV",
  "HCURL",
  "L2",
  "LASTSPACE"
};

/// \brief Those types control how functions respond on arguments, f.e. error handling
enum MoFEMTypes {
  MF_ZERO = 0,
  MF_EXCL = 1<<0,
  MF_EXIST = 1<<1
};

/// \brief RowColData
enum RowColData {
  ROW = 0,COL,DATA,LASTROWCOLDATA
};

/**
 *  Controls adjency multi_index container (e.g. BYROW is adjacenciecy by field on on rows), see
 *  \ref MoFEM::FieldEntityEntFiniteElementAdjacencyMap
 *
 */
enum ByWhat {
  BYROW     = 1<<0,
  BYCOL     = 1<<1,
  BYDATA    = 1<<2,
  BYROWDATA = 1<<0|1<<2,
  BYCOLDATA = 1<<1|1<<2,
  BYROWCOL  = 1<<0|1<<1,
  BYALL     = 1<<0|1<<1|1<<2
};

/**
  * \bief Types of sets and boundary conditions
  *
  */
enum CubitBC {
  UNKNOWNSET       = 0,
  NODESET          = 1<<0,
  SIDESET          = 1<<1,
  BLOCKSET         = 1<<2,
  MATERIALSET      = 1<<3,
  DISPLACEMENTSET  = 1<<4,
  FORCESET         = 1<<5,
  PRESSURESET      = 1<<6,
  VELOCITYSET      = 1<<7,
  ACCELERATIONSET  = 1<<8,
  TEMPERATURESET   = 1<<9,
  HEATFLUXSET      = 1<<10,
  INTERFACESET     = 1<<11,
  UNKNOWNNAME      = 1<<12,
  MAT_ELASTICSET   = 1<<13,       ///< block name is "MAT_ELASTIC"
  MAT_INTERFSET    = 1<<14,
  MAT_THERMALSET   = 1<<15,       ///< block name is "MAT_THERMAL"
  BODYFORCESSET    = 1<<16,     ///< block name is "BODY_FORCES"
  MAT_MOISTURESET  = 1<<17,     ///< block name is "MAT_MOISTURE"
  DIRICHLET_BC     = 1<<18,
  NEUMANN_BC       = 1<<19,
  LASTSET_BC       = 1<<20
};

// OFF_DEPRECATED static const unsigned int UNKNOWNCUBITNAME = UNKNOWNNAME;
// OFF_DEPRECATED static const unsigned int LASTCUBITSET = LASTSET_BC;

/**
 * \brief Names of types of sets and boundary conditions
 */
const static char * const CubitBCNames[] = {
  "UNKNOWNSET",
  "NODESET",
  "SIDESET",
  "BLOCKSET",
  "MATERIALSET",
  "DISPLACEMENTSET",
  "FORCESET",
  "PRESSURESET",
  "VELOCITYSET",
  "ACCELERATIONSET",
  "TEMPERATURESET",
  "HEATFLUXSET",
  "INTERFACESET",
  "UNKNOWNNAME",
  "MAT_ELASTICSET",
  "MAT_INTERFSET",
  "MAT_THERMALSET",
  "BODYFORCESSET",
  "MAT_MOISTURESET",
  "DIRICHLET_BC",
  "NEUMANN_BC",
  "LASTSET_BC"
};

/**
 * \brief Format of rows in gradients of H1 base functions
 */
enum H1DiffFormating {
  H1_0 = 0,H1_1,H1_2
};

/**
 * \brief Format in rows of Hdiv base functions
 */
enum HDivFormatting {
  HDIV0 = 0,HDIV1,HDIV2
};

/**
 * \brief Format in rows of Hdiv gradients of base functions
 */
enum HDivDiffFormatting {
  HDIV0_0 = 0,HDIV1_0,HDIV2_0,HDIV0_1,HDIV1_1,HDIV2_1,HDIV0_2,HDIV1_2,HDIV2_2
};

/**
 * \brief Format in rows of Hcurl base functions
 */
enum HCurlFormatting {
  HCURL0 = 0,HCURL1,HCURL2
};

/**
 * \brief Format in rows of Hcurl gradients of base functions
 */
enum HCurlDiffFormatting {
  HCURL0_0 = 0,HCURL1_0,HCURL2_0,HCURL0_1,HCURL1_1,HCURL2_1,HCURL0_2,HCURL1_2,HCURL2_2
};

#define BITREFEDGES_SIZE 6    ///< number of edges on tetrahedral
#define BITREFLEVEL_SIZE 128  ///< max number of refinements
#define BITFIELDID_SIZE 32    ///< max number of fields
#define BITFEID_SIZE 32       ///< max number of finite elements
#define BITPROBLEMID_SIZE 32  ///< max number of problems
#define BITINTERFACEUID_SIZE 32

#define MYPCOMM_INDEX 0       ///< default communicator number PCOMM

//This Is form MOAB
#define MB_TYPE_WIDTH 4
#define MB_ID_WIDTH (8*sizeof(EntityHandle)-MB_TYPE_WIDTH)
#define MB_TYPE_MASK ((EntityHandle)0xF << MB_ID_WIDTH)
//             2^MB_TYPE_WIDTH-1 ------^

#define MB_START_ID ((EntityID)1)        ///< All entity id's currently start at 1
#define MB_END_ID ((EntityID)MB_ID_MASK) ///< Last id is the complement of the MASK
#define MB_ID_MASK (~MB_TYPE_MASK)

#define MAX_DOFS_ON_ENTITY 512                ///< Maximal number of DOFs on entity
#define DOF_UID_MASK_ON_ENTITY (MAX_DOFS_ON_ENTITY-1)   ///< Mask for DOF number on entity form UId

#define NOT_USED(x) ( (void)(x) )

/** \brief set barrier start
 * Run code in sequence, starting from process 0, and ends on last process.
 *
 * It can be only used for testing. Do not use that function as a part of these
 * code.
 *
 */
#define BARRIER_RANK_START(PCMB) \
  { for(unsigned int i = 0; \
  i<PCMB->proc_config().proc_rank(); i++) MPI_Barrier(PCMB->proc_config().proc_comm()); };

/** \brief set barrier start
  * Run code in sequence, starting from process 0, and ends on last process.
  *
  * It can be only used for testing. Do not use that function as a part of these
  * code.
  *
  */
#define BARRIER_RANK_END(PCMB) \
  { for(unsigned int i = PCMB->proc_config().proc_rank(); \
  i<PCMB->proc_config().proc_size(); i++) MPI_Barrier(PCMB->proc_config().proc_comm()); };

#ifdef __cplusplus
extern "C" {
#endif

/**
 * \brief Is used to indicate that macro is deprecated
 * Do nothing just triggers error at the compilation
 */
DEPRECATED void macro_is_depracted_using_deprecated_function();

#ifdef __cplusplus
}
#endif

/**
 * \brief check error code of MoAB function
 * @param  a MoABErrorCode
 */
#define CHKERRQ_MOAB(a) do { \
  ErrorCode val = (a); \
  if (MB_SUCCESS != val) { \
    std::ostringstream ss; \
    ss << "Error code  " << val << " at " << __FILE__ << ":" << __LINE__ << std::endl; \
    std::string str(ss.str()); \
    SETERRQ(PETSC_COMM_SELF,MOFEM_MOAB_ERROR,str.c_str()); \
  } \
} while (false)

/**
 * \bried Check error code of MoAB function and throw MoFEM exception
 * @param  a MoABErrorCode
 */
#define MOAB_THROW(a) do { \
  ErrorCode val = (a); \
  if (MB_SUCCESS != val) { \
    std::ostringstream ss; \
    ss << "Error code  " << val << " at " << __FILE__ << ":" << __LINE__ << std::endl; \
    throw MoFEMException(MOFEM_MOAB_ERROR,ss.str().c_str() ); \
  } \
} while (false)

/**
 * \brief Throw MoFEM exception
 * @param  a message
 */
#define THROW_MESSAGE(a) { \
  std::ostringstream ss; \
  ss << a << " " << " at " << __FILE__ << ":" << __LINE__ << std::endl; \
  throw MoFEMException(MOFEM_MOFEMEXCEPTION_THROW,ss.str().c_str() ); \
}

/**
 * \brief Convert number to string
 * @param  x number
 */
#define SSTR(x) toString(x)

#endif //__DEFINITONS_H__