xref: /libCEED/examples/fluids/src/petsc_ops.c (revision a424bcd0dd58ea8f8b80ddde5af211268f0b358a)
14021610dSJames Wright // Copyright (c) 2017-2023, Lawrence Livermore National Security, LLC and other CEED contributors.
24021610dSJames Wright // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
34021610dSJames Wright //
44021610dSJames Wright // SPDX-License-Identifier: BSD-2-Clause
54021610dSJames Wright //
64021610dSJames Wright // This file is part of CEED:  http://github.com/ceed
74021610dSJames Wright 
84021610dSJames Wright #include "../include/petsc_ops.h"
94021610dSJames Wright 
104021610dSJames Wright #include <ceed.h>
114021610dSJames Wright #include <petscdm.h>
124021610dSJames Wright 
134021610dSJames Wright #include "../navierstokes.h"
144021610dSJames Wright 
15b718eef5SJames Wright // @brief Get information about a DM's local vector
16b718eef5SJames Wright PetscErrorCode DMGetLocalVectorInfo(DM dm, PetscInt *local_size, PetscInt *global_size, VecType *vec_type) {
17b718eef5SJames Wright   Vec V_loc;
18b718eef5SJames Wright 
19b718eef5SJames Wright   PetscFunctionBeginUser;
20b718eef5SJames Wright   PetscCall(DMGetLocalVector(dm, &V_loc));
21b718eef5SJames Wright   if (local_size) PetscCall(VecGetLocalSize(V_loc, local_size));
22b718eef5SJames Wright   if (global_size) PetscCall(VecGetSize(V_loc, global_size));
23b718eef5SJames Wright   if (vec_type) PetscCall(VecGetType(V_loc, vec_type));
24b718eef5SJames Wright   PetscCall(DMRestoreLocalVector(dm, &V_loc));
25ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
26b718eef5SJames Wright }
27b718eef5SJames Wright 
28b718eef5SJames Wright // @brief Get information about a DM's global vector
29b718eef5SJames Wright PetscErrorCode DMGetGlobalVectorInfo(DM dm, PetscInt *local_size, PetscInt *global_size, VecType *vec_type) {
30b718eef5SJames Wright   Vec V;
31b718eef5SJames Wright 
32b718eef5SJames Wright   PetscFunctionBeginUser;
33b718eef5SJames Wright   PetscCall(DMGetGlobalVector(dm, &V));
34b718eef5SJames Wright   if (local_size) PetscCall(VecGetLocalSize(V, local_size));
35b718eef5SJames Wright   if (global_size) PetscCall(VecGetSize(V, global_size));
36b718eef5SJames Wright   if (vec_type) PetscCall(VecGetType(V, vec_type));
37b718eef5SJames Wright   PetscCall(DMRestoreGlobalVector(dm, &V));
38ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
39b718eef5SJames Wright }
40b718eef5SJames Wright 
412cd2c56bSJames Wright /**
422cd2c56bSJames Wright  * @brief Create OperatorApplyContext struct for applying FEM operator in a PETSc context
432cd2c56bSJames Wright  *
442cd2c56bSJames Wright  * All passed in objects are reference copied and may be destroyed if desired (with the exception of `CEED_VECTOR_NONE`).
452cd2c56bSJames Wright  * Resulting context should be destroyed with `OperatorApplyContextDestroy()`.
462cd2c56bSJames Wright  *
472cd2c56bSJames Wright  * @param[in]  dm_x     `DM` associated with the operator active input. May be `NULL`
482cd2c56bSJames Wright  * @param[in]  dm_y     `DM` associated with the operator active output. May be `NULL`
492cd2c56bSJames Wright  * @param[in]  ceed     `Ceed` object
502cd2c56bSJames Wright  * @param[in]  op_apply `CeedOperator` representing the local action of the FEM operator
512cd2c56bSJames Wright  * @param[in]  x_ceed   `CeedVector` for operator active input. May be `CEED_VECTOR_NONE` or `NULL`. If `NULL`, `CeedVector` will be automatically
522cd2c56bSJames Wright  *                      generated.
532cd2c56bSJames Wright  * @param[in]  y_ceed   `CeedVector` for operator active output. May be `CEED_VECTOR_NONE` or `NULL`. If `NULL`, `CeedVector` will be automatically
542cd2c56bSJames Wright  *                      generated.
552cd2c56bSJames Wright  * @param[in]  X_loc    Local `Vec` for operator active input. If `NULL`, vector will be obtained if needed at ApplyCeedOperator time.
562cd2c56bSJames Wright  * @param[in]  Y_loc    Local `Vec` for operator active output. If `NULL`, vector will be obtained if needed at ApplyCeedOperator time.
572cd2c56bSJames Wright  * @param[out] ctx      Struct containing all data necessary for applying the operator
582cd2c56bSJames Wright  */
594021610dSJames Wright PetscErrorCode OperatorApplyContextCreate(DM dm_x, DM dm_y, Ceed ceed, CeedOperator op_apply, CeedVector x_ceed, CeedVector y_ceed, Vec X_loc,
602cd2c56bSJames Wright                                           Vec Y_loc, OperatorApplyContext *ctx) {
614021610dSJames Wright   CeedSize x_size, y_size;
622cd2c56bSJames Wright 
632cd2c56bSJames Wright   PetscFunctionBeginUser;
64*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedOperatorGetActiveVectorLengths(op_apply, &x_size, &y_size));
652cd2c56bSJames Wright   {  // Verify sizes
66dd715608SJames Wright     PetscInt X_size, Y_size, dm_X_size, dm_Y_size;
67dd715608SJames Wright     CeedSize x_ceed_size, y_ceed_size;
68dd715608SJames Wright     if (dm_x) PetscCall(DMGetLocalVectorInfo(dm_x, &dm_X_size, NULL, NULL));
69dd715608SJames Wright     if (dm_y) PetscCall(DMGetLocalVectorInfo(dm_y, &dm_Y_size, NULL, NULL));
704021610dSJames Wright     if (X_loc) {
714021610dSJames Wright       PetscCall(VecGetLocalSize(X_loc, &X_size));
724021610dSJames Wright       PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
734021610dSJames Wright                  "X_loc (%" PetscInt_FMT ") not correct size for CeedOperator active input size (%" CeedSize_FMT ")", X_size, x_size);
74dd715608SJames Wright       if (dm_x)
75dd715608SJames Wright         PetscCheck(X_size == dm_X_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
76dd715608SJames Wright                    "X_loc size (%" PetscInt_FMT ") does not match dm_x local vector size (%" PetscInt_FMT ")", X_size, dm_X_size);
774021610dSJames Wright     }
784021610dSJames Wright     if (Y_loc) {
794021610dSJames Wright       PetscCall(VecGetLocalSize(Y_loc, &Y_size));
804021610dSJames Wright       PetscCheck(Y_size == y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
814021610dSJames Wright                  "Y_loc (%" PetscInt_FMT ") not correct size for CeedOperator active output size (%" CeedSize_FMT ")", Y_size, y_size);
82dd715608SJames Wright       if (dm_y)
83dd715608SJames Wright         PetscCheck(Y_size == dm_Y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
84dd715608SJames Wright                    "Y_loc size (%" PetscInt_FMT ") does not match dm_y local vector size (%" PetscInt_FMT ")", Y_size, dm_Y_size);
85dd715608SJames Wright     }
86dd715608SJames Wright     if (x_ceed && x_ceed != CEED_VECTOR_NONE) {
87*a424bcd0SJames Wright       PetscCallCeed(ceed, CeedVectorGetLength(x_ceed, &x_ceed_size));
88dd715608SJames Wright       PetscCheck(x_size >= 0 ? x_ceed_size == x_size : true, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
89dd715608SJames Wright                  "x_ceed (%" CeedSize_FMT ") not correct size for CeedOperator active input size (%" CeedSize_FMT ")", x_ceed_size, x_size);
90dd715608SJames Wright       if (dm_x)
91dd715608SJames Wright         PetscCheck(x_ceed_size == dm_X_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
92dd715608SJames Wright                    "x_ceed size (%" CeedSize_FMT ") does not match dm_x local vector size (%" PetscInt_FMT ")", x_ceed_size, dm_X_size);
93dd715608SJames Wright     }
94dd715608SJames Wright     if (y_ceed && y_ceed != CEED_VECTOR_NONE) {
95*a424bcd0SJames Wright       PetscCallCeed(ceed, CeedVectorGetLength(y_ceed, &y_ceed_size));
96dd715608SJames Wright       PetscCheck(y_ceed_size == y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
97dd715608SJames Wright                  "y_ceed (%" CeedSize_FMT ") not correct size for CeedOperator active input size (%" CeedSize_FMT ")", y_ceed_size, y_size);
98dd715608SJames Wright       if (dm_y)
99dd715608SJames Wright         PetscCheck(y_ceed_size == dm_Y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
100dd715608SJames Wright                    "y_ceed size (%" CeedSize_FMT ") does not match dm_y local vector size (%" PetscInt_FMT ")", y_ceed_size, dm_Y_size);
1014021610dSJames Wright     }
1024021610dSJames Wright   }
1034021610dSJames Wright 
1042cd2c56bSJames Wright   PetscCall(PetscNew(ctx));
1054021610dSJames Wright 
1064021610dSJames Wright   // Copy PETSc Objects
1074021610dSJames Wright   if (dm_x) PetscCall(PetscObjectReference((PetscObject)dm_x));
1082cd2c56bSJames Wright   (*ctx)->dm_x = dm_x;
1094021610dSJames Wright   if (dm_y) PetscCall(PetscObjectReference((PetscObject)dm_y));
1102cd2c56bSJames Wright   (*ctx)->dm_y = dm_y;
1114021610dSJames Wright 
1124021610dSJames Wright   if (X_loc) PetscCall(PetscObjectReference((PetscObject)X_loc));
1132cd2c56bSJames Wright   (*ctx)->X_loc = X_loc;
1144021610dSJames Wright   if (Y_loc) PetscCall(PetscObjectReference((PetscObject)Y_loc));
1152cd2c56bSJames Wright   (*ctx)->Y_loc = Y_loc;
1164021610dSJames Wright 
1174021610dSJames Wright   // Copy libCEED objects
118*a424bcd0SJames Wright   if (x_ceed) PetscCallCeed(ceed, CeedVectorReferenceCopy(x_ceed, &(*ctx)->x_ceed));
119*a424bcd0SJames Wright   else PetscCallCeed(ceed, CeedVectorCreate(ceed, x_size, &(*ctx)->x_ceed));
1202cd2c56bSJames Wright 
121*a424bcd0SJames Wright   if (y_ceed) PetscCallCeed(ceed, CeedVectorReferenceCopy(y_ceed, &(*ctx)->y_ceed));
122*a424bcd0SJames Wright   else PetscCallCeed(ceed, CeedVectorCreate(ceed, y_size, &(*ctx)->y_ceed));
1232cd2c56bSJames Wright 
124*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedOperatorReferenceCopy(op_apply, &(*ctx)->op));
125*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedReferenceCopy(ceed, &(*ctx)->ceed));
1264021610dSJames Wright 
127ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
1284021610dSJames Wright }
1294021610dSJames Wright 
1302cd2c56bSJames Wright /**
1312cd2c56bSJames Wright  * @brief Destroy OperatorApplyContext struct
1322cd2c56bSJames Wright  *
1332cd2c56bSJames Wright  * @param[in,out] ctx Context to destroy
1342cd2c56bSJames Wright  */
1352cd2c56bSJames Wright PetscErrorCode OperatorApplyContextDestroy(OperatorApplyContext ctx) {
1364021610dSJames Wright   PetscFunctionBeginUser;
137ee4ca9cbSJames Wright   if (!ctx) PetscFunctionReturn(PETSC_SUCCESS);
138*a424bcd0SJames Wright   Ceed ceed = ctx->ceed;
1394021610dSJames Wright 
1404021610dSJames Wright   // Destroy PETSc Objects
1412cd2c56bSJames Wright   PetscCall(DMDestroy(&ctx->dm_x));
1422cd2c56bSJames Wright   PetscCall(DMDestroy(&ctx->dm_y));
1432cd2c56bSJames Wright   PetscCall(VecDestroy(&ctx->X_loc));
1442cd2c56bSJames Wright   PetscCall(VecDestroy(&ctx->Y_loc));
1454021610dSJames Wright 
1464021610dSJames Wright   // Destroy libCEED Objects
147*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorDestroy(&ctx->x_ceed));
148*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorDestroy(&ctx->y_ceed));
149*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedOperatorDestroy(&ctx->op));
150*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedDestroy(&ctx->ceed));
1514021610dSJames Wright 
1522cd2c56bSJames Wright   PetscCall(PetscFree(ctx));
1534021610dSJames Wright 
154ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
1554021610dSJames Wright }
1564021610dSJames Wright 
1574021610dSJames Wright /**
1584021610dSJames Wright   @brief Transfer array from PETSc Vec to CeedVector
1594021610dSJames Wright 
1604021610dSJames Wright   @param[in]   X_petsc   PETSc Vec
1614021610dSJames Wright   @param[out]  mem_type  PETSc MemType
1624021610dSJames Wright   @param[out]  x_ceed    CeedVector
1634021610dSJames Wright 
1644021610dSJames Wright   @return An error code: 0 - success, otherwise - failure
1654021610dSJames Wright **/
1664021610dSJames Wright PetscErrorCode VecP2C(Vec X_petsc, PetscMemType *mem_type, CeedVector x_ceed) {
1674021610dSJames Wright   PetscScalar *x;
1684021610dSJames Wright   PetscInt     X_size;
1694021610dSJames Wright   CeedSize     x_size;
170*a424bcd0SJames Wright   Ceed         ceed;
1714021610dSJames Wright 
1724021610dSJames Wright   PetscFunctionBeginUser;
173*a424bcd0SJames Wright   PetscCall(CeedVectorGetCeed(x_ceed, &ceed));
1744021610dSJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
175*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorGetLength(x_ceed, &x_size));
1764021610dSJames Wright   PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ, "X_petsc (%" PetscInt_FMT ") and x_ceed (%" CeedSize_FMT ") must be same size",
1774021610dSJames Wright              X_size, x_size);
1784021610dSJames Wright 
1794021610dSJames Wright   PetscCall(VecGetArrayAndMemType(X_petsc, &x, mem_type));
180*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorSetArray(x_ceed, MemTypeP2C(*mem_type), CEED_USE_POINTER, x));
1814021610dSJames Wright 
182ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
1834021610dSJames Wright }
1844021610dSJames Wright 
1854021610dSJames Wright /**
1864021610dSJames Wright   @brief Transfer array from CeedVector to PETSc Vec
1874021610dSJames Wright 
1884021610dSJames Wright   @param[in]   x_ceed    CeedVector
1894021610dSJames Wright   @param[in]   mem_type  PETSc MemType
1904021610dSJames Wright   @param[out]  X_petsc   PETSc Vec
1914021610dSJames Wright 
1924021610dSJames Wright   @return An error code: 0 - success, otherwise - failure
1934021610dSJames Wright **/
1944021610dSJames Wright PetscErrorCode VecC2P(CeedVector x_ceed, PetscMemType mem_type, Vec X_petsc) {
1954021610dSJames Wright   PetscScalar *x;
1964021610dSJames Wright   PetscInt     X_size;
1974021610dSJames Wright   CeedSize     x_size;
198*a424bcd0SJames Wright   Ceed         ceed;
1994021610dSJames Wright 
2004021610dSJames Wright   PetscFunctionBeginUser;
201*a424bcd0SJames Wright   PetscCall(CeedVectorGetCeed(x_ceed, &ceed));
2024021610dSJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
203*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorGetLength(x_ceed, &x_size));
2044021610dSJames Wright   PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ, "X_petsc (%" PetscInt_FMT ") and x_ceed (%" CeedSize_FMT ") must be same size",
2054021610dSJames Wright              X_size, x_size);
2064021610dSJames Wright 
207*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorTakeArray(x_ceed, MemTypeP2C(mem_type), &x));
2084021610dSJames Wright   PetscCall(VecRestoreArrayAndMemType(X_petsc, &x));
2094021610dSJames Wright 
210ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
2114021610dSJames Wright }
2124021610dSJames Wright 
2134021610dSJames Wright /**
2144021610dSJames Wright   @brief Transfer read-only array from PETSc Vec to CeedVector
2154021610dSJames Wright 
2164021610dSJames Wright   @param[in]   X_petsc   PETSc Vec
2174021610dSJames Wright   @param[out]  mem_type  PETSc MemType
2184021610dSJames Wright   @param[out]  x_ceed    CeedVector
2194021610dSJames Wright 
2204021610dSJames Wright   @return An error code: 0 - success, otherwise - failure
2214021610dSJames Wright **/
2224021610dSJames Wright PetscErrorCode VecReadP2C(Vec X_petsc, PetscMemType *mem_type, CeedVector x_ceed) {
2234021610dSJames Wright   PetscScalar *x;
2244021610dSJames Wright   PetscInt     X_size;
2254021610dSJames Wright   CeedSize     x_size;
226*a424bcd0SJames Wright   Ceed         ceed;
2274021610dSJames Wright 
2284021610dSJames Wright   PetscFunctionBeginUser;
229*a424bcd0SJames Wright   PetscCall(CeedVectorGetCeed(x_ceed, &ceed));
2304021610dSJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
231*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorGetLength(x_ceed, &x_size));
2324021610dSJames Wright   PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ, "X_petsc (%" PetscInt_FMT ") and x_ceed (%" CeedSize_FMT ") must be same size",
2334021610dSJames Wright              X_size, x_size);
2344021610dSJames Wright 
2354021610dSJames Wright   PetscCall(VecGetArrayReadAndMemType(X_petsc, (const PetscScalar **)&x, mem_type));
236*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorSetArray(x_ceed, MemTypeP2C(*mem_type), CEED_USE_POINTER, x));
2374021610dSJames Wright 
238ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
2394021610dSJames Wright }
2404021610dSJames Wright 
2414021610dSJames Wright /**
2424021610dSJames Wright   @brief Transfer read-only array from CeedVector to PETSc Vec
2434021610dSJames Wright 
2444021610dSJames Wright   @param[in]   x_ceed    CeedVector
2454021610dSJames Wright   @param[in]   mem_type  PETSc MemType
2464021610dSJames Wright   @param[out]  X_petsc   PETSc Vec
2474021610dSJames Wright 
2484021610dSJames Wright   @return An error code: 0 - success, otherwise - failure
2494021610dSJames Wright **/
2504021610dSJames Wright PetscErrorCode VecReadC2P(CeedVector x_ceed, PetscMemType mem_type, Vec X_petsc) {
2514021610dSJames Wright   PetscScalar *x;
2524021610dSJames Wright   PetscInt     X_size;
2534021610dSJames Wright   CeedSize     x_size;
254*a424bcd0SJames Wright   Ceed         ceed;
2554021610dSJames Wright 
2564021610dSJames Wright   PetscFunctionBeginUser;
257*a424bcd0SJames Wright   PetscCall(CeedVectorGetCeed(x_ceed, &ceed));
2584021610dSJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
259*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorGetLength(x_ceed, &x_size));
2604021610dSJames Wright   PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ, "X_petsc (%" PetscInt_FMT ") and x_ceed (%" CeedSize_FMT ") must be same size",
2614021610dSJames Wright              X_size, x_size);
2624021610dSJames Wright 
263*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorTakeArray(x_ceed, MemTypeP2C(mem_type), &x));
2644021610dSJames Wright   PetscCall(VecRestoreArrayReadAndMemType(X_petsc, (const PetscScalar **)&x));
2654021610dSJames Wright 
266ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
2674021610dSJames Wright }
2684021610dSJames Wright 
2694021610dSJames Wright /**
2704021610dSJames Wright   @brief Copy PETSc Vec data into CeedVector
2714021610dSJames Wright 
2724021610dSJames Wright   @param[in]   X_petsc PETSc Vec
2734021610dSJames Wright   @param[out]  x_ceed  CeedVector
2744021610dSJames Wright 
2754021610dSJames Wright   @return An error code: 0 - success, otherwise - failure
2764021610dSJames Wright **/
2774021610dSJames Wright PetscErrorCode VecCopyP2C(Vec X_petsc, CeedVector x_ceed) {
2784021610dSJames Wright   PetscScalar *x;
2794021610dSJames Wright   PetscMemType mem_type;
2804021610dSJames Wright   PetscInt     X_size;
2814021610dSJames Wright   CeedSize     x_size;
282*a424bcd0SJames Wright   Ceed         ceed;
2834021610dSJames Wright 
2844021610dSJames Wright   PetscFunctionBeginUser;
285*a424bcd0SJames Wright   PetscCall(CeedVectorGetCeed(x_ceed, &ceed));
2864021610dSJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
287*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorGetLength(x_ceed, &x_size));
2884021610dSJames Wright   PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ, "X_petsc (%" PetscInt_FMT ") and x_ceed (%" CeedSize_FMT ") must be same size",
2894021610dSJames Wright              X_size, x_size);
2904021610dSJames Wright 
2914021610dSJames Wright   PetscCall(VecGetArrayReadAndMemType(X_petsc, (const PetscScalar **)&x, &mem_type));
292*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedVectorSetArray(x_ceed, MemTypeP2C(mem_type), CEED_COPY_VALUES, x));
2934021610dSJames Wright   PetscCall(VecRestoreArrayReadAndMemType(X_petsc, (const PetscScalar **)&x));
2944021610dSJames Wright 
295ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
2964021610dSJames Wright }
2974021610dSJames Wright 
2984210c567SJames Wright //@brief Return VecType for the given DM
2994210c567SJames Wright VecType DMReturnVecType(DM dm) {
3004210c567SJames Wright   VecType vec_type;
3014210c567SJames Wright   DMGetVecType(dm, &vec_type);
3024210c567SJames Wright   return vec_type;
3034210c567SJames Wright }
3044210c567SJames Wright 
3054210c567SJames Wright /**
3064210c567SJames Wright  * @brief Create local PETSc Vecs for CeedOperator's active input/outputs
3074210c567SJames Wright  *
3084210c567SJames Wright  * This is primarily used for when the active input/ouput vector does not correspond to a `DM` object, and thus `DMCreateLocalVector` or
3094210c567SJames Wright  * `DMGetLocalVector` are not applicable.
3104210c567SJames Wright  * For example, if statitics are being store at quadrature points, a `DM`-created `Vec` will not have the
3114210c567SJames Wright  * correct size.
3124210c567SJames Wright  *
3134210c567SJames Wright  * @param[in]  dm     DM overwhich the Vecs would be used
3144210c567SJames Wright  * @param[in]  op     Operator to make the Vecs for
3154210c567SJames Wright  * @param[out] input  Vec for CeedOperator active input
3164210c567SJames Wright  * @param[out] output Vec for CeedOperator active output
3174210c567SJames Wright  */
3184210c567SJames Wright PetscErrorCode CeedOperatorCreateLocalVecs(CeedOperator op, VecType vec_type, MPI_Comm comm, Vec *input, Vec *output) {
3194210c567SJames Wright   CeedSize input_size, output_size;
320*a424bcd0SJames Wright   Ceed     ceed;
3214210c567SJames Wright 
3224210c567SJames Wright   PetscFunctionBeginUser;
323*a424bcd0SJames Wright   PetscCall(CeedOperatorGetCeed(op, &ceed));
324*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedOperatorGetActiveVectorLengths(op, &input_size, &output_size));
3254210c567SJames Wright   if (input) {
3264210c567SJames Wright     PetscCall(VecCreate(comm, input));
3274210c567SJames Wright     PetscCall(VecSetType(*input, vec_type));
3284210c567SJames Wright     PetscCall(VecSetSizes(*input, input_size, input_size));
3294210c567SJames Wright   }
3304210c567SJames Wright   if (output) {
3314210c567SJames Wright     PetscCall(VecCreate(comm, output));
3324210c567SJames Wright     PetscCall(VecSetType(*output, vec_type));
3334210c567SJames Wright     PetscCall(VecSetSizes(*output, output_size, output_size));
3344210c567SJames Wright   }
3354210c567SJames Wright 
336ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
3374210c567SJames Wright }
3384210c567SJames Wright 
3394021610dSJames Wright /**
3404021610dSJames Wright  * @brief Apply FEM Operator defined by `OperatorApplyContext` to various input and output vectors
3414021610dSJames Wright  *
342f0d883e9SJames Wright  * @param[in]     X             Input global `Vec`, maybe `NULL`
343f0d883e9SJames Wright  * @param[in]     X_loc         Input local `Vec`, maybe `NULL`
344f0d883e9SJames Wright  * @param[in]     x_ceed        Input `CeedVector`, maybe `CEED_VECTOR_NONE`
345f0d883e9SJames Wright  * @param[in,out] y_ceed        Output `CeedVector`, maybe `CEED_VECTOR_NONE`
346f0d883e9SJames Wright  * @param[in,out] Y_loc         Output local `Vec`, maybe `NULL`
347f0d883e9SJames Wright  * @param[in,out] Y             Output global `Vec`, maybe `NULL`
348f0d883e9SJames Wright  * @param[in]     ctx           Context for the operator apply
349f0d883e9SJames Wright  * @param[in]     use_apply_add Whether to use `CeedOperatorApply` or `CeedOperatorApplyAdd`
3504021610dSJames Wright  */
3514021610dSJames Wright PetscErrorCode ApplyCeedOperator_Core(Vec X, Vec X_loc, CeedVector x_ceed, CeedVector y_ceed, Vec Y_loc, Vec Y, OperatorApplyContext ctx,
3524021610dSJames Wright                                       bool use_apply_add) {
3534021610dSJames Wright   PetscMemType x_mem_type, y_mem_type;
354*a424bcd0SJames Wright   Ceed         ceed = ctx->ceed;
3554021610dSJames Wright 
3564021610dSJames Wright   PetscFunctionBeginUser;
3574021610dSJames Wright   if (X) PetscCall(DMGlobalToLocal(ctx->dm_x, X, INSERT_VALUES, X_loc));
3584021610dSJames Wright   if (X_loc) PetscCall(VecReadP2C(X_loc, &x_mem_type, x_ceed));
3594021610dSJames Wright 
3604021610dSJames Wright   if (Y_loc) PetscCall(VecP2C(Y_loc, &y_mem_type, y_ceed));
3614021610dSJames Wright 
36275d1798cSJames Wright   PetscCall(PetscLogEventBegin(FLUIDS_CeedOperatorApply, X, Y, 0, 0));
36375d1798cSJames Wright   PetscCall(PetscLogGpuTimeBegin());
364*a424bcd0SJames Wright   if (use_apply_add) PetscCallCeed(ceed, CeedOperatorApplyAdd(ctx->op, x_ceed, y_ceed, CEED_REQUEST_IMMEDIATE));
365*a424bcd0SJames Wright   else PetscCallCeed(ceed, CeedOperatorApply(ctx->op, x_ceed, y_ceed, CEED_REQUEST_IMMEDIATE));
36675d1798cSJames Wright   PetscCall(PetscLogGpuTimeEnd());
36775d1798cSJames Wright   PetscCall(PetscLogEventEnd(FLUIDS_CeedOperatorApply, X, Y, 0, 0));
3684021610dSJames Wright 
3694021610dSJames Wright   if (X_loc) PetscCall(VecReadC2P(ctx->x_ceed, x_mem_type, X_loc));
3704021610dSJames Wright 
3714021610dSJames Wright   if (Y_loc) PetscCall(VecC2P(ctx->y_ceed, y_mem_type, Y_loc));
3724021610dSJames Wright   if (Y) PetscCall(DMLocalToGlobal(ctx->dm_y, Y_loc, ADD_VALUES, Y));
3734021610dSJames Wright 
374ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
3754021610dSJames Wright };
3764021610dSJames Wright 
3774021610dSJames Wright PetscErrorCode ApplyCeedOperatorGlobalToGlobal(Vec X, Vec Y, OperatorApplyContext ctx) {
3784021610dSJames Wright   Vec X_loc = ctx->X_loc, Y_loc = ctx->Y_loc;
3794021610dSJames Wright 
3804021610dSJames Wright   PetscFunctionBeginUser;
3814021610dSJames Wright   PetscCall(VecZeroEntries(Y));
3824021610dSJames Wright 
3834021610dSJames Wright   // Get local vectors (if needed)
3844021610dSJames Wright   if (!ctx->X_loc) PetscCall(DMGetLocalVector(ctx->dm_x, &X_loc));
3854021610dSJames Wright   if (!ctx->Y_loc) PetscCall(DMGetLocalVector(ctx->dm_y, &Y_loc));
3864021610dSJames Wright 
3874021610dSJames Wright   PetscCall(ApplyCeedOperator_Core(X, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, Y, ctx, false));
3884021610dSJames Wright 
3894021610dSJames Wright   // Restore local vector (if needed)
3904021610dSJames Wright   if (!ctx->X_loc) PetscCall(DMRestoreLocalVector(ctx->dm_x, &X_loc));
3914021610dSJames Wright   if (!ctx->Y_loc) PetscCall(DMRestoreLocalVector(ctx->dm_y, &Y_loc));
3924021610dSJames Wright 
393ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
3944021610dSJames Wright }
3954021610dSJames Wright 
3964021610dSJames Wright PetscErrorCode ApplyCeedOperatorLocalToGlobal(Vec X_loc, Vec Y, OperatorApplyContext ctx) {
3974021610dSJames Wright   Vec Y_loc = ctx->Y_loc;
3984021610dSJames Wright 
3994021610dSJames Wright   PetscFunctionBeginUser;
4004021610dSJames Wright   PetscCall(VecZeroEntries(Y));
4014021610dSJames Wright 
4024021610dSJames Wright   // Get local vectors (if needed)
4034021610dSJames Wright   if (!ctx->Y_loc) PetscCall(DMGetLocalVector(ctx->dm_y, &Y_loc));
4044021610dSJames Wright 
4054021610dSJames Wright   PetscCall(ApplyCeedOperator_Core(NULL, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, Y, ctx, false));
4064021610dSJames Wright 
4074021610dSJames Wright   // Restore local vectors (if needed)
4084021610dSJames Wright   if (!ctx->Y_loc) PetscCall(DMRestoreLocalVector(ctx->dm_y, &Y_loc));
4094021610dSJames Wright 
410ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
4114021610dSJames Wright }
4124021610dSJames Wright 
4134021610dSJames Wright PetscErrorCode ApplyCeedOperatorGlobalToLocal(Vec X, Vec Y_loc, OperatorApplyContext ctx) {
4144021610dSJames Wright   Vec X_loc = ctx->X_loc;
4154021610dSJames Wright 
4164021610dSJames Wright   PetscFunctionBeginUser;
4174021610dSJames Wright   // Get local vectors (if needed)
4184021610dSJames Wright   if (!ctx->X_loc) PetscCall(DMGetLocalVector(ctx->dm_x, &X_loc));
4194021610dSJames Wright 
4204021610dSJames Wright   PetscCall(ApplyCeedOperator_Core(X, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, NULL, ctx, false));
4214021610dSJames Wright 
4224021610dSJames Wright   // Restore local vector (if needed)
4234021610dSJames Wright   if (!ctx->X_loc) PetscCall(DMRestoreLocalVector(ctx->dm_x, &X_loc));
4244021610dSJames Wright 
425ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
4264021610dSJames Wright }
4274021610dSJames Wright 
42893567eeaSJames Wright PetscErrorCode ApplyCeedOperatorLocalToLocal(Vec X_loc, Vec Y_loc, OperatorApplyContext ctx) {
42993567eeaSJames Wright   PetscFunctionBeginUser;
43093567eeaSJames Wright   PetscCall(ApplyCeedOperator_Core(NULL, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, NULL, ctx, false));
431ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
43293567eeaSJames Wright }
43393567eeaSJames Wright 
4344021610dSJames Wright PetscErrorCode ApplyAddCeedOperatorLocalToLocal(Vec X_loc, Vec Y_loc, OperatorApplyContext ctx) {
4354021610dSJames Wright   PetscFunctionBeginUser;
4364021610dSJames Wright   PetscCall(ApplyCeedOperator_Core(NULL, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, NULL, ctx, true));
437ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
4384021610dSJames Wright }
4394021610dSJames Wright 
4404021610dSJames Wright // -----------------------------------------------------------------------------
4414021610dSJames Wright // Wraps the libCEED operator for a MatShell
4424021610dSJames Wright // -----------------------------------------------------------------------------
4434021610dSJames Wright PetscErrorCode MatMult_Ceed(Mat A, Vec X, Vec Y) {
4444021610dSJames Wright   OperatorApplyContext ctx;
4454021610dSJames Wright   PetscFunctionBeginUser;
4464021610dSJames Wright 
4474021610dSJames Wright   PetscCall(MatShellGetContext(A, &ctx));
4484021610dSJames Wright   PetscCall(ApplyCeedOperatorGlobalToGlobal(X, Y, ctx));
4494021610dSJames Wright 
450ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
4514021610dSJames Wright };
4524021610dSJames Wright 
4534021610dSJames Wright // -----------------------------------------------------------------------------
4544021610dSJames Wright // Returns the computed diagonal of the operator
4554021610dSJames Wright // -----------------------------------------------------------------------------
4564021610dSJames Wright PetscErrorCode MatGetDiag_Ceed(Mat A, Vec D) {
4574021610dSJames Wright   OperatorApplyContext ctx;
4584021610dSJames Wright   Vec                  Y_loc;
4594021610dSJames Wright   PetscMemType         mem_type;
4604021610dSJames Wright   PetscFunctionBeginUser;
4614021610dSJames Wright 
4624021610dSJames Wright   PetscCall(MatShellGetContext(A, &ctx));
463*a424bcd0SJames Wright   Ceed ceed = ctx->ceed;
4644021610dSJames Wright   if (ctx->Y_loc) Y_loc = ctx->Y_loc;
4654021610dSJames Wright   else PetscCall(DMGetLocalVector(ctx->dm_y, &Y_loc));
4664021610dSJames Wright 
4674021610dSJames Wright   // -- Place PETSc vector in libCEED vector
4684021610dSJames Wright   PetscCall(VecP2C(Y_loc, &mem_type, ctx->y_ceed));
4694021610dSJames Wright 
4704021610dSJames Wright   // -- Compute Diagonal
47175d1798cSJames Wright   PetscCall(PetscLogEventBegin(FLUIDS_CeedOperatorAssembleDiagonal, A, D, 0, 0));
47275d1798cSJames Wright   PetscCall(PetscLogGpuTimeBegin());
473*a424bcd0SJames Wright   PetscCallCeed(ceed, CeedOperatorLinearAssembleDiagonal(ctx->op, ctx->y_ceed, CEED_REQUEST_IMMEDIATE));
47475d1798cSJames Wright   PetscCall(PetscLogGpuTimeEnd());
47575d1798cSJames Wright   PetscCall(PetscLogEventEnd(FLUIDS_CeedOperatorAssembleDiagonal, A, D, 0, 0));
4764021610dSJames Wright 
4774021610dSJames Wright   // -- Local-to-Global
4784021610dSJames Wright   PetscCall(VecC2P(ctx->y_ceed, mem_type, Y_loc));
4794021610dSJames Wright   PetscCall(VecZeroEntries(D));
4804021610dSJames Wright   PetscCall(DMLocalToGlobal(ctx->dm_y, Y_loc, ADD_VALUES, D));
4814021610dSJames Wright 
4824021610dSJames Wright   if (!ctx->Y_loc) PetscCall(DMRestoreLocalVector(ctx->dm_y, &Y_loc));
483ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
4844021610dSJames Wright };
4854021610dSJames Wright 
486b35d522bSJames Wright /**
487b35d522bSJames Wright  * @brief Create PETSc MatShell object for the corresponding OperatorApplyContext
488b35d522bSJames Wright  *
489b35d522bSJames Wright  * @param[in]  ctx Context that does the action of the operator
490b35d522bSJames Wright  * @param[out] mat MatShell for the operator
491b35d522bSJames Wright  */
492b35d522bSJames Wright PetscErrorCode CreateMatShell_Ceed(OperatorApplyContext ctx, Mat *mat) {
493b35d522bSJames Wright   MPI_Comm comm_x = PetscObjectComm((PetscObject)(ctx->dm_x));
494b35d522bSJames Wright   MPI_Comm comm_y = PetscObjectComm((PetscObject)(ctx->dm_y));
495b35d522bSJames Wright   PetscInt X_loc_size, X_size, Y_size, Y_loc_size;
496b35d522bSJames Wright   VecType  X_vec_type, Y_vec_type;
497b35d522bSJames Wright 
498b35d522bSJames Wright   PetscFunctionBeginUser;
499f5452247SJames Wright   PetscCheck(comm_x == comm_y, PETSC_COMM_WORLD, PETSC_ERR_ARG_NOTSAMECOMM, "Input and output DM must have the same comm");
500b35d522bSJames Wright 
501b35d522bSJames Wright   PetscCall(DMGetGlobalVectorInfo(ctx->dm_x, &X_loc_size, &X_size, &X_vec_type));
502b35d522bSJames Wright   PetscCall(DMGetGlobalVectorInfo(ctx->dm_y, &Y_loc_size, &Y_size, &Y_vec_type));
503b35d522bSJames Wright 
504b35d522bSJames Wright   PetscCall(MatCreateShell(comm_x, Y_loc_size, X_loc_size, Y_size, X_size, ctx, mat));
505b35d522bSJames Wright   PetscCall(MatShellSetContextDestroy(*mat, (PetscErrorCode(*)(void *))OperatorApplyContextDestroy));
506b35d522bSJames Wright   PetscCall(MatShellSetOperation(*mat, MATOP_MULT, (void (*)(void))MatMult_Ceed));
507b35d522bSJames Wright   PetscCall(MatShellSetOperation(*mat, MATOP_GET_DIAGONAL, (void (*)(void))MatGetDiag_Ceed));
508b35d522bSJames Wright 
509b35d522bSJames Wright   PetscCheck(X_vec_type == Y_vec_type, PETSC_COMM_WORLD, PETSC_ERR_ARG_NOTSAMETYPE, "Vec_type of ctx->dm_x (%s) and ctx->dm_y (%s) must be the same",
510b35d522bSJames Wright              X_vec_type, Y_vec_type);
511b35d522bSJames Wright   PetscCall(MatShellSetVecType(*mat, X_vec_type));
512b35d522bSJames Wright 
513ee4ca9cbSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
514b35d522bSJames Wright }
515b35d522bSJames Wright 
5164021610dSJames Wright // -----------------------------------------------------------------------------
517