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