xref: /honee/src/petsc_ops.c (revision d949ddfc92e3b3e8aad90700e3fb60ca7f4585db)
1f7325489SJames Wright // Copyright (c) 2017-2023, Lawrence Livermore National Security, LLC and other CEED contributors.
2f7325489SJames Wright // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3f7325489SJames Wright //
4f7325489SJames Wright // SPDX-License-Identifier: BSD-2-Clause
5f7325489SJames Wright //
6f7325489SJames Wright // This file is part of CEED:  http://github.com/ceed
7f7325489SJames Wright 
8f7325489SJames Wright #include "../include/petsc_ops.h"
9f7325489SJames Wright 
10f7325489SJames Wright #include <ceed.h>
11f7325489SJames Wright #include <petscdm.h>
12f7325489SJames Wright 
13f7325489SJames Wright #include "../navierstokes.h"
14f7325489SJames Wright 
1529afcdd1SJames Wright // @brief Get information about a DM's local vector
1629afcdd1SJames Wright PetscErrorCode DMGetLocalVectorInfo(DM dm, PetscInt *local_size, PetscInt *global_size, VecType *vec_type) {
1729afcdd1SJames Wright   Vec V_loc;
1829afcdd1SJames Wright 
1929afcdd1SJames Wright   PetscFunctionBeginUser;
2029afcdd1SJames Wright   PetscCall(DMGetLocalVector(dm, &V_loc));
2129afcdd1SJames Wright   if (local_size) PetscCall(VecGetLocalSize(V_loc, local_size));
2229afcdd1SJames Wright   if (global_size) PetscCall(VecGetSize(V_loc, global_size));
2329afcdd1SJames Wright   if (vec_type) PetscCall(VecGetType(V_loc, vec_type));
2429afcdd1SJames Wright   PetscCall(DMRestoreLocalVector(dm, &V_loc));
25*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
2629afcdd1SJames Wright }
2729afcdd1SJames Wright 
2829afcdd1SJames Wright // @brief Get information about a DM's global vector
2929afcdd1SJames Wright PetscErrorCode DMGetGlobalVectorInfo(DM dm, PetscInt *local_size, PetscInt *global_size, VecType *vec_type) {
3029afcdd1SJames Wright   Vec V;
3129afcdd1SJames Wright 
3229afcdd1SJames Wright   PetscFunctionBeginUser;
3329afcdd1SJames Wright   PetscCall(DMGetGlobalVector(dm, &V));
3429afcdd1SJames Wright   if (local_size) PetscCall(VecGetLocalSize(V, local_size));
3529afcdd1SJames Wright   if (global_size) PetscCall(VecGetSize(V, global_size));
3629afcdd1SJames Wright   if (vec_type) PetscCall(VecGetType(V, vec_type));
3729afcdd1SJames Wright   PetscCall(DMRestoreGlobalVector(dm, &V));
38*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
3929afcdd1SJames Wright }
4029afcdd1SJames Wright 
41fbcfc4fcSJames Wright /**
42fbcfc4fcSJames Wright  * @brief Create OperatorApplyContext struct for applying FEM operator in a PETSc context
43fbcfc4fcSJames Wright  *
44fbcfc4fcSJames Wright  * All passed in objects are reference copied and may be destroyed if desired (with the exception of `CEED_VECTOR_NONE`).
45fbcfc4fcSJames Wright  * Resulting context should be destroyed with `OperatorApplyContextDestroy()`.
46fbcfc4fcSJames Wright  *
47fbcfc4fcSJames Wright  * @param[in]  dm_x     `DM` associated with the operator active input. May be `NULL`
48fbcfc4fcSJames Wright  * @param[in]  dm_y     `DM` associated with the operator active output. May be `NULL`
49fbcfc4fcSJames Wright  * @param[in]  ceed     `Ceed` object
50fbcfc4fcSJames Wright  * @param[in]  op_apply `CeedOperator` representing the local action of the FEM operator
51fbcfc4fcSJames Wright  * @param[in]  x_ceed   `CeedVector` for operator active input. May be `CEED_VECTOR_NONE` or `NULL`. If `NULL`, `CeedVector` will be automatically
52fbcfc4fcSJames Wright  *                      generated.
53fbcfc4fcSJames Wright  * @param[in]  y_ceed   `CeedVector` for operator active output. May be `CEED_VECTOR_NONE` or `NULL`. If `NULL`, `CeedVector` will be automatically
54fbcfc4fcSJames Wright  *                      generated.
55fbcfc4fcSJames Wright  * @param[in]  X_loc    Local `Vec` for operator active input. If `NULL`, vector will be obtained if needed at ApplyCeedOperator time.
56fbcfc4fcSJames Wright  * @param[in]  Y_loc    Local `Vec` for operator active output. If `NULL`, vector will be obtained if needed at ApplyCeedOperator time.
57fbcfc4fcSJames Wright  * @param[out] ctx      Struct containing all data necessary for applying the operator
58fbcfc4fcSJames Wright  */
59f7325489SJames Wright PetscErrorCode OperatorApplyContextCreate(DM dm_x, DM dm_y, Ceed ceed, CeedOperator op_apply, CeedVector x_ceed, CeedVector y_ceed, Vec X_loc,
60fbcfc4fcSJames Wright                                           Vec Y_loc, OperatorApplyContext *ctx) {
61f7325489SJames Wright   CeedSize x_size, y_size;
62fbcfc4fcSJames Wright 
63fbcfc4fcSJames Wright   PetscFunctionBeginUser;
64f7325489SJames Wright   CeedOperatorGetActiveVectorLengths(op_apply, &x_size, &y_size);
65fbcfc4fcSJames Wright   {  // Verify sizes
6682560a70SJames Wright     PetscInt X_size, Y_size, dm_X_size, dm_Y_size;
6782560a70SJames Wright     CeedSize x_ceed_size, y_ceed_size;
6882560a70SJames Wright     if (dm_x) PetscCall(DMGetLocalVectorInfo(dm_x, &dm_X_size, NULL, NULL));
6982560a70SJames Wright     if (dm_y) PetscCall(DMGetLocalVectorInfo(dm_y, &dm_Y_size, NULL, NULL));
70f7325489SJames Wright     if (X_loc) {
71f7325489SJames Wright       PetscCall(VecGetLocalSize(X_loc, &X_size));
72f7325489SJames Wright       PetscCheck(X_size == x_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
73f7325489SJames Wright                  "X_loc (%" PetscInt_FMT ") not correct size for CeedOperator active input size (%" CeedSize_FMT ")", X_size, x_size);
7482560a70SJames Wright       if (dm_x)
7582560a70SJames Wright         PetscCheck(X_size == dm_X_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
7682560a70SJames Wright                    "X_loc size (%" PetscInt_FMT ") does not match dm_x local vector size (%" PetscInt_FMT ")", X_size, dm_X_size);
77f7325489SJames Wright     }
78f7325489SJames Wright     if (Y_loc) {
79f7325489SJames Wright       PetscCall(VecGetLocalSize(Y_loc, &Y_size));
80f7325489SJames Wright       PetscCheck(Y_size == y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
81f7325489SJames Wright                  "Y_loc (%" PetscInt_FMT ") not correct size for CeedOperator active output size (%" CeedSize_FMT ")", Y_size, y_size);
8282560a70SJames Wright       if (dm_y)
8382560a70SJames Wright         PetscCheck(Y_size == dm_Y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
8482560a70SJames Wright                    "Y_loc size (%" PetscInt_FMT ") does not match dm_y local vector size (%" PetscInt_FMT ")", Y_size, dm_Y_size);
8582560a70SJames Wright     }
8682560a70SJames Wright     if (x_ceed && x_ceed != CEED_VECTOR_NONE) {
8782560a70SJames Wright       CeedVectorGetLength(x_ceed, &x_ceed_size);
8882560a70SJames Wright       PetscCheck(x_size >= 0 ? x_ceed_size == x_size : true, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
8982560a70SJames Wright                  "x_ceed (%" CeedSize_FMT ") not correct size for CeedOperator active input size (%" CeedSize_FMT ")", x_ceed_size, x_size);
9082560a70SJames Wright       if (dm_x)
9182560a70SJames Wright         PetscCheck(x_ceed_size == dm_X_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
9282560a70SJames Wright                    "x_ceed size (%" CeedSize_FMT ") does not match dm_x local vector size (%" PetscInt_FMT ")", x_ceed_size, dm_X_size);
9382560a70SJames Wright     }
9482560a70SJames Wright     if (y_ceed && y_ceed != CEED_VECTOR_NONE) {
9582560a70SJames Wright       CeedVectorGetLength(y_ceed, &y_ceed_size);
9682560a70SJames Wright       PetscCheck(y_ceed_size == y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
9782560a70SJames Wright                  "y_ceed (%" CeedSize_FMT ") not correct size for CeedOperator active input size (%" CeedSize_FMT ")", y_ceed_size, y_size);
9882560a70SJames Wright       if (dm_y)
9982560a70SJames Wright         PetscCheck(y_ceed_size == dm_Y_size, PETSC_COMM_WORLD, PETSC_ERR_ARG_SIZ,
10082560a70SJames Wright                    "y_ceed size (%" CeedSize_FMT ") does not match dm_y local vector size (%" PetscInt_FMT ")", y_ceed_size, dm_Y_size);
101f7325489SJames Wright     }
102f7325489SJames Wright   }
103f7325489SJames Wright 
104fbcfc4fcSJames Wright   PetscCall(PetscNew(ctx));
105f7325489SJames Wright 
106f7325489SJames Wright   // Copy PETSc Objects
107f7325489SJames Wright   if (dm_x) PetscCall(PetscObjectReference((PetscObject)dm_x));
108fbcfc4fcSJames Wright   (*ctx)->dm_x = dm_x;
109f7325489SJames Wright   if (dm_y) PetscCall(PetscObjectReference((PetscObject)dm_y));
110fbcfc4fcSJames Wright   (*ctx)->dm_y = dm_y;
111f7325489SJames Wright 
112f7325489SJames Wright   if (X_loc) PetscCall(PetscObjectReference((PetscObject)X_loc));
113fbcfc4fcSJames Wright   (*ctx)->X_loc = X_loc;
114f7325489SJames Wright   if (Y_loc) PetscCall(PetscObjectReference((PetscObject)Y_loc));
115fbcfc4fcSJames Wright   (*ctx)->Y_loc = Y_loc;
116f7325489SJames Wright 
117f7325489SJames Wright   // Copy libCEED objects
118fbcfc4fcSJames Wright   if (x_ceed) CeedVectorReferenceCopy(x_ceed, &(*ctx)->x_ceed);
119fbcfc4fcSJames Wright   else CeedVectorCreate(ceed, x_size, &(*ctx)->x_ceed);
120fbcfc4fcSJames Wright 
121fbcfc4fcSJames Wright   if (y_ceed) CeedVectorReferenceCopy(y_ceed, &(*ctx)->y_ceed);
122fbcfc4fcSJames Wright   else CeedVectorCreate(ceed, y_size, &(*ctx)->y_ceed);
123fbcfc4fcSJames Wright 
124fbcfc4fcSJames Wright   CeedOperatorReferenceCopy(op_apply, &(*ctx)->op);
125fbcfc4fcSJames Wright   CeedReferenceCopy(ceed, &(*ctx)->ceed);
126f7325489SJames Wright 
127*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
128f7325489SJames Wright }
129f7325489SJames Wright 
130fbcfc4fcSJames Wright /**
131fbcfc4fcSJames Wright  * @brief Destroy OperatorApplyContext struct
132fbcfc4fcSJames Wright  *
133fbcfc4fcSJames Wright  * @param[in,out] ctx Context to destroy
134fbcfc4fcSJames Wright  */
135fbcfc4fcSJames Wright PetscErrorCode OperatorApplyContextDestroy(OperatorApplyContext ctx) {
136f7325489SJames Wright   PetscFunctionBeginUser;
137f7325489SJames Wright 
138*d949ddfcSJames Wright   if (!ctx) PetscFunctionReturn(PETSC_SUCCESS);
139f7325489SJames Wright 
140f7325489SJames Wright   // Destroy PETSc Objects
141fbcfc4fcSJames Wright   PetscCall(DMDestroy(&ctx->dm_x));
142fbcfc4fcSJames Wright   PetscCall(DMDestroy(&ctx->dm_y));
143fbcfc4fcSJames Wright   PetscCall(VecDestroy(&ctx->X_loc));
144fbcfc4fcSJames Wright   PetscCall(VecDestroy(&ctx->Y_loc));
145f7325489SJames Wright 
146f7325489SJames Wright   // Destroy libCEED Objects
147fbcfc4fcSJames Wright   CeedVectorDestroy(&ctx->x_ceed);
148fbcfc4fcSJames Wright   CeedVectorDestroy(&ctx->y_ceed);
149fbcfc4fcSJames Wright   CeedOperatorDestroy(&ctx->op);
150fbcfc4fcSJames Wright   CeedDestroy(&ctx->ceed);
151f7325489SJames Wright 
152fbcfc4fcSJames Wright   PetscCall(PetscFree(ctx));
153f7325489SJames Wright 
154*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
155f7325489SJames Wright }
156f7325489SJames Wright 
157f7325489SJames Wright /**
158f7325489SJames Wright   @brief Transfer array from PETSc Vec to CeedVector
159f7325489SJames Wright 
160f7325489SJames Wright   @param[in]   X_petsc   PETSc Vec
161f7325489SJames Wright   @param[out]  mem_type  PETSc MemType
162f7325489SJames Wright   @param[out]  x_ceed    CeedVector
163f7325489SJames Wright 
164f7325489SJames Wright   @return An error code: 0 - success, otherwise - failure
165f7325489SJames Wright **/
166f7325489SJames Wright PetscErrorCode VecP2C(Vec X_petsc, PetscMemType *mem_type, CeedVector x_ceed) {
167f7325489SJames Wright   PetscScalar *x;
168f7325489SJames Wright   PetscInt     X_size;
169f7325489SJames Wright   CeedSize     x_size;
170f7325489SJames Wright 
171f7325489SJames Wright   PetscFunctionBeginUser;
172f7325489SJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
173f7325489SJames Wright   CeedVectorGetLength(x_ceed, &x_size);
174f7325489SJames 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",
175f7325489SJames Wright              X_size, x_size);
176f7325489SJames Wright 
177f7325489SJames Wright   PetscCall(VecGetArrayAndMemType(X_petsc, &x, mem_type));
178f7325489SJames Wright   CeedVectorSetArray(x_ceed, MemTypeP2C(*mem_type), CEED_USE_POINTER, x);
179f7325489SJames Wright 
180*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
181f7325489SJames Wright }
182f7325489SJames Wright 
183f7325489SJames Wright /**
184f7325489SJames Wright   @brief Transfer array from CeedVector to PETSc Vec
185f7325489SJames Wright 
186f7325489SJames Wright   @param[in]   x_ceed    CeedVector
187f7325489SJames Wright   @param[in]   mem_type  PETSc MemType
188f7325489SJames Wright   @param[out]  X_petsc   PETSc Vec
189f7325489SJames Wright 
190f7325489SJames Wright   @return An error code: 0 - success, otherwise - failure
191f7325489SJames Wright **/
192f7325489SJames Wright PetscErrorCode VecC2P(CeedVector x_ceed, PetscMemType mem_type, Vec X_petsc) {
193f7325489SJames Wright   PetscScalar *x;
194f7325489SJames Wright   PetscInt     X_size;
195f7325489SJames Wright   CeedSize     x_size;
196f7325489SJames Wright 
197f7325489SJames Wright   PetscFunctionBeginUser;
198f7325489SJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
199f7325489SJames Wright   CeedVectorGetLength(x_ceed, &x_size);
200f7325489SJames 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",
201f7325489SJames Wright              X_size, x_size);
202f7325489SJames Wright 
203f7325489SJames Wright   CeedVectorTakeArray(x_ceed, MemTypeP2C(mem_type), &x);
204f7325489SJames Wright   PetscCall(VecRestoreArrayAndMemType(X_petsc, &x));
205f7325489SJames Wright 
206*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
207f7325489SJames Wright }
208f7325489SJames Wright 
209f7325489SJames Wright /**
210f7325489SJames Wright   @brief Transfer read-only array from PETSc Vec to CeedVector
211f7325489SJames Wright 
212f7325489SJames Wright   @param[in]   X_petsc   PETSc Vec
213f7325489SJames Wright   @param[out]  mem_type  PETSc MemType
214f7325489SJames Wright   @param[out]  x_ceed    CeedVector
215f7325489SJames Wright 
216f7325489SJames Wright   @return An error code: 0 - success, otherwise - failure
217f7325489SJames Wright **/
218f7325489SJames Wright PetscErrorCode VecReadP2C(Vec X_petsc, PetscMemType *mem_type, CeedVector x_ceed) {
219f7325489SJames Wright   PetscScalar *x;
220f7325489SJames Wright   PetscInt     X_size;
221f7325489SJames Wright   CeedSize     x_size;
222f7325489SJames Wright 
223f7325489SJames Wright   PetscFunctionBeginUser;
224f7325489SJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
225f7325489SJames Wright   CeedVectorGetLength(x_ceed, &x_size);
226f7325489SJames 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",
227f7325489SJames Wright              X_size, x_size);
228f7325489SJames Wright 
229f7325489SJames Wright   PetscCall(VecGetArrayReadAndMemType(X_petsc, (const PetscScalar **)&x, mem_type));
230f7325489SJames Wright   CeedVectorSetArray(x_ceed, MemTypeP2C(*mem_type), CEED_USE_POINTER, x);
231f7325489SJames Wright 
232*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
233f7325489SJames Wright }
234f7325489SJames Wright 
235f7325489SJames Wright /**
236f7325489SJames Wright   @brief Transfer read-only array from CeedVector to PETSc Vec
237f7325489SJames Wright 
238f7325489SJames Wright   @param[in]   x_ceed    CeedVector
239f7325489SJames Wright   @param[in]   mem_type  PETSc MemType
240f7325489SJames Wright   @param[out]  X_petsc   PETSc Vec
241f7325489SJames Wright 
242f7325489SJames Wright   @return An error code: 0 - success, otherwise - failure
243f7325489SJames Wright **/
244f7325489SJames Wright PetscErrorCode VecReadC2P(CeedVector x_ceed, PetscMemType mem_type, Vec X_petsc) {
245f7325489SJames Wright   PetscScalar *x;
246f7325489SJames Wright   PetscInt     X_size;
247f7325489SJames Wright   CeedSize     x_size;
248f7325489SJames Wright 
249f7325489SJames Wright   PetscFunctionBeginUser;
250f7325489SJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
251f7325489SJames Wright   CeedVectorGetLength(x_ceed, &x_size);
252f7325489SJames 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",
253f7325489SJames Wright              X_size, x_size);
254f7325489SJames Wright 
255f7325489SJames Wright   CeedVectorTakeArray(x_ceed, MemTypeP2C(mem_type), &x);
256f7325489SJames Wright   PetscCall(VecRestoreArrayReadAndMemType(X_petsc, (const PetscScalar **)&x));
257f7325489SJames Wright 
258*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
259f7325489SJames Wright }
260f7325489SJames Wright 
261f7325489SJames Wright /**
262f7325489SJames Wright   @brief Copy PETSc Vec data into CeedVector
263f7325489SJames Wright 
264f7325489SJames Wright   @param[in]   X_petsc PETSc Vec
265f7325489SJames Wright   @param[out]  x_ceed  CeedVector
266f7325489SJames Wright 
267f7325489SJames Wright   @return An error code: 0 - success, otherwise - failure
268f7325489SJames Wright **/
269f7325489SJames Wright PetscErrorCode VecCopyP2C(Vec X_petsc, CeedVector x_ceed) {
270f7325489SJames Wright   PetscScalar *x;
271f7325489SJames Wright   PetscMemType mem_type;
272f7325489SJames Wright   PetscInt     X_size;
273f7325489SJames Wright   CeedSize     x_size;
274f7325489SJames Wright 
275f7325489SJames Wright   PetscFunctionBeginUser;
276f7325489SJames Wright   PetscCall(VecGetLocalSize(X_petsc, &X_size));
277f7325489SJames Wright   CeedVectorGetLength(x_ceed, &x_size);
278f7325489SJames 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",
279f7325489SJames Wright              X_size, x_size);
280f7325489SJames Wright 
281f7325489SJames Wright   PetscCall(VecGetArrayReadAndMemType(X_petsc, (const PetscScalar **)&x, &mem_type));
282f7325489SJames Wright   CeedVectorSetArray(x_ceed, MemTypeP2C(mem_type), CEED_COPY_VALUES, x);
283f7325489SJames Wright   PetscCall(VecRestoreArrayReadAndMemType(X_petsc, (const PetscScalar **)&x));
284f7325489SJames Wright 
285*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
286f7325489SJames Wright }
287f7325489SJames Wright 
2886cbc221eSJames Wright //@brief Return VecType for the given DM
2896cbc221eSJames Wright VecType DMReturnVecType(DM dm) {
2906cbc221eSJames Wright   VecType vec_type;
2916cbc221eSJames Wright   DMGetVecType(dm, &vec_type);
2926cbc221eSJames Wright   return vec_type;
2936cbc221eSJames Wright }
2946cbc221eSJames Wright 
2956cbc221eSJames Wright /**
2966cbc221eSJames Wright  * @brief Create local PETSc Vecs for CeedOperator's active input/outputs
2976cbc221eSJames Wright  *
2986cbc221eSJames Wright  * This is primarily used for when the active input/ouput vector does not correspond to a `DM` object, and thus `DMCreateLocalVector` or
2996cbc221eSJames Wright  * `DMGetLocalVector` are not applicable.
3006cbc221eSJames Wright  * For example, if statitics are being store at quadrature points, a `DM`-created `Vec` will not have the
3016cbc221eSJames Wright  * correct size.
3026cbc221eSJames Wright  *
3036cbc221eSJames Wright  * @param[in]  dm     DM overwhich the Vecs would be used
3046cbc221eSJames Wright  * @param[in]  op     Operator to make the Vecs for
3056cbc221eSJames Wright  * @param[out] input  Vec for CeedOperator active input
3066cbc221eSJames Wright  * @param[out] output Vec for CeedOperator active output
3076cbc221eSJames Wright  */
3086cbc221eSJames Wright PetscErrorCode CeedOperatorCreateLocalVecs(CeedOperator op, VecType vec_type, MPI_Comm comm, Vec *input, Vec *output) {
3096cbc221eSJames Wright   CeedSize input_size, output_size;
3106cbc221eSJames Wright 
3116cbc221eSJames Wright   PetscFunctionBeginUser;
3126cbc221eSJames Wright   CeedOperatorGetActiveVectorLengths(op, &input_size, &output_size);
3136cbc221eSJames Wright   if (input) {
3146cbc221eSJames Wright     PetscCall(VecCreate(comm, input));
3156cbc221eSJames Wright     PetscCall(VecSetType(*input, vec_type));
3166cbc221eSJames Wright     PetscCall(VecSetSizes(*input, input_size, input_size));
3176cbc221eSJames Wright   }
3186cbc221eSJames Wright   if (output) {
3196cbc221eSJames Wright     PetscCall(VecCreate(comm, output));
3206cbc221eSJames Wright     PetscCall(VecSetType(*output, vec_type));
3216cbc221eSJames Wright     PetscCall(VecSetSizes(*output, output_size, output_size));
3226cbc221eSJames Wright   }
3236cbc221eSJames Wright 
324*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
3256cbc221eSJames Wright }
3266cbc221eSJames Wright 
327f7325489SJames Wright /**
328f7325489SJames Wright  * @brief Apply FEM Operator defined by `OperatorApplyContext` to various input and output vectors
329f7325489SJames Wright  *
3303fc17c4bSJames Wright  * @param[in]     X             Input global `Vec`, maybe `NULL`
3313fc17c4bSJames Wright  * @param[in]     X_loc         Input local `Vec`, maybe `NULL`
3323fc17c4bSJames Wright  * @param[in]     x_ceed        Input `CeedVector`, maybe `CEED_VECTOR_NONE`
3333fc17c4bSJames Wright  * @param[in,out] y_ceed        Output `CeedVector`, maybe `CEED_VECTOR_NONE`
3343fc17c4bSJames Wright  * @param[in,out] Y_loc         Output local `Vec`, maybe `NULL`
3353fc17c4bSJames Wright  * @param[in,out] Y             Output global `Vec`, maybe `NULL`
3363fc17c4bSJames Wright  * @param[in]     ctx           Context for the operator apply
3373fc17c4bSJames Wright  * @param[in]     use_apply_add Whether to use `CeedOperatorApply` or `CeedOperatorApplyAdd`
338f7325489SJames Wright  */
339f7325489SJames Wright PetscErrorCode ApplyCeedOperator_Core(Vec X, Vec X_loc, CeedVector x_ceed, CeedVector y_ceed, Vec Y_loc, Vec Y, OperatorApplyContext ctx,
340f7325489SJames Wright                                       bool use_apply_add) {
341f7325489SJames Wright   PetscMemType x_mem_type, y_mem_type;
342f7325489SJames Wright 
343f7325489SJames Wright   PetscFunctionBeginUser;
344f7325489SJames Wright   if (X) PetscCall(DMGlobalToLocal(ctx->dm_x, X, INSERT_VALUES, X_loc));
345f7325489SJames Wright   if (X_loc) PetscCall(VecReadP2C(X_loc, &x_mem_type, x_ceed));
346f7325489SJames Wright 
347f7325489SJames Wright   if (Y_loc) PetscCall(VecP2C(Y_loc, &y_mem_type, y_ceed));
348f7325489SJames Wright 
3497eedc94cSJames Wright   PetscCall(PetscLogEventBegin(FLUIDS_CeedOperatorApply, X, Y, 0, 0));
3507eedc94cSJames Wright   PetscCall(PetscLogGpuTimeBegin());
351f7325489SJames Wright   if (use_apply_add) CeedOperatorApplyAdd(ctx->op, x_ceed, y_ceed, CEED_REQUEST_IMMEDIATE);
352f7325489SJames Wright   else CeedOperatorApply(ctx->op, x_ceed, y_ceed, CEED_REQUEST_IMMEDIATE);
3537eedc94cSJames Wright   PetscCall(PetscLogGpuTimeEnd());
3547eedc94cSJames Wright   PetscCall(PetscLogEventEnd(FLUIDS_CeedOperatorApply, X, Y, 0, 0));
355f7325489SJames Wright 
356f7325489SJames Wright   if (X_loc) PetscCall(VecReadC2P(ctx->x_ceed, x_mem_type, X_loc));
357f7325489SJames Wright 
358f7325489SJames Wright   if (Y_loc) PetscCall(VecC2P(ctx->y_ceed, y_mem_type, Y_loc));
359f7325489SJames Wright   if (Y) PetscCall(DMLocalToGlobal(ctx->dm_y, Y_loc, ADD_VALUES, Y));
360f7325489SJames Wright 
361*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
362f7325489SJames Wright };
363f7325489SJames Wright 
364f7325489SJames Wright PetscErrorCode ApplyCeedOperatorGlobalToGlobal(Vec X, Vec Y, OperatorApplyContext ctx) {
365f7325489SJames Wright   Vec X_loc = ctx->X_loc, Y_loc = ctx->Y_loc;
366f7325489SJames Wright 
367f7325489SJames Wright   PetscFunctionBeginUser;
368f7325489SJames Wright   PetscCall(VecZeroEntries(Y));
369f7325489SJames Wright 
370f7325489SJames Wright   // Get local vectors (if needed)
371f7325489SJames Wright   if (!ctx->X_loc) PetscCall(DMGetLocalVector(ctx->dm_x, &X_loc));
372f7325489SJames Wright   if (!ctx->Y_loc) PetscCall(DMGetLocalVector(ctx->dm_y, &Y_loc));
373f7325489SJames Wright 
374f7325489SJames Wright   PetscCall(ApplyCeedOperator_Core(X, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, Y, ctx, false));
375f7325489SJames Wright 
376f7325489SJames Wright   // Restore local vector (if needed)
377f7325489SJames Wright   if (!ctx->X_loc) PetscCall(DMRestoreLocalVector(ctx->dm_x, &X_loc));
378f7325489SJames Wright   if (!ctx->Y_loc) PetscCall(DMRestoreLocalVector(ctx->dm_y, &Y_loc));
379f7325489SJames Wright 
380*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
381f7325489SJames Wright }
382f7325489SJames Wright 
383f7325489SJames Wright PetscErrorCode ApplyCeedOperatorLocalToGlobal(Vec X_loc, Vec Y, OperatorApplyContext ctx) {
384f7325489SJames Wright   Vec Y_loc = ctx->Y_loc;
385f7325489SJames Wright 
386f7325489SJames Wright   PetscFunctionBeginUser;
387f7325489SJames Wright   PetscCall(VecZeroEntries(Y));
388f7325489SJames Wright 
389f7325489SJames Wright   // Get local vectors (if needed)
390f7325489SJames Wright   if (!ctx->Y_loc) PetscCall(DMGetLocalVector(ctx->dm_y, &Y_loc));
391f7325489SJames Wright 
392f7325489SJames Wright   PetscCall(ApplyCeedOperator_Core(NULL, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, Y, ctx, false));
393f7325489SJames Wright 
394f7325489SJames Wright   // Restore local vectors (if needed)
395f7325489SJames Wright   if (!ctx->Y_loc) PetscCall(DMRestoreLocalVector(ctx->dm_y, &Y_loc));
396f7325489SJames Wright 
397*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
398f7325489SJames Wright }
399f7325489SJames Wright 
400f7325489SJames Wright PetscErrorCode ApplyCeedOperatorGlobalToLocal(Vec X, Vec Y_loc, OperatorApplyContext ctx) {
401f7325489SJames Wright   Vec X_loc = ctx->X_loc;
402f7325489SJames Wright 
403f7325489SJames Wright   PetscFunctionBeginUser;
404f7325489SJames Wright   // Get local vectors (if needed)
405f7325489SJames Wright   if (!ctx->X_loc) PetscCall(DMGetLocalVector(ctx->dm_x, &X_loc));
406f7325489SJames Wright 
407f7325489SJames Wright   PetscCall(ApplyCeedOperator_Core(X, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, NULL, ctx, false));
408f7325489SJames Wright 
409f7325489SJames Wright   // Restore local vector (if needed)
410f7325489SJames Wright   if (!ctx->X_loc) PetscCall(DMRestoreLocalVector(ctx->dm_x, &X_loc));
411f7325489SJames Wright 
412*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
413f7325489SJames Wright }
414f7325489SJames Wright 
4155ce09d65SJames Wright PetscErrorCode ApplyCeedOperatorLocalToLocal(Vec X_loc, Vec Y_loc, OperatorApplyContext ctx) {
4165ce09d65SJames Wright   PetscFunctionBeginUser;
4175ce09d65SJames Wright   PetscCall(ApplyCeedOperator_Core(NULL, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, NULL, ctx, false));
418*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
4195ce09d65SJames Wright }
4205ce09d65SJames Wright 
421f7325489SJames Wright PetscErrorCode ApplyAddCeedOperatorLocalToLocal(Vec X_loc, Vec Y_loc, OperatorApplyContext ctx) {
422f7325489SJames Wright   PetscFunctionBeginUser;
423f7325489SJames Wright   PetscCall(ApplyCeedOperator_Core(NULL, X_loc, ctx->x_ceed, ctx->y_ceed, Y_loc, NULL, ctx, true));
424*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
425f7325489SJames Wright }
426f7325489SJames Wright 
427f7325489SJames Wright // -----------------------------------------------------------------------------
428f7325489SJames Wright // Wraps the libCEED operator for a MatShell
429f7325489SJames Wright // -----------------------------------------------------------------------------
430f7325489SJames Wright PetscErrorCode MatMult_Ceed(Mat A, Vec X, Vec Y) {
431f7325489SJames Wright   OperatorApplyContext ctx;
432f7325489SJames Wright   PetscFunctionBeginUser;
433f7325489SJames Wright 
434f7325489SJames Wright   PetscCall(MatShellGetContext(A, &ctx));
435f7325489SJames Wright   PetscCall(ApplyCeedOperatorGlobalToGlobal(X, Y, ctx));
436f7325489SJames Wright 
437*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
438f7325489SJames Wright };
439f7325489SJames Wright 
440f7325489SJames Wright // -----------------------------------------------------------------------------
441f7325489SJames Wright // Returns the computed diagonal of the operator
442f7325489SJames Wright // -----------------------------------------------------------------------------
443f7325489SJames Wright PetscErrorCode MatGetDiag_Ceed(Mat A, Vec D) {
444f7325489SJames Wright   OperatorApplyContext ctx;
445f7325489SJames Wright   Vec                  Y_loc;
446f7325489SJames Wright   PetscMemType         mem_type;
447f7325489SJames Wright   PetscFunctionBeginUser;
448f7325489SJames Wright 
449f7325489SJames Wright   PetscCall(MatShellGetContext(A, &ctx));
450f7325489SJames Wright   if (ctx->Y_loc) Y_loc = ctx->Y_loc;
451f7325489SJames Wright   else PetscCall(DMGetLocalVector(ctx->dm_y, &Y_loc));
452f7325489SJames Wright 
453f7325489SJames Wright   // -- Place PETSc vector in libCEED vector
454f7325489SJames Wright   PetscCall(VecP2C(Y_loc, &mem_type, ctx->y_ceed));
455f7325489SJames Wright 
456f7325489SJames Wright   // -- Compute Diagonal
4577eedc94cSJames Wright   PetscCall(PetscLogEventBegin(FLUIDS_CeedOperatorAssembleDiagonal, A, D, 0, 0));
4587eedc94cSJames Wright   PetscCall(PetscLogGpuTimeBegin());
459f7325489SJames Wright   CeedOperatorLinearAssembleDiagonal(ctx->op, ctx->y_ceed, CEED_REQUEST_IMMEDIATE);
4607eedc94cSJames Wright   PetscCall(PetscLogGpuTimeEnd());
4617eedc94cSJames Wright   PetscCall(PetscLogEventEnd(FLUIDS_CeedOperatorAssembleDiagonal, A, D, 0, 0));
462f7325489SJames Wright 
463f7325489SJames Wright   // -- Local-to-Global
464f7325489SJames Wright   PetscCall(VecC2P(ctx->y_ceed, mem_type, Y_loc));
465f7325489SJames Wright   PetscCall(VecZeroEntries(D));
466f7325489SJames Wright   PetscCall(DMLocalToGlobal(ctx->dm_y, Y_loc, ADD_VALUES, D));
467f7325489SJames Wright 
468f7325489SJames Wright   if (!ctx->Y_loc) PetscCall(DMRestoreLocalVector(ctx->dm_y, &Y_loc));
469*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
470f7325489SJames Wright };
471f7325489SJames Wright 
472bb1c79bdSJames Wright /**
473bb1c79bdSJames Wright  * @brief Create PETSc MatShell object for the corresponding OperatorApplyContext
474bb1c79bdSJames Wright  *
475bb1c79bdSJames Wright  * @param[in]  ctx Context that does the action of the operator
476bb1c79bdSJames Wright  * @param[out] mat MatShell for the operator
477bb1c79bdSJames Wright  */
478bb1c79bdSJames Wright PetscErrorCode CreateMatShell_Ceed(OperatorApplyContext ctx, Mat *mat) {
479bb1c79bdSJames Wright   MPI_Comm comm_x = PetscObjectComm((PetscObject)(ctx->dm_x));
480bb1c79bdSJames Wright   MPI_Comm comm_y = PetscObjectComm((PetscObject)(ctx->dm_y));
481bb1c79bdSJames Wright   PetscInt X_loc_size, X_size, Y_size, Y_loc_size;
482bb1c79bdSJames Wright   VecType  X_vec_type, Y_vec_type;
483bb1c79bdSJames Wright 
484bb1c79bdSJames Wright   PetscFunctionBeginUser;
48591933550SJames Wright   PetscCheck(comm_x == comm_y, PETSC_COMM_WORLD, PETSC_ERR_ARG_NOTSAMECOMM, "Input and output DM must have the same comm");
486bb1c79bdSJames Wright 
487bb1c79bdSJames Wright   PetscCall(DMGetGlobalVectorInfo(ctx->dm_x, &X_loc_size, &X_size, &X_vec_type));
488bb1c79bdSJames Wright   PetscCall(DMGetGlobalVectorInfo(ctx->dm_y, &Y_loc_size, &Y_size, &Y_vec_type));
489bb1c79bdSJames Wright 
490bb1c79bdSJames Wright   PetscCall(MatCreateShell(comm_x, Y_loc_size, X_loc_size, Y_size, X_size, ctx, mat));
491bb1c79bdSJames Wright   PetscCall(MatShellSetContextDestroy(*mat, (PetscErrorCode(*)(void *))OperatorApplyContextDestroy));
492bb1c79bdSJames Wright   PetscCall(MatShellSetOperation(*mat, MATOP_MULT, (void (*)(void))MatMult_Ceed));
493bb1c79bdSJames Wright   PetscCall(MatShellSetOperation(*mat, MATOP_GET_DIAGONAL, (void (*)(void))MatGetDiag_Ceed));
494bb1c79bdSJames Wright 
495bb1c79bdSJames 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",
496bb1c79bdSJames Wright              X_vec_type, Y_vec_type);
497bb1c79bdSJames Wright   PetscCall(MatShellSetVecType(*mat, X_vec_type));
498bb1c79bdSJames Wright 
499*d949ddfcSJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
500bb1c79bdSJames Wright }
501bb1c79bdSJames Wright 
502f7325489SJames Wright // -----------------------------------------------------------------------------
503