1 // SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors. 2 // SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause 3 /// @file 4 /// Functions for setting up and performing spanwise-statistics collection of CFL and Peclet number 5 6 #include "../qfunctions/spanstats/cflpe.h" 7 #include "../qfunctions/advection_types.h" 8 9 #include <ceed.h> 10 #include <petscdmplex.h> 11 #include <petscsf.h> 12 #include <spanstats.h> 13 14 #include <navierstokes.h> 15 #include <petsc_ops.h> 16 17 // @brief Create CeedOperator for statistics collection 18 static PetscErrorCode CreateStatisticCollectionOperator(Honee honee, SpanStatsCtx spanstats, SpanStatsSetupData stats_data, ProblemData problem) { 19 Ceed ceed = honee->ceed; 20 CeedInt num_comp_stats = spanstats->num_comp_stats, q_data_size; 21 PetscInt dim, num_comp_q, num_comp_x; 22 CflPe_SpanStatsContext collect_ctx; 23 CeedQFunctionContext collect_qfctx; 24 CeedQFunction qf_stats_collect = NULL; 25 CeedOperator op_stats_collect; 26 CeedVector q_data; 27 CeedElemRestriction elem_restr_qd, elem_restr_q; 28 CeedBasis basis_q; 29 30 PetscFunctionBeginUser; 31 PetscCall(DMGetDimension(honee->dm, &dim)); 32 PetscCall(DMGetCoordinateNumComps(honee->dm, &num_comp_x)); 33 PetscCall(DMGetFieldNumComps(honee->dm, 0, &num_comp_q)); 34 35 // Create Operator for statistics collection 36 switch (dim) { 37 case 2: 38 switch (honee->phys->state_var) { 39 case STATEVAR_PRIMITIVE: 40 PetscCallCeed(ceed, 41 CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_2D_Prim, ChildStatsCollection_2D_Prim_loc, &qf_stats_collect)); 42 break; 43 case STATEVAR_CONSERVATIVE: 44 PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_2D_Conserv, ChildStatsCollection_2D_Conserv_loc, 45 &qf_stats_collect)); 46 break; 47 case STATEVAR_ENTROPY: 48 PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_2D_Entropy, ChildStatsCollection_2D_Entropy_loc, 49 &qf_stats_collect)); 50 break; 51 } 52 break; 53 case 3: 54 switch (honee->phys->state_var) { 55 case STATEVAR_PRIMITIVE: 56 PetscCallCeed(ceed, 57 CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_3D_Prim, ChildStatsCollection_3D_Prim_loc, &qf_stats_collect)); 58 break; 59 case STATEVAR_CONSERVATIVE: 60 PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_3D_Conserv, ChildStatsCollection_3D_Conserv_loc, 61 &qf_stats_collect)); 62 break; 63 case STATEVAR_ENTROPY: 64 PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, ChildStatsCollection_3D_Entropy, ChildStatsCollection_3D_Entropy_loc, 65 &qf_stats_collect)); 66 break; 67 } 68 break; 69 } 70 PetscCheck(qf_stats_collect, PetscObjectComm((PetscObject)honee->dm), PETSC_ERR_SUP, 71 "Could not create CFL/Pe spanstats collection QFunction for dim %" PetscInt_FMT " and state variable %s", dim, 72 StateVariables[honee->phys->state_var]); 73 74 PetscCall(DMPlexCeedElemRestrictionCreate(ceed, honee->dm, DMLABEL_DEFAULT, DMLABEL_DEFAULT_VALUE, 0, 0, &elem_restr_q)); 75 PetscCall(DMPlexCeedBasisCreate(ceed, honee->dm, DMLABEL_DEFAULT, DMLABEL_DEFAULT_VALUE, 0, 0, &basis_q)); 76 PetscCall(QDataGet(ceed, honee->dm, DMLABEL_DEFAULT, DMLABEL_DEFAULT_VALUE, &elem_restr_qd, &q_data, &q_data_size)); 77 { // Setup Collection Context 78 PetscBool is_advection; 79 80 PetscCall(PetscNew(&collect_ctx)); 81 PetscCall(PetscStrcmp("advection", honee->app_ctx->problem_name, &is_advection)); 82 if (is_advection) { 83 AdvectionContext advection_ctx; 84 85 PetscCallCeed(ceed, CeedQFunctionContextGetData(problem->apply_vol_rhs.qfctx, CEED_MEM_HOST, &advection_ctx)); 86 collect_ctx->newt_ctx = (struct NewtonianIdealGasContext_){0}; 87 collect_ctx->diffusion_coeff = advection_ctx->diffusion_coeff; 88 PetscCallCeed(ceed, CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfctx, &advection_ctx)); 89 } else { 90 NewtonianIdealGasContext newtonian_ig_ctx; 91 92 PetscCallCeed(ceed, CeedQFunctionContextGetData(problem->apply_vol_rhs.qfctx, CEED_MEM_HOST, &newtonian_ig_ctx)); 93 collect_ctx->newt_ctx = *newtonian_ig_ctx; 94 collect_ctx->diffusion_coeff = newtonian_ig_ctx->gas.mu; 95 PetscCallCeed(ceed, CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfctx, &newtonian_ig_ctx)); 96 } 97 98 PetscCallCeed(ceed, CeedQFunctionContextCreate(honee->ceed, &collect_qfctx)); 99 PetscCallCeed(ceed, CeedQFunctionContextSetData(collect_qfctx, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*collect_ctx), collect_ctx)); 100 PetscCallCeed(ceed, CeedQFunctionContextSetDataDestroy(collect_qfctx, CEED_MEM_HOST, FreeContextPetsc)); 101 102 PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(collect_qfctx, "solution time", offsetof(struct CflPe_SpanStatsContext_, solution_time), 1, 103 "Current solution time")); 104 PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(collect_qfctx, "previous time", offsetof(struct CflPe_SpanStatsContext_, previous_time), 1, 105 "Previous time statistics collection was done")); 106 PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(collect_qfctx, "timestep", offsetof(struct CflPe_SpanStatsContext_, timestep), 1, 107 "Current timestep taken by TS")); 108 } 109 110 PetscCallCeed(ceed, CeedQFunctionSetContext(qf_stats_collect, collect_qfctx)); 111 PetscCallCeed(ceed, CeedQFunctionContextDestroy(&collect_qfctx)); 112 PetscCallCeed(ceed, CeedQFunctionAddInput(qf_stats_collect, "q", num_comp_q, CEED_EVAL_INTERP)); 113 PetscCallCeed(ceed, CeedQFunctionAddInput(qf_stats_collect, "q_data", q_data_size, CEED_EVAL_NONE)); 114 PetscCallCeed(ceed, CeedQFunctionAddInput(qf_stats_collect, "x", num_comp_x, CEED_EVAL_INTERP)); 115 PetscCallCeed(ceed, CeedQFunctionAddOutput(qf_stats_collect, "v", num_comp_stats, CEED_EVAL_NONE)); 116 117 PetscCallCeed(ceed, CeedOperatorCreate(ceed, qf_stats_collect, NULL, NULL, &op_stats_collect)); 118 PetscCallCeed(ceed, CeedOperatorSetField(op_stats_collect, "q", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE)); 119 PetscCallCeed(ceed, CeedOperatorSetField(op_stats_collect, "q_data", elem_restr_qd, CEED_BASIS_NONE, q_data)); 120 PetscCallCeed(ceed, CeedOperatorSetField(op_stats_collect, "x", honee->elem_restr_x, honee->basis_x, honee->x_coord)); 121 PetscCallCeed(ceed, CeedOperatorSetField(op_stats_collect, "v", stats_data->elem_restr_child_colloc, CEED_BASIS_NONE, CEED_VECTOR_ACTIVE)); 122 123 PetscCallCeed(ceed, CeedOperatorGetContextFieldLabel(op_stats_collect, "solution time", &spanstats->solution_time_label)); 124 PetscCallCeed(ceed, CeedOperatorGetContextFieldLabel(op_stats_collect, "previous time", &spanstats->previous_time_label)); 125 PetscCallCeed(ceed, CeedOperatorGetContextFieldLabel(op_stats_collect, "timestep", &spanstats->timestep_label)); 126 127 PetscCall(OperatorApplyContextCreate(honee->dm, spanstats->dm, honee->ceed, op_stats_collect, honee->q_ceed, NULL, NULL, NULL, 128 &spanstats->op_stats_collect_ctx)); 129 130 PetscCall(CeedOperatorCreateLocalVecs(op_stats_collect, DMReturnVecType(spanstats->dm), PETSC_COMM_SELF, NULL, &spanstats->Child_Stats_loc)); 131 PetscCall(VecZeroEntries(spanstats->Child_Stats_loc)); 132 133 PetscCallCeed(ceed, CeedVectorDestroy(&q_data)); 134 PetscCallCeed(ceed, CeedElemRestrictionDestroy(&elem_restr_qd)); 135 PetscCallCeed(ceed, CeedQFunctionDestroy(&qf_stats_collect)); 136 PetscCallCeed(ceed, CeedOperatorDestroy(&op_stats_collect)); 137 PetscCallCeed(ceed, CeedElemRestrictionDestroy(&elem_restr_q)); 138 PetscCallCeed(ceed, CeedBasisDestroy(&basis_q)); 139 PetscFunctionReturn(PETSC_SUCCESS); 140 } 141 142 // @brief Setup for statistics collection of CFL and Peclet number 143 PetscErrorCode SpanwiseStatisticsSetup_CflPe(TS ts, PetscViewerAndFormat *ctx) { 144 Honee honee; 145 SpanStatsSetupData stats_setup_data; 146 SpanStatsCtx spanstats; 147 const char *prefix = "ts_monitor_spanstats_cflpe_"; 148 PetscBool is_ascii; 149 150 PetscFunctionBeginUser; 151 PetscCall(TSGetApplicationContext(ts, &honee)); 152 PetscCall(PetscObjectTypeCompare((PetscObject)ctx->viewer, PETSCVIEWERASCII, &is_ascii)); 153 PetscCheck(!is_ascii || honee->app_ctx->test_type != TESTTYPE_NONE, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, 154 "Turbulence spanwise statistics does not support ASCII viewers"); 155 156 PetscCall(SpanwiseStatisticsSetupInitialize(honee, honee->app_ctx->degree, 6, prefix, &stats_setup_data, &spanstats)); 157 158 { // Create Section for data 159 PetscSection section; 160 161 PetscCall(DMGetLocalSection(spanstats->dm, §ion)); 162 PetscCall(PetscSectionSetFieldName(section, 0, "")); 163 PetscCall(PetscSectionSetComponentName(section, 0, 0, "MeanCFL")); 164 PetscCall(PetscSectionSetComponentName(section, 0, 1, "MeanCFLSquared")); 165 PetscCall(PetscSectionSetComponentName(section, 0, 2, "MeanCFLCubed")); 166 PetscCall(PetscSectionSetComponentName(section, 0, 3, "MeanPe")); 167 PetscCall(PetscSectionSetComponentName(section, 0, 4, "MeanPeSquared")); 168 PetscCall(PetscSectionSetComponentName(section, 0, 5, "MeanPeCubed")); 169 } 170 171 // Create CeedOperators for statistics collection 172 PetscCall(CreateStatisticCollectionOperator(honee, spanstats, stats_setup_data, honee->problem_data)); 173 174 ctx->data = spanstats; 175 ctx->data_destroy = (PetscCtxDestroyFn *)SpanStatsCtxDestroy; 176 177 PetscCall(SpanwiseStatisticsSetupFinalize(ts, honee, spanstats, ctx, &stats_setup_data)); 178 PetscFunctionReturn(PETSC_SUCCESS); 179 } 180 181 // @brief TSMonitor for collection and processing of CFL and Peclet number statistics 182 PetscErrorCode TSMonitor_SpanwiseStatisticsCflPe(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx) { 183 Honee honee; 184 Vec stats; 185 TSConvergedReason reason; 186 SpanStatsCtx spanstats = ctx->data; 187 PetscInt collect_interval = spanstats->collect_interval, viewer_interval = ctx->view_interval; 188 PetscReal timestep; 189 190 PetscFunctionBeginUser; 191 PetscCall(TSGetApplicationContext(ts, &honee)); 192 PetscCall(TSGetConvergedReason(ts, &reason)); 193 // Do not collect or process on the first step of the run (ie. on the initial condition) 194 if (steps == honee->app_ctx->cont_steps) PetscFunctionReturn(PETSC_SUCCESS); 195 196 PetscBool run_processing_and_viewer = (steps % viewer_interval == 0 && viewer_interval != -1) || reason != TS_CONVERGED_ITERATING; 197 198 if (steps % collect_interval == 0 || run_processing_and_viewer) { 199 PetscCall(TSGetTimeStep(ts, ×tep)); 200 PetscCallCeed(honee->ceed, CeedOperatorSetContextDouble(spanstats->op_stats_collect_ctx->op, spanstats->timestep_label, ×tep)); 201 PetscCall(SpanwiseStatisticsCollect(honee, spanstats, solution_time, Q)); 202 203 if (run_processing_and_viewer) { 204 PetscCall(DMSetOutputSequenceNumber(spanstats->dm, steps, solution_time)); 205 PetscCall(DMGetGlobalVector(spanstats->dm, &stats)); 206 PetscCall(SpanwiseStatisticsProcess(honee, spanstats, stats)); 207 208 if (honee->app_ctx->test_type == TESTTYPE_NONE) { 209 PetscCall(PetscViewerPushFormat(ctx->viewer, ctx->format)); 210 PetscCall(VecView(stats, ctx->viewer)); 211 PetscCall(PetscViewerPopFormat(ctx->viewer)); 212 { 213 PetscInt tab_level; 214 PetscViewer viewer = PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts)); 215 CeedScalar second = honee->units->second; 216 const char *filename; 217 218 PetscCall(PetscViewerFileGetName(ctx->viewer, &filename)); 219 PetscCall(PetscObjectGetTabLevel((PetscObject)ts, &tab_level)); 220 PetscCall(PetscViewerASCIIAddTab(viewer, tab_level + 1)); 221 if (filename) { 222 PetscCall(PetscViewerASCIIPrintf( 223 viewer, "Spanwise cflpe statistics written to %s for time span (%0.12e,%0.12e] and step span [%" PetscInt_FMT ",%" PetscInt_FMT "]\n", 224 filename, spanstats->initial_solution_time / second, solution_time / second, spanstats->initial_solution_step, steps)); 225 } else { 226 PetscCall(PetscViewerASCIIPrintf( 227 viewer, "Spanwise statistics (%s) file written for time span (%0.12e,%0.12e] and step span [%" PetscInt_FMT ",%" PetscInt_FMT "]\n", 228 spanstats->prefix, spanstats->initial_solution_time / second, solution_time / second, spanstats->initial_solution_step, steps)); 229 } 230 PetscCall(PetscViewerASCIISubtractTab(viewer, tab_level + 1)); 231 } 232 } else if (honee->app_ctx->test_type == TESTTYPE_SPANSTATS && reason != TS_CONVERGED_ITERATING) { 233 PetscCall(RegressionTest(honee->app_ctx, stats)); 234 } 235 236 PetscCall(DMRestoreGlobalVector(spanstats->dm, &stats)); 237 } 238 } 239 PetscFunctionReturn(PETSC_SUCCESS); 240 } 241