1 // SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors. 2 // SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause 3 4 /// @file 5 /// Command line option processing for Navier-Stokes example using PETSc 6 7 #include <petscdevice.h> 8 #include <petscsys.h> 9 10 #include <navierstokes.h> 11 12 // Register problems to be available on the command line 13 PetscErrorCode RegisterProblems_NS(AppCtx app_ctx) { 14 app_ctx->problems = NULL; 15 16 PetscFunctionBeginUser; 17 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "density_current", NS_DENSITY_CURRENT)); 18 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "euler_vortex", NS_EULER_VORTEX)); 19 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "shocktube", NS_SHOCKTUBE)); 20 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "advection", NS_ADVECTION)); 21 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "blasius", NS_BLASIUS)); 22 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "channel", NS_CHANNEL)); 23 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "gaussian_wave", NS_GAUSSIAN_WAVE)); 24 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "newtonian", NS_NEWTONIAN_IG)); 25 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "taylor_green", NS_TAYLOR_GREEN)); 26 PetscFunctionReturn(PETSC_SUCCESS); 27 } 28 29 // Process general command line options 30 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc) { 31 PetscBool ceed_flag = PETSC_FALSE; 32 PetscBool problem_flag = PETSC_FALSE; 33 PetscBool option_set = PETSC_FALSE; 34 35 PetscFunctionBeginUser; 36 { 37 PetscInt num_options; 38 39 PetscCall(PetscOptionsLeftGet(NULL, &num_options, NULL, NULL)); 40 PetscCheck(num_options > 0, comm, PETSC_ERR_USER_INPUT, 41 "Command line options required." 42 " Please consult the documentation to see which options are required."); 43 PetscCall(PetscOptionsLeftRestore(NULL, &num_options, NULL, NULL)); 44 } 45 46 PetscOptionsBegin(comm, NULL, "Navier-Stokes in PETSc with libCEED", NULL); 47 48 PetscCall(PetscOptionsString("-ceed", "CEED resource specifier", NULL, app_ctx->ceed_resource, app_ctx->ceed_resource, 49 sizeof(app_ctx->ceed_resource), &ceed_flag)); 50 51 app_ctx->test_type = TESTTYPE_NONE; 52 PetscCall(PetscOptionsEnum("-test_type", "Type of test to run", NULL, TestTypes, (PetscEnum)(app_ctx->test_type), (PetscEnum *)&app_ctx->test_type, 53 NULL)); 54 55 app_ctx->test_tol = 1E-11; 56 PetscCall(PetscOptionsScalar("-compare_final_state_atol", "Test absolute tolerance", NULL, app_ctx->test_tol, &app_ctx->test_tol, NULL)); 57 58 PetscCall(PetscOptionsString("-compare_final_state_filename", "Test filename", NULL, app_ctx->test_file_path, app_ctx->test_file_path, 59 sizeof(app_ctx->test_file_path), NULL)); 60 61 PetscCall(PetscOptionsFList("-problem", "Problem to solve", NULL, app_ctx->problems, app_ctx->problem_name, app_ctx->problem_name, 62 sizeof(app_ctx->problem_name), &problem_flag)); 63 64 app_ctx->viz_refine = 0; 65 PetscCall(PetscOptionsInt("-viz_refine", "Regular refinement levels for visualization", NULL, app_ctx->viz_refine, &app_ctx->viz_refine, NULL)); 66 67 app_ctx->checkpoint_interval = 10; 68 app_ctx->checkpoint_vtk = PETSC_FALSE; 69 PetscCall(PetscOptionsDeprecated("-output_freq", "-checkpoint_interval", "libCEED 0.11.1", "Use -checkpoint_vtk true to include VTK output")); 70 PetscCall(PetscOptionsInt("-output_freq", "Frequency of output, in number of steps", NULL, app_ctx->checkpoint_interval, 71 &app_ctx->checkpoint_interval, &option_set)); 72 if (option_set) app_ctx->checkpoint_vtk = PETSC_TRUE; 73 PetscCall(PetscOptionsInt("-checkpoint_interval", "Frequency of output, in number of steps", NULL, app_ctx->checkpoint_interval, 74 &app_ctx->checkpoint_interval, NULL)); 75 PetscCall(PetscOptionsBool("-checkpoint_vtk", "Include VTK (*.vtu) output at each binary checkpoint", NULL, app_ctx->checkpoint_vtk, 76 &app_ctx->checkpoint_vtk, NULL)); 77 78 PetscCall(PetscOptionsBool("-output_add_stepnum2bin", "Add step number to the binary outputs", NULL, app_ctx->add_stepnum2bin, 79 &app_ctx->add_stepnum2bin, NULL)); 80 81 PetscCall(PetscStrncpy(app_ctx->output_dir, ".", 2)); 82 PetscCall(PetscOptionsString("-output_dir", "Output directory", NULL, app_ctx->output_dir, app_ctx->output_dir, sizeof(app_ctx->output_dir), NULL)); 83 84 app_ctx->cont_steps = 0; 85 PetscCall(PetscOptionsInt("-continue", "Continue from previous solution", NULL, app_ctx->cont_steps, &app_ctx->cont_steps, NULL)); 86 87 PetscCall(PetscStrcpy(app_ctx->cont_file, "[output_dir]/ns-solution.bin")); 88 PetscCall(PetscOptionsString("-continue_filename", "Filename to get initial condition from", NULL, app_ctx->cont_file, app_ctx->cont_file, 89 sizeof(app_ctx->cont_file), &option_set)); 90 if (!option_set) PetscCall(PetscSNPrintf(app_ctx->cont_file, sizeof app_ctx->cont_file, "%s/ns-solution.bin", app_ctx->output_dir)); 91 if (option_set && app_ctx->cont_steps == 0) app_ctx->cont_steps = -1; // Read time from file 92 93 PetscCall( 94 PetscOptionsDeprecated("-continue_time_filename", NULL, "HONEE 0.0.0", "HONEE no longer supports reading in solution times from binary file")); 95 96 app_ctx->degree = 1; 97 PetscCall(PetscOptionsInt("-degree", "Polynomial degree of finite elements", NULL, app_ctx->degree, &app_ctx->degree, NULL)); 98 99 app_ctx->q_extra = 0; 100 PetscCall(PetscOptionsInt("-q_extra", "Number of extra quadrature points", NULL, app_ctx->q_extra, &app_ctx->q_extra, NULL)); 101 102 { 103 PetscBool option_set; 104 char amat_type[256] = ""; 105 PetscCall(PetscOptionsFList("-amat_type", "Set the type of Amat distinct from Pmat (-dm_mat_type)", NULL, MatList, amat_type, amat_type, 106 sizeof(amat_type), &option_set)); 107 if (option_set) PetscCall(PetscStrallocpy(amat_type, (char **)&app_ctx->amat_type)); 108 } 109 { 110 PetscBool option_set; 111 PetscCall(PetscOptionsHasName(NULL, NULL, "-pmat_pbdiagonal", &option_set)); 112 if (option_set) PetscCall(PetscPrintf(comm, "Warning! -pmat_pbdiagonal no longer used. Pmat assembly determined from -pc_type setting\n")); 113 } 114 115 // Provide default ceed resource if not specified 116 if (!ceed_flag) { 117 const char *ceed_resource = "/cpu/self"; 118 strncpy(app_ctx->ceed_resource, ceed_resource, 10); 119 } 120 // If we request a GPU, make sure PETSc has initialized its device (which is 121 // MPI-aware in case multiple devices are available) before CeedInit so that 122 // PETSc and libCEED agree about which device to use. 123 if (strncmp(app_ctx->ceed_resource, "/gpu", 4) == 0) PetscCall(PetscDeviceInitialize(PETSC_DEVICE_DEFAULT())); 124 125 // Provide default problem if not specified 126 if (!problem_flag) { 127 const char *problem_name = "density_current"; 128 strncpy(app_ctx->problem_name, problem_name, 16); 129 } 130 131 // Statistics Options 132 app_ctx->turb_spanstats_collect_interval = 1; 133 PetscCall(PetscOptionsInt("-ts_monitor_turbulence_spanstats_collect_interval", "Number of timesteps between statistics collection", NULL, 134 app_ctx->turb_spanstats_collect_interval, &app_ctx->turb_spanstats_collect_interval, NULL)); 135 136 app_ctx->turb_spanstats_viewer_interval = -1; 137 PetscCall(PetscOptionsInt("-ts_monitor_turbulence_spanstats_viewer_interval", "Number of timesteps between statistics viewer writing", NULL, 138 app_ctx->turb_spanstats_viewer_interval, &app_ctx->turb_spanstats_viewer_interval, NULL)); 139 140 PetscCall(PetscOptionsViewer("-ts_monitor_turbulence_spanstats_viewer", "Viewer for the statistics", NULL, &app_ctx->turb_spanstats_viewer, 141 &app_ctx->turb_spanstats_viewer_format, &app_ctx->turb_spanstats_enable)); 142 143 PetscCall(PetscOptionsViewer("-ts_monitor_wall_force", "Viewer for force on each (no-slip) wall", NULL, &app_ctx->wall_forces.viewer, 144 &app_ctx->wall_forces.viewer_format, NULL)); 145 146 // SGS Model Options 147 app_ctx->sgs_model_type = SGS_MODEL_NONE; 148 PetscCall(PetscOptionsEnum("-sgs_model_type", "Subgrid Stress Model type", NULL, SGSModelTypes, (PetscEnum)app_ctx->sgs_model_type, 149 (PetscEnum *)&app_ctx->sgs_model_type, NULL)); 150 151 PetscCall(PetscOptionsBool("-diff_filter_monitor", "Enable differential filtering TSMonitor", NULL, app_ctx->diff_filter_monitor, 152 &app_ctx->diff_filter_monitor, NULL)); 153 154 // Mesh Transformation Options 155 app_ctx->mesh_transform_type = MESH_TRANSFORM_NONE; 156 PetscCall(PetscOptionsEnum("-mesh_transform", "Mesh transform to perform", NULL, MeshTransformTypes, (PetscEnum)app_ctx->mesh_transform_type, 157 (PetscEnum *)&app_ctx->mesh_transform_type, NULL)); 158 159 PetscCall( 160 PetscOptionsBool("-sgs_train_enable", "Enable Data-Driven SGS training", NULL, app_ctx->sgs_train_enable, &app_ctx->sgs_train_enable, NULL)); 161 162 PetscCall(PetscOptionsEnum("-div_diff_flux_projection_method", "Method of divergence of diffusive flux projection", NULL, 163 DivDiffFluxProjectionMethods, (PetscEnum)(app_ctx->divFdiffproj_method), (PetscEnum *)&app_ctx->divFdiffproj_method, 164 NULL)); 165 166 PetscOptionsEnd(); 167 PetscFunctionReturn(PETSC_SUCCESS); 168 } 169