xref: /petsc/include/petscdmmoab.h (revision 66af8762ec03dbef0e079729eb2a1734a35ed7ff)
1 #pragma once
2 
3 #include <petscvec.h> /*I      "petscvec.h"    I*/
4 #include <petscmat.h> /*I      "petscmat.h"    I*/
5 #include <petscdm.h>  /*I      "petscdm.h"    I*/
6 #include <petscdt.h>  /*I "petscdt.h" I*/
7 
8 #include <string>
9 #include <moab/Core.hpp> /*I      "moab/Core.hpp"    I*/
10 #ifdef MOAB_HAVE_MPI
11   #include <moab/ParallelComm.hpp> /*I      "moab/ParallelComm.hpp"    I*/
12 #endif
13 
14 /* The MBERR macro is used to save typing. It checks a MOAB error code
15  * (rval) and calls SETERRQ if not MB_SUCCESS. A message (msg) can
16  * also be passed in. */
17 #define MBERR(msg, rval) PetscCheck(rval == moab::MB_SUCCESS, PETSC_COMM_SELF, PETSC_ERR_LIB, "MOAB ERROR (%i): %s", (PetscErrorCode)rval, msg)
18 #define MBERRNM(rval)    PetscCheck(rval == moab::MB_SUCCESS, PETSC_COMM_SELF, PETSC_ERR_LIB, "MOAB ERROR (%i)", rval)
19 #define MBERRV(mbif, rval) \
20   do { \
21     if (rval != moab::MB_SUCCESS) { \
22       std::string emsg; \
23       mbif->get_last_error(emsg); \
24       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "MOAB ERROR (%i): %s", (PetscErrorCode)rval, emsg.c_str()); \
25     } \
26   } while (0)
27 #define MBERRVM(mbif, msg, rval) \
28   do { \
29     if (rval != moab::MB_SUCCESS) { \
30       std::string emsg; \
31       mbif->get_last_error(emsg); \
32       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "MOAB ERROR (%i): %s :: %s", (PetscErrorCode)rval, msg, emsg.c_str()); \
33     } \
34   } while (0)
35 
36 /* define enums for options to read and write MOAB files in parallel */
37 typedef enum {
38   READ_PART,
39   READ_DELETE,
40   BCAST_DELETE
41 } MoabReadMode;
42 static const char *const MoabReadModes[] = {"READ_PART", "READ_DELETE", "BCAST_DELETE", "MoabReadMode", "", 0};
43 typedef enum {
44   WRITE_PART,
45   FORMAT
46 } MoabWriteMode;
47 static const char *const MoabWriteModes[] = {"WRITE_PART", "FORMAT", "MoabWriteMode", "", 0};
48 
49 PETSC_EXTERN PetscErrorCode DMMoabCreate(MPI_Comm comm, DM *moab);
50 PETSC_EXTERN PetscErrorCode DMMoabCreateMoab(MPI_Comm comm, moab::Interface *mbiface, moab::Tag *ltog_tag, moab::Range *range, DM *moab);
51 PETSC_EXTERN PetscErrorCode DMMoabOutput(DM, const char *, const char *);
52 
53 PETSC_EXTERN PetscErrorCode DMMoabSetInterface(DM, moab::Interface *);
54 PETSC_EXTERN PetscErrorCode DMMoabGetInterface(DM, moab::Interface **);
55 #ifdef MOAB_HAVE_MPI
56 PETSC_EXTERN PetscErrorCode DMMoabGetParallelComm(DM, moab::ParallelComm **);
57 #endif
58 
59 PETSC_EXTERN PetscErrorCode DMMoabSetLocalVertices(DM, moab::Range *);
60 PETSC_EXTERN PetscErrorCode DMMoabGetAllVertices(DM, moab::Range *local);
61 PETSC_EXTERN PetscErrorCode DMMoabGetLocalVertices(DM, const moab::Range **, const moab::Range **);
62 PETSC_EXTERN PetscErrorCode DMMoabSetLocalElements(DM, moab::Range *);
63 PETSC_EXTERN PetscErrorCode DMMoabGetLocalElements(DM, const moab::Range **);
64 PETSC_EXTERN PetscErrorCode DMMoabSetLocalToGlobalTag(DM, moab::Tag);
65 PETSC_EXTERN PetscErrorCode DMMoabGetLocalToGlobalTag(DM, moab::Tag *);
66 PETSC_EXTERN PetscErrorCode DMMoabSetBlockSize(DM, PetscInt bs);
67 PETSC_EXTERN PetscErrorCode DMMoabGetBlockSize(DM, PetscInt *bs);
68 PETSC_EXTERN PetscErrorCode DMMoabSetBlockFills(DM, const PetscInt *, const PetscInt *);
69 PETSC_EXTERN PetscErrorCode DMMoabGetHierarchyLevel(DM, PetscInt *);
70 
71 PETSC_EXTERN PetscErrorCode DMMoabGetDimension(DM dm, PetscInt *dim);
72 PETSC_EXTERN PetscErrorCode DMMoabGetBoundaryEntities(DM dm, moab::Range *, moab::Range *, moab::Range *);
73 PETSC_EXTERN PetscErrorCode DMMoabGetMaterialBlock(DM dm, const moab::EntityHandle, PetscInt *);
74 
75 PETSC_EXTERN PetscErrorCode DMMoabGetSize(DM dm, PetscInt *, PetscInt *);
76 PETSC_EXTERN PetscErrorCode DMMoabGetLocalSize(DM dm, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
77 PETSC_EXTERN PetscErrorCode DMMoabGetOffset(DM dm, PetscInt *);
78 
79 PETSC_EXTERN PetscErrorCode DMMoabVecGetArrayRead(DM, Vec, void *);
80 PETSC_EXTERN PetscErrorCode DMMoabVecRestoreArrayRead(DM, Vec, void *);
81 PETSC_EXTERN PetscErrorCode DMMoabVecGetArray(DM, Vec, void *);
82 PETSC_EXTERN PetscErrorCode DMMoabVecRestoreArray(DM, Vec, void *);
83 
84 PETSC_EXTERN PetscErrorCode DMMoabCreateVector(DM dm, moab::Tag tag, const moab::Range *range, PetscBool serial, PetscBool destroy_tag, Vec *X);
85 PETSC_EXTERN PetscErrorCode DMMoabGetVecTag(Vec vec, moab::Tag *tag);
86 PETSC_EXTERN PetscErrorCode DMMoabGetVecRange(Vec vec, moab::Range *range);
87 
88 PETSC_EXTERN PetscErrorCode DMMoabSetFieldVector(DM, PetscInt, Vec);
89 PETSC_EXTERN PetscErrorCode DMMoabSetGlobalFieldVector(DM, Vec);
90 
91 PETSC_EXTERN PetscErrorCode DMMoabCreateVertices(DM, const PetscReal *coords, PetscInt nverts, moab::Range *);
92 PETSC_EXTERN PetscErrorCode DMMoabCreateElement(DM, const moab::EntityType type, const moab::EntityHandle *conn, PetscInt nverts, moab::EntityHandle *elem);
93 PETSC_EXTERN PetscErrorCode DMMoabCreateSubmesh(DM dm, DM *newdm);
94 PETSC_EXTERN PetscErrorCode DMMoabRenumberMeshEntities(DM dm);
95 
96 PETSC_EXTERN PetscErrorCode DMMoabGetFieldName(DM dm, PetscInt field, const char **fieldName);
97 PETSC_EXTERN PetscErrorCode DMMoabSetFieldName(DM dm, PetscInt field, const char *fieldName);
98 PETSC_EXTERN PetscErrorCode DMMoabSetFieldNames(DM dm, PetscInt nfields, const char *fields[]);
99 PETSC_EXTERN PetscErrorCode DMMoabGetFieldDof(DM dm, moab::EntityHandle point, PetscInt field, PetscInt *dof);
100 PETSC_EXTERN PetscErrorCode DMMoabGetFieldDofs(DM dm, PetscInt npoints, const moab::EntityHandle *points, PetscInt field, PetscInt *dof);
101 PETSC_EXTERN PetscErrorCode DMMoabGetFieldDofsLocal(DM dm, PetscInt npoints, const moab::EntityHandle *points, PetscInt field, PetscInt *dof);
102 PETSC_EXTERN PetscErrorCode DMMoabGetDofs(DM dm, PetscInt npoints, const moab::EntityHandle *points, PetscInt *dof);
103 PETSC_EXTERN PetscErrorCode DMMoabGetDofsLocal(DM dm, PetscInt npoints, const moab::EntityHandle *points, PetscInt *dof);
104 PETSC_EXTERN PetscErrorCode DMMoabGetDofsBlocked(DM dm, PetscInt npoints, const moab::EntityHandle *points, PetscInt *dof);
105 PETSC_EXTERN PetscErrorCode DMMoabGetDofsBlockedLocal(DM dm, PetscInt npoints, const moab::EntityHandle *points, PetscInt *dof);
106 
107 PETSC_EXTERN PetscErrorCode DMMoabGetVertexDofsBlocked(DM dm, PetscInt **dof);
108 PETSC_EXTERN PetscErrorCode DMMoabGetVertexDofsBlockedLocal(DM dm, PetscInt **dof);
109 
110 /* discretization and assembly specific DMMoab interface functions */
111 PETSC_EXTERN PetscErrorCode DMMoabGetElementConnectivity(DM dm, moab::EntityHandle ehandle, PetscInt *nconn, const moab::EntityHandle **conn);
112 PETSC_EXTERN PetscErrorCode DMMoabGetVertexConnectivity(DM dm, moab::EntityHandle ehandle, PetscInt *nconn, moab::EntityHandle **conn);
113 PETSC_EXTERN PetscErrorCode DMMoabRestoreVertexConnectivity(DM dm, moab::EntityHandle ehandle, PetscInt *nconn, moab::EntityHandle **conn);
114 PETSC_EXTERN PetscErrorCode DMMoabGetVertexCoordinates(DM dm, PetscInt nconn, const moab::EntityHandle *conn, PetscReal *vpos);
115 PETSC_EXTERN PetscErrorCode DMMoabIsEntityOnBoundary(DM dm, const moab::EntityHandle ent, PetscBool *ent_on_boundary);
116 PETSC_EXTERN PetscErrorCode DMMoabCheckBoundaryVertices(DM dm, PetscInt nconn, const moab::EntityHandle *cnt, PetscBool *isbdvtx);
117 PETSC_EXTERN PetscErrorCode DMMoabGetBoundaryMarkers(DM dm, const moab::Range **bdvtx, const moab::Range **bdelems, const moab::Range **bdfaces);
118 
119 /* TODO: Replace nverts/coords with just moab::EntityHandle -- can also eliminate dim */
120 /* TODO: Replace quad/npts with PetscDT */
121 PETSC_EXTERN PetscErrorCode DMMoabFEMCreateQuadratureDefault(const PetscInt dim, const PetscInt nverts, PetscQuadrature *quadrature);
122 PETSC_EXTERN PetscErrorCode DMMoabFEMComputeBasis(const PetscInt dim, const PetscInt nverts, const PetscReal *coordinates, const PetscQuadrature quadrature, PetscReal *phypts, PetscReal *jxw, PetscReal *phi, PetscReal **dphi);
123 PETSC_EXTERN PetscErrorCode DMMoabPToRMapping(const PetscInt dim, const PetscInt nverts, const PetscReal *coordinates, const PetscReal *xphy, PetscReal *natparam, PetscReal *phi);
124 
125 /* DM utility creation interface */
126 PETSC_EXTERN PetscErrorCode DMMoabCreateBoxMesh(MPI_Comm, PetscInt, PetscBool, const PetscReal *, PetscInt, PetscInt, DM *);
127 PETSC_EXTERN PetscErrorCode DMMoabLoadFromFile(MPI_Comm, PetscInt, PetscInt, const char *, const char *, DM *);
128 
129 /* Uniform refinement hierarchy interface */
130 PETSC_EXTERN PetscErrorCode DMMoabGenerateHierarchy(DM dm, PetscInt nlevels, PetscInt *ldegrees);
131