1 // Copyright (c) 2017-2024, 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 8 /// @file 9 /// Utility functions for setting up ADVECTION 10 11 #include "../qfunctions/advection.h" 12 13 #include <ceed.h> 14 #include <petscdm.h> 15 16 #include "../navierstokes.h" 17 18 // @brief Create CeedOperator for stabilized mass KSP for explicit timestepping 19 // 20 // Only used for SUPG stabilization 21 PetscErrorCode CreateKSPMassOperator_AdvectionStabilized(User user, CeedOperator *op_mass) { 22 Ceed ceed = user->ceed; 23 CeedInt num_comp_q, q_data_size; 24 CeedQFunction qf_mass = NULL; 25 CeedElemRestriction elem_restr_q, elem_restr_qd_i; 26 CeedBasis basis_q; 27 CeedVector q_data; 28 CeedQFunctionContext qf_ctx = NULL; 29 PetscInt dim; 30 31 PetscFunctionBeginUser; 32 PetscCall(DMGetDimension(user->dm, &dim)); 33 { // Get restriction and basis from the RHS function 34 CeedOperator *sub_ops; 35 CeedOperatorField field; 36 PetscInt sub_op_index = 0; // will be 0 for the volume op 37 38 PetscCallCeed(ceed, CeedCompositeOperatorGetSubList(user->op_rhs_ctx->op, &sub_ops)); 39 PetscCallCeed(ceed, CeedOperatorGetFieldByName(sub_ops[sub_op_index], "q", &field)); 40 PetscCallCeed(ceed, CeedOperatorFieldGetElemRestriction(field, &elem_restr_q)); 41 PetscCallCeed(ceed, CeedOperatorFieldGetBasis(field, &basis_q)); 42 43 PetscCallCeed(ceed, CeedOperatorGetFieldByName(sub_ops[sub_op_index], "qdata", &field)); 44 PetscCallCeed(ceed, CeedOperatorFieldGetElemRestriction(field, &elem_restr_qd_i)); 45 PetscCallCeed(ceed, CeedOperatorFieldGetVector(field, &q_data)); 46 47 PetscCallCeed(ceed, CeedOperatorGetContext(sub_ops[sub_op_index], &qf_ctx)); 48 } 49 50 PetscCallCeed(ceed, CeedElemRestrictionGetNumComponents(elem_restr_q, &num_comp_q)); 51 PetscCallCeed(ceed, CeedElemRestrictionGetNumComponents(elem_restr_qd_i, &q_data_size)); 52 53 switch (dim) { 54 case 2: 55 PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, MassFunction_Advection2D, MassFunction_Advection2D_loc, &qf_mass)); 56 break; 57 case 3: 58 PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, MassFunction_Advection, MassFunction_Advection_loc, &qf_mass)); 59 break; 60 } 61 62 PetscCallCeed(ceed, CeedQFunctionSetContext(qf_mass, qf_ctx)); 63 PetscCallCeed(ceed, CeedQFunctionSetUserFlopsEstimate(qf_mass, 0)); 64 PetscCallCeed(ceed, CeedQFunctionAddInput(qf_mass, "q_dot", 5, CEED_EVAL_INTERP)); 65 PetscCallCeed(ceed, CeedQFunctionAddInput(qf_mass, "q", 5, CEED_EVAL_INTERP)); 66 PetscCallCeed(ceed, CeedQFunctionAddInput(qf_mass, "qdata", q_data_size, CEED_EVAL_NONE)); 67 PetscCallCeed(ceed, CeedQFunctionAddOutput(qf_mass, "v", 5, CEED_EVAL_INTERP)); 68 PetscCallCeed(ceed, CeedQFunctionAddOutput(qf_mass, "Grad_v", 5 * dim, CEED_EVAL_GRAD)); 69 70 PetscCallCeed(ceed, CeedOperatorCreate(ceed, qf_mass, NULL, NULL, op_mass)); 71 PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "q_dot", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE)); 72 PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "q", elem_restr_q, basis_q, user->q_ceed)); 73 PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "qdata", elem_restr_qd_i, CEED_BASIS_NONE, q_data)); 74 PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "v", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE)); 75 PetscCallCeed(ceed, CeedOperatorSetField(*op_mass, "Grad_v", elem_restr_q, basis_q, CEED_VECTOR_ACTIVE)); 76 77 PetscCallCeed(ceed, CeedQFunctionDestroy(&qf_mass)); 78 PetscFunctionReturn(PETSC_SUCCESS); 79 } 80 81 PetscErrorCode NS_ADVECTION(ProblemData problem, DM dm, void *ctx, SimpleBC bc) { 82 WindType wind_type; 83 AdvectionICType advectionic_type; 84 BubbleContinuityType bubble_continuity_type; 85 StabilizationType stab; 86 StabilizationTauType stab_tau; 87 SetupContextAdv setup_context; 88 User user = *(User *)ctx; 89 MPI_Comm comm = user->comm; 90 Ceed ceed = user->ceed; 91 PetscBool implicit; 92 AdvectionContext advection_ctx; 93 CeedQFunctionContext advection_context; 94 PetscInt dim; 95 96 PetscFunctionBeginUser; 97 PetscCall(PetscCalloc1(1, &setup_context)); 98 PetscCall(PetscCalloc1(1, &advection_ctx)); 99 PetscCall(DMGetDimension(dm, &dim)); 100 101 // ------------------------------------------------------ 102 // SET UP ADVECTION 103 // ------------------------------------------------------ 104 switch (dim) { 105 case 2: 106 problem->dim = 2; 107 problem->ics.qfunction = ICsAdvection2d; 108 problem->ics.qfunction_loc = ICsAdvection2d_loc; 109 problem->apply_vol_rhs.qfunction = RHS_Advection2d; 110 problem->apply_vol_rhs.qfunction_loc = RHS_Advection2d_loc; 111 problem->apply_vol_ifunction.qfunction = IFunction_Advection2d; 112 problem->apply_vol_ifunction.qfunction_loc = IFunction_Advection2d_loc; 113 problem->apply_inflow.qfunction = Advection2d_InOutFlow; 114 problem->apply_inflow.qfunction_loc = Advection2d_InOutFlow_loc; 115 problem->compute_exact_solution_error = PETSC_TRUE; 116 problem->print_info = PRINT_ADVECTION; 117 break; 118 case 3: 119 problem->dim = 3; 120 problem->ics.qfunction = ICsAdvection; 121 problem->ics.qfunction_loc = ICsAdvection_loc; 122 problem->apply_vol_rhs.qfunction = RHS_Advection; 123 problem->apply_vol_rhs.qfunction_loc = RHS_Advection_loc; 124 problem->apply_vol_ifunction.qfunction = IFunction_Advection; 125 problem->apply_vol_ifunction.qfunction_loc = IFunction_Advection_loc; 126 problem->apply_inflow.qfunction = Advection_InOutFlow; 127 problem->apply_inflow.qfunction_loc = Advection_InOutFlow_loc; 128 problem->compute_exact_solution_error = PETSC_FALSE; 129 problem->print_info = PRINT_ADVECTION; 130 break; 131 } 132 133 // ------------------------------------------------------ 134 // Create the libCEED context 135 // ------------------------------------------------------ 136 CeedScalar rc = 1000.; // m (Radius of bubble) 137 CeedScalar CtauS = 0.; // dimensionless 138 PetscBool strong_form = PETSC_FALSE; 139 CeedScalar E_wind = 1.e6; // J 140 CeedScalar Ctau_a = PetscPowScalarInt(user->app_ctx->degree, 2); 141 CeedScalar Ctau_t = 0.; 142 PetscReal wind[3] = {1., 0, 0}; // m/s 143 CeedScalar diffusion_coeff = 0.; 144 PetscReal domain_min[3], domain_max[3], domain_size[3] = {0.}; 145 PetscCall(DMGetBoundingBox(dm, domain_min, domain_max)); 146 for (PetscInt i = 0; i < problem->dim; i++) domain_size[i] = domain_max[i] - domain_min[i]; 147 148 // ------------------------------------------------------ 149 // Create the PETSc context 150 // ------------------------------------------------------ 151 PetscScalar meter = 1e-2; // 1 meter in scaled length units 152 PetscScalar kilogram = 1e-6; // 1 kilogram in scaled mass units 153 PetscScalar second = 1e-2; // 1 second in scaled time units 154 PetscScalar Joule; 155 156 // ------------------------------------------------------ 157 // Command line Options 158 // ------------------------------------------------------ 159 PetscOptionsBegin(comm, NULL, "Options for ADVECTION problem", NULL); 160 // -- Physics 161 PetscCall(PetscOptionsScalar("-rc", "Characteristic radius of thermal bubble", NULL, rc, &rc, NULL)); 162 PetscBool translation; 163 PetscCall(PetscOptionsEnum("-wind_type", "Wind type in Advection", NULL, WindTypes, (PetscEnum)(wind_type = WIND_ROTATION), (PetscEnum *)&wind_type, 164 &translation)); 165 PetscInt n = problem->dim; 166 PetscBool user_wind; 167 PetscCall(PetscOptionsRealArray("-wind_translation", "Constant wind vector", NULL, wind, &n, &user_wind)); 168 PetscCall(PetscOptionsScalar("-diffusion_coeff", "Diffusion coefficient", NULL, diffusion_coeff, &diffusion_coeff, NULL)); 169 PetscCall(PetscOptionsScalar("-CtauS", "Scale coefficient for tau (nondimensional)", NULL, CtauS, &CtauS, NULL)); 170 PetscCall(PetscOptionsBool("-strong_form", "Strong (true) or weak/integrated by parts (false) advection residual", NULL, strong_form, &strong_form, 171 NULL)); 172 PetscCall(PetscOptionsScalar("-E_wind", "Total energy of inflow wind", NULL, E_wind, &E_wind, NULL)); 173 PetscCall(PetscOptionsEnum("-advection_ic_type", "Initial condition for Advection problem", NULL, AdvectionICTypes, 174 (PetscEnum)(advectionic_type = ADVECTIONIC_BUBBLE_SPHERE), (PetscEnum *)&advectionic_type, NULL)); 175 bubble_continuity_type = problem->dim == 3 ? BUBBLE_CONTINUITY_SMOOTH : BUBBLE_CONTINUITY_COSINE; 176 PetscCall(PetscOptionsEnum("-bubble_continuity", "Smooth, back_sharp, or thick", NULL, BubbleContinuityTypes, (PetscEnum)bubble_continuity_type, 177 (PetscEnum *)&bubble_continuity_type, NULL)); 178 PetscCall(PetscOptionsEnum("-stab", "Stabilization method", NULL, StabilizationTypes, (PetscEnum)(stab = STAB_NONE), (PetscEnum *)&stab, NULL)); 179 PetscCall(PetscOptionsEnum("-stab_tau", "Stabilization constant, tau", NULL, StabilizationTauTypes, (PetscEnum)(stab_tau = STAB_TAU_CTAU), 180 (PetscEnum *)&stab_tau, NULL)); 181 PetscCall(PetscOptionsScalar("-Ctau_t", "Stabilization time constant", NULL, Ctau_t, &Ctau_t, NULL)); 182 PetscCall(PetscOptionsScalar("-Ctau_a", "Coefficient for the stabilization ", NULL, Ctau_a, &Ctau_a, NULL)); 183 PetscCall(PetscOptionsBool("-implicit", "Use implicit (IFunction) formulation", NULL, implicit = PETSC_FALSE, &implicit, NULL)); 184 185 // -- Units 186 PetscCall(PetscOptionsScalar("-units_meter", "1 meter in scaled length units", NULL, meter, &meter, NULL)); 187 meter = fabs(meter); 188 PetscCall(PetscOptionsScalar("-units_kilogram", "1 kilogram in scaled mass units", NULL, kilogram, &kilogram, NULL)); 189 kilogram = fabs(kilogram); 190 PetscCall(PetscOptionsScalar("-units_second", "1 second in scaled time units", NULL, second, &second, NULL)); 191 second = fabs(second); 192 193 // -- Warnings 194 if (wind_type == WIND_ROTATION && user_wind) { 195 PetscCall(PetscPrintf(comm, "Warning! Use -wind_translation only with -wind_type translation\n")); 196 } 197 if (wind_type == WIND_TRANSLATION && advectionic_type == ADVECTIONIC_BUBBLE_CYLINDER && wind[2] != 0.) { 198 wind[2] = 0; 199 PetscCall( 200 PetscPrintf(comm, "Warning! Background wind in the z direction should be zero (-wind_translation x,x,0) with -advection_ic_type cylinder\n")); 201 } 202 if (stab == STAB_NONE && CtauS != 0) { 203 PetscCall(PetscPrintf(comm, "Warning! Use -CtauS only with -stab su or -stab supg\n")); 204 } 205 PetscOptionsEnd(); 206 207 if (stab == STAB_SUPG) problem->create_mass_operator = CreateKSPMassOperator_AdvectionStabilized; 208 209 // ------------------------------------------------------ 210 // Set up the PETSc context 211 // ------------------------------------------------------ 212 // -- Define derived units 213 Joule = kilogram * PetscSqr(meter) / PetscSqr(second); 214 215 user->units->meter = meter; 216 user->units->kilogram = kilogram; 217 user->units->second = second; 218 user->units->Joule = Joule; 219 220 // ------------------------------------------------------ 221 // Set up the libCEED context 222 // ------------------------------------------------------ 223 // -- Scale variables to desired units 224 E_wind *= Joule; 225 rc = fabs(rc) * meter; 226 for (PetscInt i = 0; i < problem->dim; i++) { 227 wind[i] *= (meter / second); 228 domain_size[i] *= meter; 229 } 230 problem->dm_scale = meter; 231 232 // -- Setup Context 233 setup_context->rc = rc; 234 setup_context->lx = domain_size[0]; 235 setup_context->ly = domain_size[1]; 236 setup_context->lz = problem->dim == 3 ? domain_size[2] : 0.; 237 setup_context->wind[0] = wind[0]; 238 setup_context->wind[1] = wind[1]; 239 setup_context->wind[2] = problem->dim == 3 ? wind[2] : 0.; 240 setup_context->wind_type = wind_type; 241 setup_context->initial_condition_type = advectionic_type; 242 setup_context->bubble_continuity_type = bubble_continuity_type; 243 setup_context->time = 0; 244 245 // -- QFunction Context 246 user->phys->implicit = implicit; 247 advection_ctx->CtauS = CtauS; 248 advection_ctx->E_wind = E_wind; 249 advection_ctx->implicit = implicit; 250 advection_ctx->strong_form = strong_form; 251 advection_ctx->stabilization = stab; 252 advection_ctx->stabilization_tau = stab_tau; 253 advection_ctx->Ctau_a = Ctau_a; 254 advection_ctx->Ctau_t = Ctau_t; 255 advection_ctx->diffusion_coeff = diffusion_coeff; 256 257 PetscCallCeed(ceed, CeedQFunctionContextCreate(user->ceed, &problem->ics.qfunction_context)); 258 PetscCallCeed(ceed, 259 CeedQFunctionContextSetData(problem->ics.qfunction_context, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*setup_context), setup_context)); 260 PetscCallCeed(ceed, CeedQFunctionContextSetDataDestroy(problem->ics.qfunction_context, CEED_MEM_HOST, FreeContextPetsc)); 261 262 PetscCallCeed(ceed, CeedQFunctionContextCreate(user->ceed, &advection_context)); 263 PetscCallCeed(ceed, CeedQFunctionContextSetData(advection_context, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*advection_ctx), advection_ctx)); 264 PetscCallCeed(ceed, CeedQFunctionContextSetDataDestroy(advection_context, CEED_MEM_HOST, FreeContextPetsc)); 265 PetscCallCeed(ceed, CeedQFunctionContextRegisterDouble(advection_context, "timestep size", offsetof(struct AdvectionContext_, dt), 1, 266 "Size of timestep, delta t")); 267 problem->apply_vol_rhs.qfunction_context = advection_context; 268 PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(advection_context, &problem->apply_vol_ifunction.qfunction_context)); 269 PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(advection_context, &problem->apply_inflow.qfunction_context)); 270 PetscFunctionReturn(PETSC_SUCCESS); 271 } 272 273 PetscErrorCode PRINT_ADVECTION(User user, ProblemData problem, AppCtx app_ctx) { 274 MPI_Comm comm = user->comm; 275 Ceed ceed = user->ceed; 276 SetupContextAdv setup_ctx; 277 AdvectionContext advection_ctx; 278 279 PetscFunctionBeginUser; 280 PetscCallCeed(ceed, CeedQFunctionContextGetData(problem->ics.qfunction_context, CEED_MEM_HOST, &setup_ctx)); 281 PetscCallCeed(ceed, CeedQFunctionContextGetData(problem->apply_vol_rhs.qfunction_context, CEED_MEM_HOST, &advection_ctx)); 282 PetscCall(PetscPrintf(comm, 283 " Problem:\n" 284 " Problem Name : %s\n" 285 " Stabilization : %s\n" 286 " Initial Condition Type : %s\n" 287 " Bubble Continuity : %s\n" 288 " Wind Type : %s\n", 289 app_ctx->problem_name, StabilizationTypes[advection_ctx->stabilization], AdvectionICTypes[setup_ctx->initial_condition_type], 290 BubbleContinuityTypes[setup_ctx->bubble_continuity_type], WindTypes[setup_ctx->wind_type])); 291 292 if (setup_ctx->wind_type == WIND_TRANSLATION) { 293 switch (problem->dim) { 294 case 2: 295 PetscCall(PetscPrintf(comm, " Background Wind : %f,%f\n", setup_ctx->wind[0], setup_ctx->wind[1])); 296 break; 297 case 3: 298 PetscCall( 299 PetscPrintf(comm, " Background Wind : %f,%f,%f\n", setup_ctx->wind[0], setup_ctx->wind[1], setup_ctx->wind[2])); 300 break; 301 } 302 } 303 PetscCallCeed(ceed, CeedQFunctionContextRestoreData(problem->ics.qfunction_context, &setup_ctx)); 304 PetscCallCeed(ceed, CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfunction_context, &advection_ctx)); 305 PetscFunctionReturn(PETSC_SUCCESS); 306 } 307