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