xref: /libCEED/examples/fluids/src/turb_spanstats.c (revision b8c4711aa4bdbda70b0a477c97782472a01349e7)
1 // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3 //
4 // SPDX-License-Identifier: BSD-2-Clause
5 //
6 // This file is part of CEED:  http://github.com/ceed
7 /// @file
8 /// Functions for setting up and performing statistics collection
9 
10 #include "../qfunctions/turb_spanstats.h"
11 
12 #include <ceed.h>
13 #include <petscdmplex.h>
14 #include <petscsf.h>
15 
16 #include "../include/petsc_ops.h"
17 #include "../navierstokes.h"
18 
19 typedef struct {
20   CeedElemRestriction elem_restr_parent_x, elem_restr_parent_stats, elem_restr_parent_qd, elem_restr_parent_colloc, elem_restr_child_colloc;
21   CeedBasis           basis_x, basis_stats;
22   CeedVector          x_coord, q_data;
23 } *SpanStatsSetupData;
24 
25 PetscErrorCode CreateStatsDM(User user, ProblemData *problem, PetscInt degree) {
26   user->spanstats.num_comp_stats = TURB_NUM_COMPONENTS;
27   PetscReal     domain_min[3], domain_max[3];
28   PetscFE       fe;
29   PetscSection  section;
30   PetscLogStage stage_stats_setup;
31   MPI_Comm      comm = PetscObjectComm((PetscObject)user->dm);
32   PetscFunctionBeginUser;
33 
34   PetscCall(PetscLogStageGetId("Stats Setup", &stage_stats_setup));
35   if (stage_stats_setup == -1) PetscCall(PetscLogStageRegister("Stats Setup", &stage_stats_setup));
36   PetscCall(PetscLogStagePush(stage_stats_setup));
37 
38   // Get spanwise length
39   PetscCall(DMGetBoundingBox(user->dm, domain_min, domain_max));
40   user->spanstats.span_width = domain_max[2] - domain_min[1];
41 
42   {  // Get DM from surface
43     DM          parent_distributed_dm;
44     PetscSF     isoperiodicface;
45     DMLabel     label;
46     PetscMPIInt size;
47 
48     PetscCall(DMPlexGetIsoperiodicFaceSF(user->dm, &isoperiodicface));
49 
50     if (isoperiodicface) {
51       PetscSF         inv_isoperiodicface;
52       PetscInt        nleaves;
53       const PetscInt *ilocal;
54 
55       PetscCall(PetscSFCreateInverseSF(isoperiodicface, &inv_isoperiodicface));
56       PetscCall(PetscSFGetGraph(inv_isoperiodicface, NULL, &nleaves, &ilocal, NULL));
57       PetscCall(DMCreateLabel(user->dm, "Periodic Face"));
58       PetscCall(DMGetLabel(user->dm, "Periodic Face", &label));
59       for (PetscInt i = 0; i < nleaves; i++) {
60         PetscCall(DMLabelSetValue(label, ilocal[i], 1));
61       }
62     } else {
63       PetscCall(DMGetLabel(user->dm, "Face Sets", &label));
64     }
65 
66     PetscCall(DMPlexLabelComplete(user->dm, label));
67     PetscCall(DMPlexFilter(user->dm, label, 1, &user->spanstats.dm));
68     PetscCall(DMProjectCoordinates(user->spanstats.dm, NULL));  // Ensure that a coordinate FE exists
69 
70     PetscCall(DMPlexDistribute(user->spanstats.dm, 0, NULL, &parent_distributed_dm));
71     PetscCallMPI(MPI_Comm_size(comm, &size));
72     if (parent_distributed_dm) {
73       PetscCall(DMDestroy(&user->spanstats.dm));
74       user->spanstats.dm = parent_distributed_dm;
75     } else if (size > 1) {
76       PetscCall(PetscPrintf(comm, "WARNING: Turbulent spanwise statistics: parent DM could not be distributed accross %d ranks.\n", size));
77     }
78   }
79 
80   PetscCall(PetscObjectSetName((PetscObject)user->spanstats.dm, "Spanwise_Stats"));
81   PetscCall(DMSetOptionsPrefix(user->spanstats.dm, "turbulence_spanstats_"));
82   PetscCall(DMSetFromOptions(user->spanstats.dm));
83   PetscCall(DMViewFromOptions(user->spanstats.dm, NULL, "-dm_view"));
84 
85   // Create FE space for parent DM
86   PetscCall(PetscFECreateLagrange(PETSC_COMM_SELF, problem->dim - 1, user->spanstats.num_comp_stats, PETSC_FALSE, degree, PETSC_DECIDE, &fe));
87   PetscCall(PetscObjectSetName((PetscObject)fe, "stats"));
88   PetscCall(DMAddField(user->spanstats.dm, NULL, (PetscObject)fe));
89   PetscCall(DMCreateDS(user->spanstats.dm));
90   PetscCall(DMPlexSetClosurePermutationTensor(user->spanstats.dm, PETSC_DETERMINE, NULL));
91 
92   // Create Section for data
93   PetscCall(DMGetLocalSection(user->spanstats.dm, &section));
94   PetscCall(PetscSectionSetFieldName(section, 0, ""));
95   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_DENSITY, "MeanDensity"));
96   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_PRESSURE, "MeanPressure"));
97   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_PRESSURE_SQUARED, "MeanPressureSquared"));
98   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_PRESSURE_VELOCITY_X, "MeanPressureVelocityX"));
99   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_PRESSURE_VELOCITY_Y, "MeanPressureVelocityY"));
100   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_PRESSURE_VELOCITY_Z, "MeanPressureVelocityZ"));
101   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_DENSITY_TEMPERATURE, "MeanDensityTemperature"));
102   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_DENSITY_TEMPERATURE_FLUX_X, "MeanDensityTemperatureFluxX"));
103   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_DENSITY_TEMPERATURE_FLUX_Y, "MeanDensityTemperatureFluxY"));
104   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_DENSITY_TEMPERATURE_FLUX_Z, "MeanDensityTemperatureFluxZ"));
105   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUM_X, "MeanMomentumX"));
106   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUM_Y, "MeanMomentumY"));
107   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUM_Z, "MeanMomentumZ"));
108   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUMFLUX_XX, "MeanMomentumFluxXX"));
109   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUMFLUX_YY, "MeanMomentumFluxYY"));
110   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUMFLUX_ZZ, "MeanMomentumFluxZZ"));
111   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUMFLUX_YZ, "MeanMomentumFluxYZ"));
112   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUMFLUX_XZ, "MeanMomentumFluxXZ"));
113   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_MOMENTUMFLUX_XY, "MeanMomentumFluxXY"));
114   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_VELOCITY_X, "MeanVelocityX"));
115   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_VELOCITY_Y, "MeanVelocityY"));
116   PetscCall(PetscSectionSetComponentName(section, 0, TURB_MEAN_VELOCITY_Z, "MeanVelocityZ"));
117 
118   // Cleanup
119   PetscCall(PetscFEDestroy(&fe));
120 
121   PetscCall(PetscLogStagePop());
122   PetscFunctionReturn(PETSC_SUCCESS);
123 }
124 
125 // Create CeedElemRestriction for collocated data based on associated CeedBasis and CeedElemRestriction
126 // Number of quadrature points is used from the CeedBasis, and number of elements is used from the CeedElemRestriction
127 PetscErrorCode CreateElemRestrColloc(Ceed ceed, CeedInt num_comp, CeedBasis basis, CeedElemRestriction elem_restr_base,
128                                      CeedElemRestriction *elem_restr_collocated) {
129   CeedInt num_elem_qpts, loc_num_elem;
130   PetscFunctionBeginUser;
131 
132   CeedBasisGetNumQuadraturePoints(basis, &num_elem_qpts);
133   CeedElemRestrictionGetNumElements(elem_restr_base, &loc_num_elem);
134 
135   const CeedInt strides[] = {num_comp, 1, num_elem_qpts * num_comp};
136   CeedElemRestrictionCreateStrided(ceed, loc_num_elem, num_elem_qpts, num_comp, num_comp * loc_num_elem * num_elem_qpts, strides,
137                                    elem_restr_collocated);
138   PetscFunctionReturn(PETSC_SUCCESS);
139 }
140 
141 // Get coordinates of quadrature points
142 PetscErrorCode GetQuadratureCoords(Ceed ceed, DM dm, CeedElemRestriction elem_restr_x, CeedBasis basis_x, CeedVector x_coords, Vec *Qx_coords,
143                                    PetscInt *total_nqpnts) {
144   CeedElemRestriction  elem_restr_qx;
145   CeedQFunction        qf_quad_coords;
146   CeedOperator         op_quad_coords;
147   CeedInt              num_comp_x, loc_num_elem, num_elem_qpts;
148   OperatorApplyContext op_quad_coords_ctx;
149 
150   PetscFunctionBeginUser;
151   // Create Element Restriction and CeedVector for quadrature coordinates
152   CeedBasisGetNumQuadraturePoints(basis_x, &num_elem_qpts);
153   CeedElemRestrictionGetNumElements(elem_restr_x, &loc_num_elem);
154   CeedElemRestrictionGetNumComponents(elem_restr_x, &num_comp_x);
155   *total_nqpnts = num_elem_qpts * loc_num_elem;
156   PetscCall(CreateElemRestrColloc(ceed, num_comp_x, basis_x, elem_restr_x, &elem_restr_qx));
157 
158   // Create QFunction
159   CeedQFunctionCreateIdentity(ceed, num_comp_x, CEED_EVAL_INTERP, CEED_EVAL_NONE, &qf_quad_coords);
160 
161   // Create Operator
162   CeedOperatorCreate(ceed, qf_quad_coords, NULL, NULL, &op_quad_coords);
163   CeedOperatorSetField(op_quad_coords, "input", elem_restr_x, basis_x, x_coords);
164   CeedOperatorSetField(op_quad_coords, "output", elem_restr_qx, CEED_BASIS_COLLOCATED, CEED_VECTOR_ACTIVE);
165 
166   PetscCall(CeedOperatorCreateLocalVecs(op_quad_coords, DMReturnVecType(dm), PetscObjectComm((PetscObject)dm), NULL, Qx_coords));
167   PetscCall(OperatorApplyContextCreate(NULL, NULL, ceed, op_quad_coords, CEED_VECTOR_NONE, NULL, NULL, NULL, &op_quad_coords_ctx));
168 
169   PetscCall(ApplyCeedOperatorLocalToLocal(NULL, *Qx_coords, op_quad_coords_ctx));
170 
171   PetscCall(OperatorApplyContextDestroy(op_quad_coords_ctx));
172   CeedElemRestrictionDestroy(&elem_restr_qx);
173   CeedQFunctionDestroy(&qf_quad_coords);
174   CeedOperatorDestroy(&op_quad_coords);
175   PetscFunctionReturn(PETSC_SUCCESS);
176 }
177 
178 PetscErrorCode SpanStatsSetupDataCreate(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem, SpanStatsSetupData *stats_data) {
179   DM       dm = user->spanstats.dm;
180   PetscInt dim;
181   CeedInt  num_qpts_child1d, num_comp_x, num_comp_stats = user->spanstats.num_comp_stats;
182   Vec      X_loc;
183   PetscFunctionBeginUser;
184 
185   PetscCall(PetscNew(stats_data));
186 
187   PetscCall(DMGetDimension(dm, &dim));
188   CeedBasisGetNumQuadraturePoints1D(ceed_data->basis_q, &num_qpts_child1d);
189   CeedInt num_qpts_parent = CeedIntPow(num_qpts_child1d, dim);
190   PetscCall(GetRestrictionForDomain(ceed, dm, 0, 0, 0, 0, num_qpts_parent, problem->q_data_size_sur, &(*stats_data)->elem_restr_parent_stats,
191                                     &(*stats_data)->elem_restr_parent_x, &(*stats_data)->elem_restr_parent_qd));
192   CeedElemRestrictionGetNumComponents((*stats_data)->elem_restr_parent_x, &num_comp_x);
193   CeedElemRestrictionCreateVector((*stats_data)->elem_restr_parent_x, &(*stats_data)->x_coord, NULL);
194   CeedElemRestrictionCreateVector((*stats_data)->elem_restr_parent_qd, &(*stats_data)->q_data, NULL);
195 
196   {
197     DM dm_coord;
198     PetscCall(DMGetCoordinateDM(dm, &dm_coord));
199     PetscCall(CreateBasisFromPlex(ceed, dm_coord, 0, 0, 0, 0, &(*stats_data)->basis_x));
200     PetscCall(CreateBasisFromPlex(ceed, dm, 0, 0, 0, 0, &(*stats_data)->basis_stats));
201   }
202 
203   PetscCall(CreateElemRestrColloc(ceed, num_comp_stats, (*stats_data)->basis_stats, (*stats_data)->elem_restr_parent_stats,
204                                   &(*stats_data)->elem_restr_parent_colloc));
205   PetscCall(CreateElemRestrColloc(ceed, num_comp_stats, ceed_data->basis_q, ceed_data->elem_restr_q, &(*stats_data)->elem_restr_child_colloc));
206 
207   {  // -- Copy DM coordinates into CeedVector
208     DM cdm;
209     PetscCall(DMGetCellCoordinateDM(dm, &cdm));
210     if (cdm) {
211       PetscCall(DMGetCellCoordinatesLocal(dm, &X_loc));
212     } else {
213       PetscCall(DMGetCoordinatesLocal(dm, &X_loc));
214     }
215   }
216   PetscCall(VecScale(X_loc, problem->dm_scale));
217   PetscCall(VecCopyP2C(X_loc, (*stats_data)->x_coord));
218 
219   PetscFunctionReturn(PETSC_SUCCESS);
220 }
221 
222 PetscErrorCode SpanStatsSetupDataDestroy(SpanStatsSetupData data) {
223   PetscFunctionBeginUser;
224 
225   CeedElemRestrictionDestroy(&data->elem_restr_parent_x);
226   CeedElemRestrictionDestroy(&data->elem_restr_parent_stats);
227   CeedElemRestrictionDestroy(&data->elem_restr_parent_qd);
228   CeedElemRestrictionDestroy(&data->elem_restr_parent_colloc);
229   CeedElemRestrictionDestroy(&data->elem_restr_child_colloc);
230 
231   CeedBasisDestroy(&data->basis_x);
232   CeedBasisDestroy(&data->basis_stats);
233 
234   CeedVectorDestroy(&data->x_coord);
235   CeedVectorDestroy(&data->q_data);
236 
237   PetscCall(PetscFree(data));
238   PetscFunctionReturn(PETSC_SUCCESS);
239 }
240 
241 // Create PetscSF for child-to-parent communication
242 PetscErrorCode CreateStatsSF(Ceed ceed, CeedData ceed_data, SpanStatsSetupData stats_data, DM parentdm, DM childdm, PetscSF *statssf) {
243   PetscInt child_num_qpnts, parent_num_qpnts;
244   CeedInt  num_comp_x;
245   Vec      Child_qx_coords, Parent_qx_coords;
246 
247   PetscFunctionBeginUser;
248   PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)childdm), statssf));
249 
250   // Assume that child and parent have the same number of components
251   CeedBasisGetNumComponents(ceed_data->basis_x, &num_comp_x);
252   const PetscInt num_comp_sf = num_comp_x - 1;  // Number of coord components used in the creation of the SF
253 
254   // Get quad_coords for child and parent DM
255   PetscCall(GetQuadratureCoords(ceed, childdm, ceed_data->elem_restr_x, ceed_data->basis_x, ceed_data->x_coord, &Child_qx_coords, &child_num_qpnts));
256   PetscCall(GetQuadratureCoords(ceed, parentdm, stats_data->elem_restr_parent_x, stats_data->basis_x, stats_data->x_coord, &Parent_qx_coords,
257                                 &parent_num_qpnts));
258 
259   {  // Remove z component of coordinates for matching
260     const PetscReal *child_quad_coords, *parent_quad_coords;
261     PetscReal       *child_coords, *parent_coords;
262 
263     PetscCall(VecGetArrayRead(Child_qx_coords, &child_quad_coords));
264     PetscCall(VecGetArrayRead(Parent_qx_coords, &parent_quad_coords));
265 
266     PetscCall(PetscMalloc2(child_num_qpnts * 2, &child_coords, parent_num_qpnts * 2, &parent_coords));
267     for (int i = 0; i < child_num_qpnts; i++) {
268       child_coords[0 + i * num_comp_sf] = child_quad_coords[0 + i * num_comp_x];
269       child_coords[1 + i * num_comp_sf] = child_quad_coords[1 + i * num_comp_x];
270     }
271     for (int i = 0; i < parent_num_qpnts; i++) {
272       parent_coords[0 + i * num_comp_sf] = parent_quad_coords[0 + i * num_comp_x];
273       parent_coords[1 + i * num_comp_sf] = parent_quad_coords[1 + i * num_comp_x];
274     }
275     PetscCall(VecRestoreArrayRead(Child_qx_coords, &child_quad_coords));
276     PetscCall(VecRestoreArrayRead(Parent_qx_coords, &parent_quad_coords));
277 
278     PetscCall(PetscSFSetGraphFromCoordinates(*statssf, parent_num_qpnts, child_num_qpnts, num_comp_sf, 1e-12, parent_coords, child_coords));
279     PetscCall(PetscFree2(child_coords, parent_coords));
280   }
281 
282   PetscCall(PetscSFViewFromOptions(*statssf, NULL, "-spanstats_sf_view"));
283 
284   PetscCall(VecDestroy(&Child_qx_coords));
285   PetscCall(VecDestroy(&Parent_qx_coords));
286   PetscFunctionReturn(PETSC_SUCCESS);
287 }
288 
289 // @brief Setup RHS and LHS for L^2 projection of statistics
290 PetscErrorCode SetupL2ProjectionStats(Ceed ceed, User user, CeedData ceed_data, SpanStatsSetupData stats_data) {
291   CeedOperator  op_mass, op_setup_sur, op_proj_rhs;
292   CeedQFunction qf_mass, qf_stats_proj;
293   CeedInt       q_data_size, num_comp_stats = user->spanstats.num_comp_stats;
294   MPI_Comm      comm = PetscObjectComm((PetscObject)user->spanstats.dm);
295 
296   PetscFunctionBeginUser;
297   // -- Create Operator for RHS of L^2 projection of statistics
298   // Simply take collocated parent data (with quadrature weight already applied) and multiply by weight function.
299   // Therefore, an Identity QF is sufficient
300   CeedQFunctionCreateIdentity(ceed, num_comp_stats, CEED_EVAL_NONE, CEED_EVAL_INTERP, &qf_stats_proj);
301 
302   CeedOperatorCreate(ceed, qf_stats_proj, NULL, NULL, &op_proj_rhs);
303   CeedOperatorSetField(op_proj_rhs, "input", stats_data->elem_restr_parent_colloc, CEED_BASIS_COLLOCATED, CEED_VECTOR_ACTIVE);
304   CeedOperatorSetField(op_proj_rhs, "output", stats_data->elem_restr_parent_stats, stats_data->basis_stats, CEED_VECTOR_ACTIVE);
305 
306   PetscCall(OperatorApplyContextCreate(NULL, user->spanstats.dm, ceed, op_proj_rhs, NULL, NULL, NULL, NULL, &user->spanstats.op_proj_rhs_ctx));
307   PetscCall(CeedOperatorCreateLocalVecs(op_proj_rhs, DMReturnVecType(user->spanstats.dm), comm, &user->spanstats.Parent_Stats_loc, NULL));
308 
309   // -- Setup LHS of L^2 projection
310   // Get q_data for mass matrix operator
311   CeedOperatorCreate(ceed, ceed_data->qf_setup_sur, NULL, NULL, &op_setup_sur);
312   CeedOperatorSetField(op_setup_sur, "dx", stats_data->elem_restr_parent_x, stats_data->basis_x, CEED_VECTOR_ACTIVE);
313   CeedOperatorSetField(op_setup_sur, "weight", CEED_ELEMRESTRICTION_NONE, stats_data->basis_x, CEED_VECTOR_NONE);
314   CeedOperatorSetField(op_setup_sur, "surface qdata", stats_data->elem_restr_parent_qd, CEED_BASIS_COLLOCATED, CEED_VECTOR_ACTIVE);
315   CeedOperatorApply(op_setup_sur, stats_data->x_coord, stats_data->q_data, CEED_REQUEST_IMMEDIATE);
316 
317   // CEED Restriction
318   CeedElemRestrictionGetNumComponents(stats_data->elem_restr_parent_qd, &q_data_size);
319 
320   // Create Mass CeedOperator
321   PetscCall(CreateMassQFunction(ceed, num_comp_stats, q_data_size, &qf_mass));
322   CeedOperatorCreate(ceed, qf_mass, NULL, NULL, &op_mass);
323   CeedOperatorSetField(op_mass, "u", stats_data->elem_restr_parent_stats, stats_data->basis_stats, CEED_VECTOR_ACTIVE);
324   CeedOperatorSetField(op_mass, "qdata", stats_data->elem_restr_parent_qd, CEED_BASIS_COLLOCATED, stats_data->q_data);
325   CeedOperatorSetField(op_mass, "v", stats_data->elem_restr_parent_stats, stats_data->basis_stats, CEED_VECTOR_ACTIVE);
326 
327   {  // Setup KSP for L^2 projection
328     OperatorApplyContext M_ctx;
329     Mat                  mat_mass;
330     KSP                  ksp;
331 
332     PetscCall(OperatorApplyContextCreate(user->spanstats.dm, user->spanstats.dm, user->ceed, op_mass, NULL, NULL, NULL, NULL, &M_ctx));
333     PetscCall(CreateMatShell_Ceed(M_ctx, &mat_mass));
334 
335     PetscCall(KSPCreate(comm, &ksp));
336     PetscCall(KSPSetOptionsPrefix(ksp, "turbulence_spanstats_"));
337     {
338       PC pc;
339       PetscCall(KSPGetPC(ksp, &pc));
340       PetscCall(PCSetType(pc, PCJACOBI));
341       PetscCall(PCJacobiSetType(pc, PC_JACOBI_DIAGONAL));
342       PetscCall(KSPSetType(ksp, KSPCG));
343       PetscCall(KSPSetNormType(ksp, KSP_NORM_NATURAL));
344       PetscCall(KSPSetTolerances(ksp, 1e-10, PETSC_DEFAULT, PETSC_DEFAULT, PETSC_DEFAULT));
345     }
346     PetscCall(KSPSetOperators(ksp, mat_mass, mat_mass));
347     PetscCall(KSPSetFromOptions(ksp));
348     user->spanstats.ksp = ksp;
349   }
350 
351   // Cleanup
352   CeedQFunctionDestroy(&qf_mass);
353   CeedQFunctionDestroy(&qf_stats_proj);
354   CeedOperatorDestroy(&op_mass);
355   CeedOperatorDestroy(&op_setup_sur);
356   CeedOperatorDestroy(&op_proj_rhs);
357   PetscFunctionReturn(PETSC_SUCCESS);
358 }
359 
360 // Create CeedOperator for statistics collection
361 PetscErrorCode CreateStatisticCollectionOperator(Ceed ceed, User user, CeedData ceed_data, SpanStatsSetupData stats_data, ProblemData *problem) {
362   CeedInt                     num_comp_stats = user->spanstats.num_comp_stats, num_comp_x = problem->dim, num_comp_q;
363   Turbulence_SpanStatsContext collect_ctx;
364   NewtonianIdealGasContext    newtonian_ig_ctx;
365   CeedQFunctionContext        collect_context;
366   CeedQFunction               qf_stats_collect;
367   CeedOperator                op_stats_collect;
368 
369   PetscFunctionBeginUser;
370   CeedBasisGetNumComponents(ceed_data->basis_q, &num_comp_q);
371 
372   // Create Operator for statistics collection
373   switch (user->phys->state_var) {
374     case STATEVAR_PRIMITIVE:
375       CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_Prim, ChildStatsCollection_Prim_loc, &qf_stats_collect);
376       break;
377     case STATEVAR_CONSERVATIVE:
378       CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_Conserv, ChildStatsCollection_Conserv_loc, &qf_stats_collect);
379       break;
380     default:
381       SETERRQ(PetscObjectComm((PetscObject)user->dm), PETSC_ERR_SUP, "No statisics collection available for chosen state variable");
382   }
383 
384   if (user->spanstats.do_mms_test) {
385     CeedQFunctionDestroy(&qf_stats_collect);
386     CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollectionMMSTest, ChildStatsCollectionMMSTest_loc, &qf_stats_collect);
387   }
388 
389   {  // Setup Collection Context
390     PetscCall(PetscNew(&collect_ctx));
391     CeedQFunctionContextGetData(problem->apply_vol_rhs.qfunction_context, CEED_MEM_HOST, &newtonian_ig_ctx);
392     collect_ctx->gas = *newtonian_ig_ctx;
393 
394     CeedQFunctionContextCreate(user->ceed, &collect_context);
395     CeedQFunctionContextSetData(collect_context, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*collect_ctx), collect_ctx);
396     CeedQFunctionContextSetDataDestroy(collect_context, CEED_MEM_HOST, FreeContextPetsc);
397 
398     CeedQFunctionContextRegisterDouble(collect_context, "solution time", offsetof(struct Turbulence_SpanStatsContext_, solution_time), 1,
399                                        "Current solution time");
400     CeedQFunctionContextRegisterDouble(collect_context, "previous time", offsetof(struct Turbulence_SpanStatsContext_, previous_time), 1,
401                                        "Previous time statistics collection was done");
402 
403     CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfunction_context, &newtonian_ig_ctx);
404   }
405 
406   CeedQFunctionSetContext(qf_stats_collect, collect_context);
407   CeedQFunctionContextDestroy(&collect_context);
408   CeedQFunctionAddInput(qf_stats_collect, "q", num_comp_q, CEED_EVAL_INTERP);
409   CeedQFunctionAddInput(qf_stats_collect, "q_data", problem->q_data_size_vol, CEED_EVAL_NONE);
410   CeedQFunctionAddInput(qf_stats_collect, "x", num_comp_x, CEED_EVAL_INTERP);
411   CeedQFunctionAddOutput(qf_stats_collect, "v", num_comp_stats, CEED_EVAL_NONE);
412 
413   CeedOperatorCreate(ceed, qf_stats_collect, NULL, NULL, &op_stats_collect);
414   CeedOperatorSetField(op_stats_collect, "q", ceed_data->elem_restr_q, ceed_data->basis_q, CEED_VECTOR_ACTIVE);
415   CeedOperatorSetField(op_stats_collect, "q_data", ceed_data->elem_restr_qd_i, CEED_BASIS_COLLOCATED, ceed_data->q_data);
416   CeedOperatorSetField(op_stats_collect, "x", ceed_data->elem_restr_x, ceed_data->basis_x, ceed_data->x_coord);
417   CeedOperatorSetField(op_stats_collect, "v", stats_data->elem_restr_child_colloc, CEED_BASIS_COLLOCATED, CEED_VECTOR_ACTIVE);
418 
419   CeedOperatorGetContextFieldLabel(op_stats_collect, "solution time", &user->spanstats.solution_time_label);
420   CeedOperatorGetContextFieldLabel(op_stats_collect, "previous time", &user->spanstats.previous_time_label);
421 
422   PetscCall(OperatorApplyContextCreate(user->dm, user->spanstats.dm, user->ceed, op_stats_collect, user->q_ceed, NULL, NULL, NULL,
423                                        &user->spanstats.op_stats_collect_ctx));
424 
425   PetscCall(CeedOperatorCreateLocalVecs(op_stats_collect, DMReturnVecType(user->spanstats.dm), PetscObjectComm((PetscObject)user->spanstats.dm), NULL,
426                                         &user->spanstats.Child_Stats_loc));
427   PetscCall(VecZeroEntries(user->spanstats.Child_Stats_loc));
428 
429   CeedQFunctionDestroy(&qf_stats_collect);
430   CeedOperatorDestroy(&op_stats_collect);
431   PetscFunctionReturn(PETSC_SUCCESS);
432 }
433 
434 // Creates operator for calculating error of method of manufactured solution (MMS) test
435 PetscErrorCode SetupMMSErrorChecking(Ceed ceed, User user, CeedData ceed_data, SpanStatsSetupData stats_data) {
436   CeedInt       num_comp_stats = user->spanstats.num_comp_stats, num_comp_x, q_data_size;
437   CeedQFunction qf_error;
438   CeedOperator  op_error;
439   CeedVector    x_ceed, y_ceed;
440   PetscFunctionBeginUser;
441 
442   CeedElemRestrictionGetNumComponents(stats_data->elem_restr_parent_qd, &q_data_size);
443   CeedBasisGetNumComponents(stats_data->basis_x, &num_comp_x);
444 
445   CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollectionMMSTest_Error, ChildStatsCollectionMMSTest_Error_loc, &qf_error);
446   CeedQFunctionAddInput(qf_error, "q", num_comp_stats, CEED_EVAL_INTERP);
447   CeedQFunctionAddInput(qf_error, "qdata", q_data_size, CEED_EVAL_NONE);
448   CeedQFunctionAddInput(qf_error, "x", num_comp_x, CEED_EVAL_INTERP);
449   CeedQFunctionAddOutput(qf_error, "v", num_comp_stats, CEED_EVAL_INTERP);
450 
451   CeedOperatorCreate(ceed, qf_error, NULL, NULL, &op_error);
452   CeedOperatorSetField(op_error, "q", stats_data->elem_restr_parent_stats, stats_data->basis_stats, CEED_VECTOR_ACTIVE);
453   CeedOperatorSetField(op_error, "qdata", stats_data->elem_restr_parent_qd, CEED_BASIS_COLLOCATED, stats_data->q_data);
454   CeedOperatorSetField(op_error, "x", stats_data->elem_restr_parent_x, stats_data->basis_x, stats_data->x_coord);
455   CeedOperatorSetField(op_error, "v", stats_data->elem_restr_parent_stats, stats_data->basis_stats, CEED_VECTOR_ACTIVE);
456 
457   CeedElemRestrictionCreateVector(stats_data->elem_restr_parent_stats, &x_ceed, NULL);
458   CeedElemRestrictionCreateVector(stats_data->elem_restr_parent_stats, &y_ceed, NULL);
459   PetscCall(OperatorApplyContextCreate(user->spanstats.dm, user->spanstats.dm, user->ceed, op_error, x_ceed, y_ceed, NULL, NULL,
460                                        &user->spanstats.mms_error_ctx));
461 
462   CeedOperatorDestroy(&op_error);
463   CeedQFunctionDestroy(&qf_error);
464   CeedVectorDestroy(&x_ceed);
465   CeedVectorDestroy(&y_ceed);
466   PetscFunctionReturn(PETSC_SUCCESS);
467 }
468 
469 // Setup for statistics collection
470 PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem) {
471   SpanStatsSetupData stats_data;
472   PetscLogStage      stage_stats_setup;
473 
474   PetscFunctionBeginUser;
475   PetscCall(PetscLogStageGetId("Stats Setup", &stage_stats_setup));
476   if (stage_stats_setup == -1) PetscCall(PetscLogStageRegister("Stats Setup", &stage_stats_setup));
477   PetscCall(PetscLogStagePush(stage_stats_setup));
478 
479   // Create parent DM
480   PetscCall(CreateStatsDM(user, problem, user->app_ctx->degree));
481 
482   // Create necessary CeedObjects for setting up statistics
483   PetscCall(SpanStatsSetupDataCreate(ceed, user, ceed_data, problem, &stats_data));
484 
485   // Create SF for communicating child data back their respective parents
486   PetscCall(CreateStatsSF(ceed, ceed_data, stats_data, user->dm, user->spanstats.dm, &user->spanstats.sf));
487 
488   // Create CeedOperators for statistics collection
489   PetscCall(CreateStatisticCollectionOperator(ceed, user, ceed_data, stats_data, problem));
490 
491   // Setup KSP and Mat for L^2 projection of statistics
492   PetscCall(SetupL2ProjectionStats(ceed, user, ceed_data, stats_data));
493 
494   PetscCall(PetscOptionsGetBool(NULL, NULL, "-ts_monitor_turbulence_spanstats_mms", &user->spanstats.do_mms_test, NULL));
495   if (user->spanstats.do_mms_test) {
496     PetscCall(SetupMMSErrorChecking(ceed, user, ceed_data, stats_data));
497   }
498 
499   {  // Setup stats viewer with prefix
500     PetscViewerType viewer_type;
501     PetscCall(PetscViewerGetType(user->app_ctx->turb_spanstats_viewer, &viewer_type));
502     PetscCall(PetscOptionsSetValue(NULL, "-ts_monitor_turbulence_spanstats_viewer_type", viewer_type));
503 
504     PetscCall(PetscViewerSetOptionsPrefix(user->app_ctx->turb_spanstats_viewer, "ts_monitor_turbulence_spanstats_"));
505     PetscCall(PetscViewerSetFromOptions(user->app_ctx->turb_spanstats_viewer));
506   }
507 
508   PetscCall(SpanStatsSetupDataDestroy(stats_data));
509   PetscCall(PetscLogStagePop());
510   PetscFunctionReturn(PETSC_SUCCESS);
511 }
512 
513 // Collect statistics based on the solution Q
514 PetscErrorCode CollectStatistics(User user, PetscScalar solution_time, Vec Q) {
515   Span_Stats user_stats = user->spanstats;
516 
517   PetscFunctionBeginUser;
518   PetscLogStage stage_stats_collect;
519   PetscCall(PetscLogStageGetId("Stats Collect", &stage_stats_collect));
520   if (stage_stats_collect == -1) PetscCall(PetscLogStageRegister("Stats Collect", &stage_stats_collect));
521   PetscCall(PetscLogStagePush(stage_stats_collect));
522 
523   PetscCall(UpdateBoundaryValues(user, user->Q_loc, solution_time));
524   CeedOperatorSetContextDouble(user_stats.op_stats_collect_ctx->op, user_stats.solution_time_label, &solution_time);
525   PetscCall(DMGlobalToLocal(user->dm, Q, INSERT_VALUES, user->Q_loc));
526   PetscCall(ApplyAddCeedOperatorLocalToLocal(user->Q_loc, user_stats.Child_Stats_loc, user_stats.op_stats_collect_ctx));
527 
528   CeedOperatorSetContextDouble(user_stats.op_stats_collect_ctx->op, user_stats.previous_time_label, &solution_time);
529 
530   PetscCall(PetscLogStagePop());
531   PetscFunctionReturn(PETSC_SUCCESS);
532 }
533 
534 // Process the child statistics into parent statistics and project them onto stats
535 PetscErrorCode ProcessStatistics(User user, Vec stats) {
536   Span_Stats         user_stats = user->spanstats;
537   const PetscScalar *child_stats;
538   PetscScalar       *parent_stats;
539   MPI_Datatype       unit;
540   Vec                RHS;
541 
542   PetscFunctionBeginUser;
543   PetscLogStage stage_stats_process;
544   PetscCall(PetscLogStageGetId("Stats Process", &stage_stats_process));
545   if (stage_stats_process == -1) PetscCall(PetscLogStageRegister("Stats Process", &stage_stats_process));
546   PetscCall(PetscLogStagePush(stage_stats_process));
547 
548   PetscCall(VecZeroEntries(user_stats.Parent_Stats_loc));
549 
550   PetscCall(VecGetArrayRead(user_stats.Child_Stats_loc, &child_stats));
551   PetscCall(VecGetArray(user_stats.Parent_Stats_loc, &parent_stats));
552 
553   if (user_stats.num_comp_stats == 1) unit = MPIU_REAL;
554   else {
555     PetscCallMPI(MPI_Type_contiguous(user_stats.num_comp_stats, MPIU_REAL, &unit));
556     PetscCallMPI(MPI_Type_commit(&unit));
557   }
558 
559   PetscCall(PetscSFReduceBegin(user_stats.sf, unit, child_stats, parent_stats, MPI_SUM));
560   PetscCall(PetscSFReduceEnd(user_stats.sf, unit, child_stats, parent_stats, MPI_SUM));
561 
562   PetscCall(VecRestoreArrayRead(user_stats.Child_Stats_loc, &child_stats));
563   PetscCall(VecRestoreArray(user_stats.Parent_Stats_loc, &parent_stats));
564   PetscCallMPI(MPI_Type_free(&unit));
565 
566   PetscReal solution_time;
567   PetscCall(DMGetOutputSequenceNumber(user_stats.dm, NULL, &solution_time));
568   PetscReal summing_duration = solution_time - user->app_ctx->cont_time;
569   PetscCall(VecScale(user_stats.Parent_Stats_loc, 1 / (summing_duration * user_stats.span_width)));
570 
571   // L^2 projection with the parent_data
572   PetscCall(DMGetGlobalVector(user_stats.dm, &RHS));
573   PetscCall(ApplyCeedOperatorLocalToGlobal(user_stats.Parent_Stats_loc, RHS, user_stats.op_proj_rhs_ctx));
574 
575   PetscCall(KSPSolve(user_stats.ksp, RHS, stats));
576 
577   PetscCall(DMRestoreGlobalVector(user_stats.dm, &RHS));
578   PetscCall(PetscLogStagePop());
579   PetscFunctionReturn(PETSC_SUCCESS);
580 }
581 
582 // TSMonitor for the statistics collection and processing
583 PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx) {
584   User              user = (User)ctx;
585   Vec               stats;
586   TSConvergedReason reason;
587   PetscInt collect_interval = user->app_ctx->turb_spanstats_collect_interval, viewer_interval = user->app_ctx->turb_spanstats_viewer_interval;
588   PetscFunctionBeginUser;
589   PetscCall(TSGetConvergedReason(ts, &reason));
590   // Do not collect or process on the first step of the run (ie. on the initial condition)
591   if (steps == user->app_ctx->cont_steps && reason == TS_CONVERGED_ITERATING) PetscFunctionReturn(PETSC_SUCCESS);
592 
593   PetscBool run_processing_and_viewer = (steps % viewer_interval == 0 && viewer_interval != -1) || reason != TS_CONVERGED_ITERATING;
594 
595   if (steps % collect_interval == 0 || run_processing_and_viewer) {
596     PetscCall(CollectStatistics(user, solution_time, Q));
597 
598     if (run_processing_and_viewer) {
599       PetscCall(DMSetOutputSequenceNumber(user->spanstats.dm, steps, solution_time));
600       PetscCall(DMGetGlobalVector(user->spanstats.dm, &stats));
601       PetscCall(ProcessStatistics(user, stats));
602       if (user->app_ctx->test_type == TESTTYPE_NONE) {
603         PetscCall(PetscViewerPushFormat(user->app_ctx->turb_spanstats_viewer, user->app_ctx->turb_spanstats_viewer_format));
604         PetscCall(VecView(stats, user->app_ctx->turb_spanstats_viewer));
605         PetscCall(PetscViewerPopFormat(user->app_ctx->turb_spanstats_viewer));
606       }
607       if (user->app_ctx->test_type == TESTTYPE_TURB_SPANSTATS && reason != TS_CONVERGED_ITERATING) {
608         PetscCall(RegressionTests_NS(user->app_ctx, stats));
609       }
610       if (user->spanstats.do_mms_test && reason != TS_CONVERGED_ITERATING) {
611         Vec error;
612         PetscCall(VecDuplicate(stats, &error));
613         PetscCall(ApplyCeedOperatorGlobalToGlobal(stats, error, user->spanstats.mms_error_ctx));
614         PetscScalar error_sq = 0;
615         PetscCall(VecSum(error, &error_sq));
616         PetscScalar l2_error = sqrt(error_sq);
617         PetscCall(PetscPrintf(PETSC_COMM_WORLD, "l2 error: %.5e\n", l2_error));
618       }
619       PetscCall(DMRestoreGlobalVector(user->spanstats.dm, &stats));
620     }
621   }
622   PetscFunctionReturn(PETSC_SUCCESS);
623 }
624 
625 PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data) {
626   PetscFunctionBeginUser;
627 
628   // -- CeedVectors
629   PetscCall(VecDestroy(&user->spanstats.Child_Stats_loc));
630   PetscCall(VecDestroy(&user->spanstats.Parent_Stats_loc));
631 
632   // -- CeedOperators
633   PetscCall(OperatorApplyContextDestroy(user->spanstats.op_stats_collect_ctx));
634   PetscCall(OperatorApplyContextDestroy(user->spanstats.op_proj_rhs_ctx));
635   PetscCall(OperatorApplyContextDestroy(user->spanstats.mms_error_ctx));
636 
637   // -- KSP
638   PetscCall(KSPDestroy(&user->spanstats.ksp));
639 
640   // -- SF
641   PetscCall(PetscSFDestroy(&user->spanstats.sf));
642 
643   // -- DM
644   PetscCall(DMDestroy(&user->spanstats.dm));
645 
646   PetscFunctionReturn(PETSC_SUCCESS);
647 }
648