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 8 #ifndef libceed_fluids_examples_navier_stokes_h 9 #define libceed_fluids_examples_navier_stokes_h 10 11 #include <ceed.h> 12 #include <petscdm.h> 13 #include <petscdmplex.h> 14 #include <petscsys.h> 15 #include <petscts.h> 16 #include <stdbool.h> 17 #include "qfunctions/stabilization_types.h" 18 19 // ----------------------------------------------------------------------------- 20 // PETSc Version 21 // ----------------------------------------------------------------------------- 22 #if PETSC_VERSION_LT(3,17,0) 23 #error "PETSc v3.17 or later is required" 24 #endif 25 26 // ----------------------------------------------------------------------------- 27 // Enums 28 // ----------------------------------------------------------------------------- 29 // Translate PetscMemType to CeedMemType 30 static inline CeedMemType MemTypeP2C(PetscMemType mem_type) { 31 return PetscMemTypeDevice(mem_type) ? CEED_MEM_DEVICE : CEED_MEM_HOST; 32 } 33 34 // Advection - Wind Options 35 typedef enum { 36 WIND_ROTATION = 0, 37 WIND_TRANSLATION = 1, 38 } WindType; 39 static const char *const WindTypes[] = { 40 "rotation", 41 "translation", 42 "WindType", "WIND_", NULL 43 }; 44 45 // Advection - Bubble Types 46 typedef enum { 47 BUBBLE_SPHERE = 0, // dim=3 48 BUBBLE_CYLINDER = 1, // dim=2 49 } BubbleType; 50 static const char *const BubbleTypes[] = { 51 "sphere", 52 "cylinder", 53 "BubbleType", "BUBBLE_", NULL 54 }; 55 56 // Advection - Bubble Continuity Types 57 typedef enum { 58 BUBBLE_CONTINUITY_SMOOTH = 0, // Original continuous, smooth shape 59 BUBBLE_CONTINUITY_BACK_SHARP = 1, // Discontinuous, sharp back half shape 60 BUBBLE_CONTINUITY_THICK = 2, // Define a finite thickness 61 } BubbleContinuityType; 62 static const char *const BubbleContinuityTypes[] = { 63 "smooth", 64 "back_sharp", 65 "thick", 66 "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL 67 }; 68 69 // Euler - test cases 70 typedef enum { 71 EULER_TEST_ISENTROPIC_VORTEX = 0, 72 EULER_TEST_1 = 1, 73 EULER_TEST_2 = 2, 74 EULER_TEST_3 = 3, 75 EULER_TEST_4 = 4, 76 EULER_TEST_5 = 5, 77 } EulerTestType; 78 static const char *const EulerTestTypes[] = { 79 "isentropic_vortex", 80 "test_1", 81 "test_2", 82 "test_3", 83 "test_4", 84 "test_5", 85 "EulerTestType", "EULER_TEST_", NULL 86 }; 87 88 // Stabilization methods 89 static const char *const StabilizationTypes[] = { 90 "none", 91 "SU", 92 "SUPG", 93 "StabilizationType", "STAB_", NULL 94 }; 95 96 // ----------------------------------------------------------------------------- 97 // Structs 98 // ----------------------------------------------------------------------------- 99 // Structs declarations 100 typedef struct AppCtx_private *AppCtx; 101 typedef struct CeedData_private *CeedData; 102 typedef struct User_private *User; 103 typedef struct Units_private *Units; 104 typedef struct SimpleBC_private *SimpleBC; 105 typedef struct Physics_private *Physics; 106 107 // Application context from user command line options 108 struct AppCtx_private { 109 // libCEED arguments 110 char ceed_resource[PETSC_MAX_PATH_LEN]; // libCEED backend 111 PetscInt degree; 112 PetscInt q_extra; 113 // Post-processing arguments 114 PetscInt output_freq; 115 PetscInt viz_refine; 116 PetscInt cont_steps; 117 char output_dir[PETSC_MAX_PATH_LEN]; 118 // Problem type arguments 119 PetscFunctionList problems; 120 char problem_name[PETSC_MAX_PATH_LEN]; 121 // Test mode arguments 122 PetscBool test_mode; 123 PetscScalar test_tol; 124 char file_path[PETSC_MAX_PATH_LEN]; 125 }; 126 127 // libCEED data struct 128 struct CeedData_private { 129 CeedVector x_coord, q_data; 130 CeedQFunction qf_setup_vol, qf_ics, qf_rhs_vol, qf_ifunction_vol, 131 qf_setup_sur, 132 qf_apply_inflow, qf_apply_inflow_jacobian, 133 qf_apply_outflow, qf_apply_outflow_jacobian; 134 CeedBasis basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur; 135 CeedElemRestriction elem_restr_x, elem_restr_q, elem_restr_qd_i; 136 CeedOperator op_setup_vol, op_ics; 137 }; 138 139 // PETSc user data 140 struct User_private { 141 MPI_Comm comm; 142 DM dm; 143 DM dm_viz; 144 Mat interp_viz; 145 Ceed ceed; 146 Units units; 147 Vec M, Q_loc, Q_dot_loc; 148 Physics phys; 149 AppCtx app_ctx; 150 CeedVector q_ceed, q_dot_ceed, g_ceed, coo_values, x_ceed; 151 CeedOperator op_rhs_vol, op_rhs, op_ifunction_vol, op_ifunction, op_ijacobian, 152 op_dirichlet; 153 bool matrices_set_up; 154 CeedScalar time, dt; 155 }; 156 157 // Units 158 struct Units_private { 159 // fundamental units 160 PetscScalar meter; 161 PetscScalar kilogram; 162 PetscScalar second; 163 PetscScalar Kelvin; 164 // derived units 165 PetscScalar Pascal; 166 PetscScalar J_per_kg_K; 167 PetscScalar m_per_squared_s; 168 PetscScalar W_per_m_K; 169 PetscScalar Joule; 170 }; 171 172 // Boundary conditions 173 struct SimpleBC_private { 174 PetscInt num_wall, // Number of faces with wall BCs 175 wall_comps[5], // An array of constrained component numbers 176 num_comps, 177 num_slip[3], // Number of faces with slip BCs 178 num_inflow, 179 num_outflow; 180 PetscInt walls[16], slips[3][16], inflows[16], outflows[16]; 181 PetscBool user_bc; 182 }; 183 184 // Struct that contains all enums and structs used for the physics of all problems 185 struct Physics_private { 186 WindType wind_type; 187 BubbleType bubble_type; 188 BubbleContinuityType bubble_continuity_type; 189 EulerTestType euler_test; 190 StabilizationType stab; 191 PetscBool implicit; 192 PetscBool has_curr_time; 193 PetscBool has_neumann; 194 CeedContextFieldLabel solution_time_label; 195 CeedContextFieldLabel timestep_size_label; 196 CeedContextFieldLabel ics_time_label; 197 CeedContextFieldLabel ijacobian_time_shift_label; 198 }; 199 200 typedef struct { 201 CeedQFunctionUser qfunction; 202 const char *qfunction_loc; 203 CeedQFunctionContext qfunction_context; 204 } ProblemQFunctionSpec; 205 206 // Problem specific data 207 // *INDENT-OFF* 208 typedef struct ProblemData_private ProblemData; 209 struct ProblemData_private { 210 CeedInt dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur; 211 CeedScalar dm_scale; 212 ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, 213 apply_vol_ijacobian, apply_inflow, apply_outflow, 214 apply_inflow_jacobian, apply_outflow_jacobian; 215 bool non_zero_time; 216 PetscErrorCode (*bc)(PetscInt, PetscReal, const PetscReal[], PetscInt, 217 PetscScalar[], void *); 218 void *bc_ctx; 219 PetscBool bc_from_ics, use_dirichlet_ceed; 220 PetscErrorCode (*print_info)(ProblemData*, AppCtx); 221 }; 222 // *INDENT-ON* 223 224 extern int FreeContextPetsc(void *); 225 226 // ----------------------------------------------------------------------------- 227 // Set up problems 228 // ----------------------------------------------------------------------------- 229 // Set up function for each problem 230 extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, 231 void *ctx); 232 extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, 233 void *ctx); 234 extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, 235 void *ctx); 236 extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, 237 void *ctx); 238 239 extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, 240 void *ctx); 241 extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, 242 void *ctx); 243 extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, 244 void *ctx); 245 extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, 246 void *ctx); 247 248 // Print function for each problem 249 extern PetscErrorCode PRINT_DENSITY_CURRENT(ProblemData *problem, 250 AppCtx app_ctx); 251 252 extern PetscErrorCode PRINT_EULER_VORTEX(ProblemData *problem, 253 AppCtx app_ctx); 254 255 extern PetscErrorCode PRINT_SHOCKTUBE(ProblemData *problem, 256 AppCtx app_ctx); 257 258 extern PetscErrorCode PRINT_ADVECTION(ProblemData *problem, 259 AppCtx app_ctx); 260 261 extern PetscErrorCode PRINT_ADVECTION2D(ProblemData *problem, 262 AppCtx app_ctx); 263 264 // ----------------------------------------------------------------------------- 265 // libCEED functions 266 // ----------------------------------------------------------------------------- 267 // Utility function - essential BC dofs are encoded in closure indices as -(i+1). 268 PetscInt Involute(PetscInt i); 269 270 // Utility function to create local CEED restriction 271 PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, 272 DMLabel domain_label, CeedInt value, CeedElemRestriction *elem_restr); 273 274 // Utility function to get Ceed Restriction for each domain 275 PetscErrorCode GetRestrictionForDomain(Ceed ceed, DM dm, CeedInt height, 276 DMLabel domain_label, PetscInt value, 277 CeedInt Q, CeedInt q_data_size, 278 CeedElemRestriction *elem_restr_q, 279 CeedElemRestriction *elem_restr_x, 280 CeedElemRestriction *elem_restr_qd_i); 281 282 // Utility function to create CEED Composite Operator for the entire domain 283 PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, 284 CeedData ceed_data, Physics phys, 285 CeedOperator op_apply_vol, 286 CeedOperator op_apply_ijacobian_vol, 287 CeedInt height, 288 CeedInt P_sur, CeedInt Q_sur, 289 CeedInt q_data_size_sur, CeedInt jac_data_size_sur, 290 CeedOperator *op_apply, CeedOperator *op_apply_ijacobian); 291 292 PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, 293 AppCtx app_ctx, ProblemData *problem, SimpleBC bc); 294 295 // ----------------------------------------------------------------------------- 296 // Time-stepping functions 297 // ----------------------------------------------------------------------------- 298 // Compute mass matrix for explicit scheme 299 PetscErrorCode ComputeLumpedMassMatrix(Ceed ceed, DM dm, CeedData ceed_data, 300 Vec M); 301 302 // RHS (Explicit time-stepper) function setup 303 PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data); 304 305 // Implicit time-stepper function setup 306 PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, 307 void *user_data); 308 309 // User provided TS Monitor 310 PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, 311 void *ctx); 312 313 // TS: Create, setup, and solve 314 PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, 315 Vec *Q, PetscScalar *f_time, TS *ts); 316 317 // ----------------------------------------------------------------------------- 318 // Setup DM 319 // ----------------------------------------------------------------------------- 320 // Create mesh 321 PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, 322 MatType, VecType, DM *dm); 323 324 // Set up DM 325 PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, 326 SimpleBC bc, Physics phys); 327 328 // Refine DM for high-order viz 329 PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, 330 SimpleBC bc, Physics phys); 331 332 // ----------------------------------------------------------------------------- 333 // Process command line options 334 // ----------------------------------------------------------------------------- 335 // Register problems to be available on the command line 336 PetscErrorCode RegisterProblems_NS(AppCtx app_ctx); 337 338 // Process general command line options 339 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, 340 SimpleBC bc); 341 342 // ----------------------------------------------------------------------------- 343 // Miscellaneous utility functions 344 // ----------------------------------------------------------------------------- 345 PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, 346 Vec Q_loc, Vec Q, 347 CeedScalar time); 348 349 PetscErrorCode DMPlexInsertBoundaryValues_NS(DM dm, 350 PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, 351 Vec cell_geom_FVM, Vec grad_FVM); 352 353 // Compare reference solution values with current test run for CI 354 PetscErrorCode RegressionTests_NS(AppCtx app_ctx, Vec Q); 355 356 // Get error for problems with exact solutions 357 PetscErrorCode GetError_NS(CeedData ceed_data, DM dm, User user, Vec Q, 358 PetscScalar final_time); 359 360 // Post-processing 361 PetscErrorCode PostProcess_NS(TS ts, CeedData ceed_data, DM dm, 362 ProblemData *problem, User user, 363 Vec Q, PetscScalar final_time); 364 365 // -- Gather initial Q values in case of continuation of simulation 366 PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q); 367 368 // Record boundary values from initial condition 369 PetscErrorCode SetBCsFromICs_NS(DM dm, Vec Q, Vec Q_loc); 370 371 // ----------------------------------------------------------------------------- 372 // Boundary Condition Related Functions 373 // ----------------------------------------------------------------------------- 374 375 // Setup StrongBCs that use QFunctions 376 PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, 377 User user, AppCtx app_ctx, ProblemData *problem, 378 SimpleBC bc, CeedInt Q_sur, CeedInt q_data_size_sur); 379 380 #endif // libceed_fluids_examples_navier_stokes_h 381