1 // Copyright (c) 2017-2023, 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 differential filtering 9 10 #include "../qfunctions/differential_filter.h" 11 12 #include <petscdmplex.h> 13 14 #include "../navierstokes.h" 15 16 // @brief Create RHS and LHS operators for differential filtering 17 PetscErrorCode DifferentialFilterCreateOperators(Ceed ceed, User user, CeedData ceed_data, CeedQFunctionContext diff_filter_qfctx) { 18 DiffFilterData diff_filter = user->diff_filter; 19 DM dm_filter = diff_filter->dm_filter; 20 CeedInt num_comp_filter = diff_filter->num_comp_filter; 21 CeedInt num_comp_q, num_comp_qd, dim, num_qpts_1d, num_nodes_1d, num_comp_x; 22 CeedElemRestriction elem_restr_filter; 23 CeedBasis basis_filter; 24 25 PetscFunctionBeginUser; 26 PetscCall(DMGetDimension(user->dm, &dim)); 27 CeedElemRestrictionGetNumComponents(ceed_data->elem_restr_x, &num_comp_x); 28 CeedElemRestrictionGetNumComponents(ceed_data->elem_restr_q, &num_comp_q); 29 CeedElemRestrictionGetNumComponents(ceed_data->elem_restr_qd_i, &num_comp_qd); 30 CeedBasisGetNumQuadraturePoints1D(ceed_data->basis_q, &num_qpts_1d); 31 CeedBasisGetNumNodes1D(ceed_data->basis_q, &num_nodes_1d); 32 33 PetscCall(GetRestrictionForDomain(ceed, dm_filter, 0, 0, 0, num_qpts_1d, 0, &elem_restr_filter, NULL, NULL)); 34 CeedBasisCreateTensorH1Lagrange(ceed, dim, num_comp_filter, num_nodes_1d, num_qpts_1d, CEED_GAUSS, &basis_filter); 35 36 { // -- Create RHS MatopApplyContext 37 CeedQFunction qf_rhs; 38 CeedOperator op_rhs; 39 switch (user->phys->state_var) { 40 case STATEVAR_PRIMITIVE: 41 CeedQFunctionCreateInterior(ceed, 1, DifferentialFilter_RHS_Prim, DifferentialFilter_RHS_Prim_loc, &qf_rhs); 42 break; 43 case STATEVAR_CONSERVATIVE: 44 CeedQFunctionCreateInterior(ceed, 1, DifferentialFilter_RHS_Conserv, DifferentialFilter_RHS_Conserv_loc, &qf_rhs); 45 break; 46 default: 47 SETERRQ(PetscObjectComm((PetscObject)user->dm), PETSC_ERR_SUP, "Differential filtering not available for chosen state variable"); 48 } 49 CeedQFunctionSetContext(qf_rhs, diff_filter_qfctx); 50 CeedQFunctionAddInput(qf_rhs, "q", num_comp_q, CEED_EVAL_INTERP); 51 CeedQFunctionAddInput(qf_rhs, "qdata", num_comp_qd, CEED_EVAL_NONE); 52 CeedQFunctionAddInput(qf_rhs, "x", num_comp_x, CEED_EVAL_INTERP); 53 CeedQFunctionAddOutput(qf_rhs, "v", num_comp_filter, CEED_EVAL_INTERP); 54 55 CeedOperatorCreate(ceed, qf_rhs, NULL, NULL, &op_rhs); 56 CeedOperatorSetField(op_rhs, "q", ceed_data->elem_restr_q, ceed_data->basis_q, CEED_VECTOR_ACTIVE); 57 CeedOperatorSetField(op_rhs, "qdata", ceed_data->elem_restr_qd_i, CEED_BASIS_COLLOCATED, ceed_data->q_data); 58 CeedOperatorSetField(op_rhs, "x", ceed_data->elem_restr_x, ceed_data->basis_x, ceed_data->x_coord); 59 CeedOperatorSetField(op_rhs, "v", elem_restr_filter, basis_filter, CEED_VECTOR_ACTIVE); 60 61 PetscCall(OperatorApplyContextCreate(user->dm, dm_filter, ceed, op_rhs, NULL, NULL, user->Q_loc, NULL, &diff_filter->op_rhs_ctx)); 62 63 CeedQFunctionDestroy(&qf_rhs); 64 CeedOperatorDestroy(&op_rhs); 65 } 66 67 { // Setup LHS Operator and KSP for the differential filtering solve 68 CeedQFunction qf_lhs; 69 CeedOperator op_lhs; 70 OperatorApplyContext mat_ctx; 71 Mat mat_lhs; 72 CeedInt num_comp_qd, dim, num_comp_grid_aniso; 73 CeedElemRestriction elem_restr_grid_aniso; 74 CeedVector grid_aniso_ceed; 75 76 PetscCall(DMGetDimension(user->dm, &dim)); 77 CeedElemRestrictionGetNumComponents(ceed_data->elem_restr_qd_i, &num_comp_qd); 78 79 switch (num_comp_filter) { 80 case 1: 81 CeedQFunctionCreateInterior(ceed, 1, DifferentialFilter_LHS_1, DifferentialFilter_LHS_1_loc, &qf_lhs); 82 break; 83 case 5: 84 CeedQFunctionCreateInterior(ceed, 1, DifferentialFilter_LHS_5, DifferentialFilter_LHS_5_loc, &qf_lhs); 85 break; 86 case 11: 87 CeedQFunctionCreateInterior(ceed, 1, DifferentialFilter_LHS_11, DifferentialFilter_LHS_11_loc, &qf_lhs); 88 break; 89 default: 90 SETERRQ(PetscObjectComm((PetscObject)user->dm), PETSC_ERR_SUP, "Differential filtering not available for (%d) components", num_comp_filter); 91 } 92 93 // -- Get Grid anisotropy tensor 94 PetscCall(GridAnisotropyTensorCalculateCollocatedVector(ceed, user, ceed_data, &elem_restr_grid_aniso, &grid_aniso_ceed, &num_comp_grid_aniso)); 95 96 CeedQFunctionSetContext(qf_lhs, diff_filter_qfctx); 97 CeedQFunctionAddInput(qf_lhs, "q", num_comp_filter, CEED_EVAL_INTERP); 98 CeedQFunctionAddInput(qf_lhs, "Grad_q", num_comp_filter * dim, CEED_EVAL_GRAD); 99 CeedQFunctionAddInput(qf_lhs, "anisotropy tensor", num_comp_grid_aniso, CEED_EVAL_NONE); 100 CeedQFunctionAddInput(qf_lhs, "qdata", num_comp_qd, CEED_EVAL_NONE); 101 CeedQFunctionAddOutput(qf_lhs, "v", num_comp_filter, CEED_EVAL_INTERP); 102 CeedQFunctionAddOutput(qf_lhs, "Grad_v", num_comp_filter * dim, CEED_EVAL_GRAD); 103 104 CeedOperatorCreate(ceed, qf_lhs, NULL, NULL, &op_lhs); 105 CeedOperatorSetField(op_lhs, "q", elem_restr_filter, basis_filter, CEED_VECTOR_ACTIVE); 106 CeedOperatorSetField(op_lhs, "Grad_q", elem_restr_filter, basis_filter, CEED_VECTOR_ACTIVE); 107 CeedOperatorSetField(op_lhs, "anisotropy tensor", elem_restr_grid_aniso, CEED_BASIS_COLLOCATED, grid_aniso_ceed); 108 CeedOperatorSetField(op_lhs, "qdata", ceed_data->elem_restr_qd_i, CEED_BASIS_COLLOCATED, ceed_data->q_data); 109 CeedOperatorSetField(op_lhs, "v", elem_restr_filter, basis_filter, CEED_VECTOR_ACTIVE); 110 CeedOperatorSetField(op_lhs, "Grad_v", elem_restr_filter, basis_filter, CEED_VECTOR_ACTIVE); 111 112 PetscCall(OperatorApplyContextCreate(dm_filter, dm_filter, ceed, op_lhs, NULL, NULL, NULL, NULL, &mat_ctx)); 113 PetscCall(CreateMatShell_Ceed(mat_ctx, &mat_lhs)); 114 115 PetscCall(KSPCreate(PetscObjectComm((PetscObject)dm_filter), &diff_filter->ksp)); 116 PetscCall(KSPSetOptionsPrefix(diff_filter->ksp, "diff_filter_")); 117 { 118 PC pc; 119 PetscCall(KSPGetPC(diff_filter->ksp, &pc)); 120 PetscCall(PCSetType(pc, PCJACOBI)); 121 PetscCall(PCJacobiSetType(pc, PC_JACOBI_DIAGONAL)); 122 PetscCall(KSPSetType(diff_filter->ksp, KSPCG)); 123 PetscCall(KSPSetNormType(diff_filter->ksp, KSP_NORM_NATURAL)); 124 PetscCall(KSPSetTolerances(diff_filter->ksp, 1e-10, PETSC_DEFAULT, PETSC_DEFAULT, PETSC_DEFAULT)); 125 } 126 PetscCall(KSPSetOperators(diff_filter->ksp, mat_lhs, mat_lhs)); 127 PetscCall(KSPSetFromOptions(diff_filter->ksp)); 128 129 CeedQFunctionDestroy(&qf_lhs); 130 CeedOperatorDestroy(&op_lhs); 131 } 132 133 CeedElemRestrictionDestroy(&elem_restr_filter); 134 CeedBasisDestroy(&basis_filter); 135 PetscFunctionReturn(0); 136 } 137 138 // @brief Setup DM, operators, contexts, etc. for performing differential filtering 139 PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem) { 140 MPI_Comm comm = user->comm; 141 NewtonianIdealGasContext gas; 142 DifferentialFilterContext diff_filter_ctx; 143 CeedQFunctionContext diff_filter_qfctx; 144 145 PetscFunctionBeginUser; 146 PetscCall(PetscNew(&user->diff_filter)); 147 148 { // Create DM for filtered quantities 149 PetscFE fe; 150 PetscSection section; 151 PetscInt dim; 152 153 user->diff_filter->num_comp_filter = DIFF_FILTER_NUM_COMPONENTS; 154 155 PetscCall(DMClone(user->dm, &user->diff_filter->dm_filter)); 156 PetscCall(DMGetDimension(user->diff_filter->dm_filter, &dim)); 157 PetscCall(PetscObjectSetName((PetscObject)user->diff_filter->dm_filter, "Differential Filtering")); 158 159 PetscCall(PetscFECreateLagrange(PETSC_COMM_SELF, dim, user->diff_filter->num_comp_filter, PETSC_FALSE, user->app_ctx->degree, PETSC_DECIDE, &fe)); 160 PetscCall(PetscObjectSetName((PetscObject)fe, "Differential Filtering")); 161 PetscCall(DMAddField(user->diff_filter->dm_filter, NULL, (PetscObject)fe)); 162 PetscCall(DMCreateDS(user->diff_filter->dm_filter)); 163 PetscCall(DMPlexSetClosurePermutationTensor(user->diff_filter->dm_filter, PETSC_DETERMINE, NULL)); 164 165 PetscCall(DMGetLocalSection(user->diff_filter->dm_filter, §ion)); 166 PetscCall(PetscSectionSetFieldName(section, 0, "")); 167 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_PRESSURE, "FilteredPressure")); 168 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_X, "FilteredVelocityX")); 169 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_Y, "FilteredVelocityY")); 170 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_Z, "FilteredVelocityZ")); 171 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_TEMPERATURE, "FilteredTemperature")); 172 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_SQUARED_XX, "FilteredVelocitySquaredXX")); 173 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_SQUARED_YY, "FilteredVelocitySquaredYY")); 174 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_SQUARED_ZZ, "FilteredVelocitySquaredZZ")); 175 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_SQUARED_YZ, "FilteredVelocitySquaredYZ")); 176 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_SQUARED_XZ, "FilteredVelocitySquaredXZ")); 177 PetscCall(PetscSectionSetComponentName(section, 0, DIFF_FILTER_VELOCITY_SQUARED_XY, "FilteredVelocitySquaredXY")); 178 179 PetscCall(PetscFEDestroy(&fe)); 180 } 181 182 // -- Create QFContext 183 PetscCall(PetscNew(&diff_filter_ctx)); 184 diff_filter_ctx->grid_based_width = false; 185 for (int i = 0; i < 3; i++) diff_filter_ctx->width_scaling[i] = 1; 186 diff_filter_ctx->kernel_scaling = 0.1; 187 188 PetscOptionsBegin(comm, NULL, "Differential Filtering Options", NULL); 189 PetscInt narray = 3; 190 PetscCall(PetscOptionsBool("-diff_filter_grid_based_width", "Use filter width based on the grid size", NULL, diff_filter_ctx->grid_based_width, 191 (PetscBool *)&diff_filter_ctx->grid_based_width, NULL)); 192 PetscCall(PetscOptionsRealArray("-diff_filter_width_scaling", "Anisotropic scaling of filter width tensor", NULL, diff_filter_ctx->width_scaling, 193 &narray, NULL)); 194 PetscCall(PetscOptionsReal("-diff_filter_kernel_scaling", "Scaling to make differential kernel size \"equivalent\" to other filter kernels", NULL, 195 diff_filter_ctx->kernel_scaling, &diff_filter_ctx->kernel_scaling, NULL)); 196 PetscOptionsEnd(); 197 198 Units units = user->units; 199 for (int i = 0; i < 3; i++) diff_filter_ctx->width_scaling[i] *= units->meter; 200 diff_filter_ctx->kernel_scaling *= units->meter; 201 202 // -- Create QFContext 203 CeedQFunctionContextGetDataRead(problem->apply_vol_ifunction.qfunction_context, CEED_MEM_HOST, &gas); 204 diff_filter_ctx->gas = *gas; 205 CeedQFunctionContextRestoreDataRead(problem->apply_vol_ifunction.qfunction_context, &gas); 206 207 CeedQFunctionContextCreate(ceed, &diff_filter_qfctx); 208 CeedQFunctionContextSetData(diff_filter_qfctx, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*diff_filter_ctx), diff_filter_ctx); 209 CeedQFunctionContextSetDataDestroy(diff_filter_qfctx, CEED_MEM_HOST, FreeContextPetsc); 210 211 // -- Setup Operators 212 PetscCall(DifferentialFilterCreateOperators(ceed, user, ceed_data, diff_filter_qfctx)); 213 214 CeedQFunctionContextDestroy(&diff_filter_qfctx); 215 PetscFunctionReturn(0); 216 } 217 218 // @brief Apply differential filter to the solution given by Q 219 PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution) { 220 DiffFilterData diff_filter = user->diff_filter; 221 222 PetscFunctionBeginUser; 223 PetscCall(UpdateBoundaryValues(user, diff_filter->op_rhs_ctx->X_loc, solution_time)); 224 ApplyCeedOperatorGlobalToGlobal(Q, Filtered_Solution, diff_filter->op_rhs_ctx); 225 PetscCall(VecViewFromOptions(Filtered_Solution, NULL, "-diff_filter_rhs_view")); 226 227 PetscCall(KSPSolve(diff_filter->ksp, Filtered_Solution, Filtered_Solution)); 228 229 PetscFunctionReturn(0); 230 } 231 232 // @brief TSMonitor for just applying differential filtering to the simulation 233 // This runs every time step and is primarily for testing purposes 234 PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx) { 235 User user = (User)ctx; 236 DiffFilterData diff_filter = user->diff_filter; 237 Vec Filtered_Field; 238 239 PetscFunctionBeginUser; 240 PetscCall(DMGetGlobalVector(diff_filter->dm_filter, &Filtered_Field)); 241 242 PetscCall(DifferentialFilterApply(user, solution_time, Q, Filtered_Field)); 243 PetscCall(VecViewFromOptions(Filtered_Field, NULL, "-diff_filter_view")); 244 245 if (user->app_ctx->test_type == TESTTYPE_DIFF_FILTER) PetscCall(RegressionTests_NS(user->app_ctx, Filtered_Field)); 246 247 PetscCall(DMRestoreGlobalVector(diff_filter->dm_filter, &Filtered_Field)); 248 249 PetscFunctionReturn(0); 250 } 251 252 PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter) { 253 PetscFunctionBeginUser; 254 if (!diff_filter) PetscFunctionReturn(0); 255 256 OperatorApplyContextDestroy(diff_filter->op_rhs_ctx); 257 PetscCall(DMDestroy(&diff_filter->dm_filter)); 258 PetscCall(KSPDestroy(&diff_filter->ksp)); 259 260 PetscCall(PetscFree(diff_filter)); 261 262 PetscFunctionReturn(0); 263 } 264