1: #pragma once

  3: #include <petscvec.h>
  4: #include <petscmat.h>
  5: #include <petscdm.h>
  6: #include <petscdt.h>

  8: /* MANSEC = DM */
  9: /* SUBMANSEC = DMMOAB */

 11: #include <string>
 12: #if defined(__clang__)
 13:   #pragma clang diagnostic push
 14:   #pragma clang diagnostic ignored "-Wunknown-warning-option"
 15:   #pragma clang diagnostic ignored "-Wnontrivial-memcall"
 16: #endif
 17: #include <moab/Core.hpp> /*I      "moab/Core.hpp"    I*/
 18: #if defined(__clang__)
 19:   #pragma clang diagnostic pop
 20: #endif
 21: #ifdef MOAB_HAVE_MPI
 22:   #include <moab/ParallelComm.hpp> /*I      "moab/ParallelComm.hpp"    I*/
 23: #endif

 25: /*MC
 26:   PetscCallMOAB - Calls a MOAB function and then checks the resulting error code, if it is
 27:   non-zero it calls the error handler and returns from the current function with the error
 28:   code `PETSC_ERR_LIB`.

 30:   Synopsis:
 31: #include <petscdmmoab.h>
 32:   void PetscCallMOAB(MOABFunction(args))

 34:   Not Collective

 36:   Input Parameter:
 37: . MOABFunction - any MOAB function that returns an error code

 39:   Level: beginner

 41: .seealso: `PetscCall()`, `SETERRQ()`, `PetscCheck()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()`,
 42:           `PetscPushErrorHandler()`, `PetscError()`
 43: M*/
 44: #define PetscCallMOAB(...) \
 45:   do { \
 46:     moab::ErrorCode ierr_moab_call_q; \
 47:     PetscStackUpdateLine; \
 48:     ierr_moab_call_q = __VA_ARGS__; \
 49:     PetscCheck(ierr_moab_call_q == moab::MB_SUCCESS, PETSC_COMM_SELF, PETSC_ERR_LIB, "MOAB ERROR (%i)", (int)ierr_moab_call_q); \
 50:   } while (0)

 52: /* define enums for options to read and write MOAB files in parallel */

 54: /*E
 55:   MoabReadMode - Parallel I/O strategy passed to MOAB when reading a mesh file through `DMMOAB`

 57:   Values:
 58: + `READ_PART`    - each MPI rank reads only the portion of the file describing its partition (requires a partition-aware file)
 59: . `READ_DELETE`  - every rank reads the entire file and then deletes the entities it does not own
 60: - `BCAST_DELETE` - rank 0 reads the file and broadcasts it, then every rank deletes the entities it does not own

 62:   Level: intermediate

 64: .seealso: `DMMOAB`, `MoabWriteMode`, `DMMoabCreate()`
 65: E*/
 66: typedef enum {
 67:   READ_PART,
 68:   READ_DELETE,
 69:   BCAST_DELETE
 70: } MoabReadMode;
 71: static const char *const MoabReadModes[] = {"READ_PART", "READ_DELETE", "BCAST_DELETE", "MoabReadMode", "", 0};

 73: /*E
 74:   MoabWriteMode - Parallel I/O strategy passed to MOAB when writing a mesh file through `DMMOAB`

 76:   Values:
 77: + `WRITE_PART` - write a partitioned file with one section per MPI rank
 78: - `FORMAT`     - write a single non-partitioned file in the requested MOAB output format

 80:   Level: intermediate

 82: .seealso: `DMMOAB`, `MoabReadMode`, `DMMoabOutput()`
 83: E*/
 84: typedef enum {
 85:   WRITE_PART,
 86:   FORMAT
 87: } MoabWriteMode;
 88: static const char *const MoabWriteModes[] = {"WRITE_PART", "FORMAT", "MoabWriteMode", "", 0};

 90: PETSC_EXTERN PetscErrorCode DMMoabCreate(MPI_Comm, DM *);
 91: PETSC_EXTERN PetscErrorCode DMMoabCreateMoab(MPI_Comm, moab::Interface *, moab::Tag *, moab::Range *, DM *);
 92: PETSC_EXTERN PetscErrorCode DMMoabOutput(DM, const char *, const char *);

 94: PETSC_EXTERN PetscErrorCode DMMoabSetInterface(DM, moab::Interface *);
 95: PETSC_EXTERN PetscErrorCode DMMoabGetInterface(DM, moab::Interface **);
 96: #ifdef MOAB_HAVE_MPI
 97: PETSC_EXTERN PetscErrorCode DMMoabGetParallelComm(DM, moab::ParallelComm **);
 98: #endif

100: PETSC_EXTERN PetscErrorCode DMMoabSetLocalVertices(DM, moab::Range *);
101: PETSC_EXTERN PetscErrorCode DMMoabGetAllVertices(DM, moab::Range *);
102: PETSC_EXTERN PetscErrorCode DMMoabGetLocalVertices(DM, const moab::Range **, const moab::Range **);
103: PETSC_EXTERN PetscErrorCode DMMoabSetLocalElements(DM, moab::Range *);
104: PETSC_EXTERN PetscErrorCode DMMoabGetLocalElements(DM, const moab::Range **);
105: PETSC_EXTERN PetscErrorCode DMMoabSetLocalToGlobalTag(DM, moab::Tag);
106: PETSC_EXTERN PetscErrorCode DMMoabGetLocalToGlobalTag(DM, moab::Tag *);
107: PETSC_EXTERN PetscErrorCode DMMoabSetBlockSize(DM, PetscInt);
108: PETSC_EXTERN PetscErrorCode DMMoabGetBlockSize(DM, PetscInt *);
109: PETSC_EXTERN PetscErrorCode DMMoabSetBlockFills(DM, const PetscInt *, const PetscInt *);
110: PETSC_EXTERN PetscErrorCode DMMoabGetHierarchyLevel(DM, PetscInt *);

112: PETSC_EXTERN PetscErrorCode DMMoabGetDimension(DM, PetscInt *);
113: PETSC_EXTERN PetscErrorCode DMMoabGetBoundaryEntities(DM, moab::Range *, moab::Range *, moab::Range *);
114: PETSC_EXTERN PetscErrorCode DMMoabGetMaterialBlock(DM, const moab::EntityHandle, PetscInt *);

116: PETSC_EXTERN PetscErrorCode DMMoabGetSize(DM, PetscInt *, PetscInt *);
117: PETSC_EXTERN PetscErrorCode DMMoabGetLocalSize(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
118: PETSC_EXTERN PetscErrorCode DMMoabGetOffset(DM, PetscInt *);

120: PETSC_EXTERN PetscErrorCode DMMoabVecGetArrayRead(DM, Vec, void *);
121: PETSC_EXTERN PetscErrorCode DMMoabVecRestoreArrayRead(DM, Vec, void *);
122: PETSC_EXTERN PetscErrorCode DMMoabVecGetArray(DM, Vec, void *);
123: PETSC_EXTERN PetscErrorCode DMMoabVecRestoreArray(DM, Vec, void *);

125: PETSC_EXTERN PetscErrorCode DMMoabCreateVector(DM, moab::Tag, const moab::Range *, PetscBool, PetscBool, Vec *);
126: PETSC_EXTERN PetscErrorCode DMMoabGetVecTag(Vec, moab::Tag *);
127: PETSC_EXTERN PetscErrorCode DMMoabGetVecRange(Vec, moab::Range *);

129: PETSC_EXTERN PetscErrorCode DMMoabSetFieldVector(DM, PetscInt, Vec);
130: PETSC_EXTERN PetscErrorCode DMMoabSetGlobalFieldVector(DM, Vec);

132: PETSC_EXTERN PetscErrorCode DMMoabCreateVertices(DM, const PetscReal *, PetscInt, moab::Range *);
133: PETSC_EXTERN PetscErrorCode DMMoabCreateElement(DM, const moab::EntityType, const moab::EntityHandle *, PetscInt, moab::EntityHandle *);
134: PETSC_EXTERN PetscErrorCode DMMoabCreateSubmesh(DM, DM *);
135: PETSC_EXTERN PetscErrorCode DMMoabRenumberMeshEntities(DM);

137: PETSC_EXTERN PetscErrorCode DMMoabGetFieldName(DM, PetscInt, const char *[]);
138: PETSC_EXTERN PetscErrorCode DMMoabSetFieldName(DM, PetscInt, const char *);
139: PETSC_EXTERN PetscErrorCode DMMoabSetFieldNames(DM, PetscInt, const char *[]);
140: PETSC_EXTERN PetscErrorCode DMMoabGetFieldDof(DM, moab::EntityHandle, PetscInt, PetscInt *);
141: PETSC_EXTERN PetscErrorCode DMMoabGetFieldDofs(DM, PetscInt, const moab::EntityHandle *, PetscInt, PetscInt *);
142: PETSC_EXTERN PetscErrorCode DMMoabGetFieldDofsLocal(DM, PetscInt, const moab::EntityHandle *, PetscInt, PetscInt *);
143: PETSC_EXTERN PetscErrorCode DMMoabGetDofs(DM, PetscInt, const moab::EntityHandle *, PetscInt *);
144: PETSC_EXTERN PetscErrorCode DMMoabGetDofsLocal(DM, PetscInt, const moab::EntityHandle *, PetscInt *);
145: PETSC_EXTERN PetscErrorCode DMMoabGetDofsBlocked(DM, PetscInt, const moab::EntityHandle *, PetscInt *);
146: PETSC_EXTERN PetscErrorCode DMMoabGetDofsBlockedLocal(DM, PetscInt, const moab::EntityHandle *, PetscInt *);

148: PETSC_EXTERN PetscErrorCode DMMoabGetVertexDofsBlocked(DM, PetscInt **);
149: PETSC_EXTERN PetscErrorCode DMMoabGetVertexDofsBlockedLocal(DM, PetscInt **);

151: /* discretization and assembly specific DMMoab interface functions */
152: PETSC_EXTERN PetscErrorCode DMMoabGetElementConnectivity(DM, moab::EntityHandle, PetscInt *, const moab::EntityHandle **);
153: PETSC_EXTERN PetscErrorCode DMMoabGetVertexConnectivity(DM, moab::EntityHandle, PetscInt *, moab::EntityHandle **);
154: PETSC_EXTERN PetscErrorCode DMMoabRestoreVertexConnectivity(DM, moab::EntityHandle, PetscInt *, moab::EntityHandle **);
155: PETSC_EXTERN PetscErrorCode DMMoabGetVertexCoordinates(DM, PetscInt, const moab::EntityHandle *, PetscReal *);
156: PETSC_EXTERN PetscErrorCode DMMoabIsEntityOnBoundary(DM, const moab::EntityHandle, PetscBool *);
157: PETSC_EXTERN PetscErrorCode DMMoabCheckBoundaryVertices(DM, PetscInt, const moab::EntityHandle *, PetscBool *);
158: PETSC_EXTERN PetscErrorCode DMMoabGetBoundaryMarkers(DM, const moab::Range **, const moab::Range **, const moab::Range **);

160: /* TODO: Replace nverts/coords with just moab::EntityHandle -- can also eliminate dim */
161: /* TODO: Replace quad/npts with PetscDT */
162: PETSC_EXTERN PetscErrorCode DMMoabFEMCreateQuadratureDefault(const PetscInt, const PetscInt, PetscQuadrature *);
163: PETSC_EXTERN PetscErrorCode DMMoabFEMComputeBasis(const PetscInt, const PetscInt, const PetscReal *, const PetscQuadrature, PetscReal *, PetscReal *, PetscReal *, PetscReal **);
164: PETSC_EXTERN PetscErrorCode DMMoabPToRMapping(const PetscInt, const PetscInt, const PetscReal *, const PetscReal *, PetscReal *, PetscReal *);

166: /* DM utility creation interface */
167: PETSC_EXTERN PetscErrorCode DMMoabCreateBoxMesh(MPI_Comm, PetscInt, PetscBool, const PetscReal *, PetscInt, PetscInt, DM *);
168: PETSC_EXTERN PetscErrorCode DMMoabLoadFromFile(MPI_Comm, PetscInt, PetscInt, const char *, const char *, DM *);

170: /* Uniform refinement hierarchy interface */
171: PETSC_EXTERN PetscErrorCode DMMoabGenerateHierarchy(DM, PetscInt, PetscInt *);