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 HONEE 6 7 #include <ctype.h> 8 #include <petscdevice.h> 9 #include <petscsys.h> 10 11 #include <navierstokes.h> 12 13 // Register problems to be available on the command line 14 static PetscErrorCode RegisterProblems_NS(AppCtx app_ctx) { 15 app_ctx->problems = NULL; 16 17 PetscFunctionBeginUser; 18 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "density_current", NS_DENSITY_CURRENT)); 19 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "euler_vortex", NS_EULER_VORTEX)); 20 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "shocktube", NS_SHOCKTUBE)); 21 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "advection", NS_ADVECTION)); 22 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "blasius", NS_BLASIUS)); 23 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "channel", NS_CHANNEL)); 24 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "gaussian_wave", NS_GAUSSIAN_WAVE)); 25 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "newtonian", NS_NEWTONIAN_IG)); 26 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "taylor_green", NS_TAYLOR_GREEN)); 27 PetscFunctionReturn(PETSC_SUCCESS); 28 } 29 30 /** 31 @brief Convert ISO 8601 time string to duration in seconds 32 33 Accepted formats are 'hh', 'hh:mm', and 'hh:mm:ss'. 34 35 @param[in] comm MPI_Comm for error handling 36 @param[in] string string of the ISO 8601 duration 37 @param[out] duration Duration in number of seconds 38 **/ 39 PetscErrorCode ISO8601TimeDurationToSeconds(MPI_Comm comm, const char *string, time_t *duration) { 40 int num_items; 41 char **entries; 42 43 PetscFunctionBeginUser; 44 if (string[0] == '\0') { 45 *duration = 0; 46 PetscFunctionReturn(PETSC_SUCCESS); 47 } 48 for (PetscInt i = 0; i < strlen(string); i++) { 49 PetscCheck(isdigit(string[i]) || string[i] == ':', comm, PETSC_ERR_SUP, "Time duration may only include digits and ':' separator, found '%c'", 50 string[i]); 51 } 52 PetscCall(PetscStrToArray(string, ':', &num_items, &entries)); 53 switch (num_items) { 54 case 1: // Only hours 55 *duration = 60 * 60 * atoi(entries[0]); 56 break; 57 case 2: // Hours and Minutes 58 *duration = 60 * 60 * atoi(entries[0]) + 60 * atoi(entries[1]); 59 break; 60 case 3: // Hours, Minutes, and Seconds 61 *duration = 60 * 60 * atoi(entries[0]) + 60 * atoi(entries[1]) + atoi(entries[2]); 62 break; 63 default: 64 SETERRQ(comm, PETSC_ERR_SUP, "Recieved %d ':' delimited entries, expect either 1, 2, or 3", num_items); 65 } 66 PetscCall(PetscStrToArrayDestroy(num_items, entries)); 67 PetscFunctionReturn(PETSC_SUCCESS); 68 } 69 70 // Process general command line options 71 PetscErrorCode ProcessCommandLineOptions(Honee honee, SimpleBC bc) { 72 MPI_Comm comm = honee->comm; 73 AppCtx app_ctx = honee->app_ctx; 74 PetscBool ceed_flag = PETSC_FALSE; 75 PetscBool problem_flag = PETSC_FALSE; 76 PetscBool option_set = PETSC_FALSE; 77 78 PetscFunctionBeginUser; 79 { 80 PetscInt num_options; 81 PetscBool help_set; 82 83 PetscCall(PetscOptionsHasHelp(NULL, &help_set)); 84 if (help_set) { 85 PetscCall(PetscOptionsSetValue(NULL, "-ts_max_steps", "0")); 86 } else { 87 PetscCall(PetscOptionsLeftGet(NULL, &num_options, NULL, NULL)); 88 PetscCheck(num_options > 0, comm, PETSC_ERR_USER_INPUT, 89 "Command line options required." 90 " Please consult the documentation to see which options are required."); 91 PetscCall(PetscOptionsLeftRestore(NULL, &num_options, NULL, NULL)); 92 } 93 } 94 95 PetscCall(RegisterProblems_NS(app_ctx)); 96 PetscOptionsBegin(comm, NULL, "HONEE - High-Order Navier-stokes Equation Evaluator", NULL); 97 98 PetscCall(PetscOptionsString("-ceed", "CEED resource specifier", NULL, app_ctx->ceed_resource, app_ctx->ceed_resource, 99 sizeof(app_ctx->ceed_resource), &ceed_flag)); 100 101 app_ctx->test_type = TESTTYPE_NONE; 102 PetscCall(PetscOptionsEnum("-test_type", "Type of test to run", NULL, TestTypes, (PetscEnum)(app_ctx->test_type), (PetscEnum *)&app_ctx->test_type, 103 NULL)); 104 105 app_ctx->test_tol = 1E-11; 106 PetscCall(PetscOptionsScalar("-compare_final_state_atol", "Test absolute tolerance", NULL, app_ctx->test_tol, &app_ctx->test_tol, NULL)); 107 108 PetscCall(PetscOptionsString("-compare_final_state_filename", "Test filename", NULL, app_ctx->test_file_path, app_ctx->test_file_path, 109 sizeof(app_ctx->test_file_path), NULL)); 110 111 PetscCall(PetscOptionsFList("-problem", "Problem to solve", NULL, app_ctx->problems, app_ctx->problem_name, app_ctx->problem_name, 112 sizeof(app_ctx->problem_name), &problem_flag)); 113 114 app_ctx->viz_refine = 0; 115 PetscCall(PetscOptionsInt("-viz_refine", "Regular refinement levels for visualization", NULL, app_ctx->viz_refine, &app_ctx->viz_refine, NULL)); 116 117 app_ctx->checkpoint_interval = 0; 118 app_ctx->checkpoint_vtk = PETSC_FALSE; 119 PetscCall(PetscOptionsDeprecated("-output_freq", "-checkpoint_interval", "libCEED 0.11.1", "Use -checkpoint_vtk true to include VTK output")); 120 PetscCall(PetscOptionsInt("-output_freq", "Frequency of output, in number of steps", NULL, app_ctx->checkpoint_interval, 121 &app_ctx->checkpoint_interval, &option_set)); 122 if (option_set) app_ctx->checkpoint_vtk = PETSC_TRUE; 123 PetscCall(PetscOptionsInt("-checkpoint_interval", "Frequency of output, in number of steps", NULL, app_ctx->checkpoint_interval, 124 &app_ctx->checkpoint_interval, NULL)); 125 PetscCall(PetscOptionsBool("-checkpoint_vtk", "Include VTK (*.vtu) output at each binary checkpoint", NULL, app_ctx->checkpoint_vtk, 126 &app_ctx->checkpoint_vtk, NULL)); 127 128 PetscCall(PetscOptionsBool("-output_add_stepnum2bin", "Add step number to the binary outputs", NULL, app_ctx->add_stepnum2bin, 129 &app_ctx->add_stepnum2bin, NULL)); 130 131 PetscCall(PetscStrncpy(app_ctx->output_dir, ".", 2)); 132 PetscCall(PetscOptionsString("-output_dir", "Output directory", NULL, app_ctx->output_dir, app_ctx->output_dir, sizeof(app_ctx->output_dir), NULL)); 133 PetscMPIInt rank; 134 MPI_Comm_rank(comm, &rank); 135 if (!rank) PetscCall(PetscMkdir(app_ctx->output_dir)); 136 137 PetscCall(PetscOptionsString("-continue_filename", "Filename to get initial condition from", NULL, app_ctx->cont_file, app_ctx->cont_file, 138 sizeof(app_ctx->cont_file), NULL)); 139 if (app_ctx->cont_file[0] != '\0') app_ctx->use_continue_file = PETSC_TRUE; 140 141 PetscCall( 142 PetscOptionsDeprecated("-continue", NULL, "HONEE 0.0.0", "Set -continue_filename to non-empty string to continue from previous solution")); 143 PetscCall( 144 PetscOptionsDeprecated("-continue_time_filename", NULL, "HONEE 0.0.0", "HONEE no longer supports reading in solution times from binary file")); 145 146 app_ctx->degree = 1; 147 PetscCall(PetscOptionsInt("-degree", "Polynomial degree of finite elements", NULL, app_ctx->degree, &app_ctx->degree, NULL)); 148 149 app_ctx->q_extra = 0; 150 PetscCall(PetscOptionsInt("-q_extra", "Number of extra quadrature points", NULL, app_ctx->q_extra, &app_ctx->q_extra, NULL)); 151 152 { 153 PetscBool option_set; 154 char amat_type[256] = ""; 155 PetscCall(PetscOptionsFList("-amat_type", "Set the type of Amat distinct from Pmat (-dm_mat_type)", NULL, MatList, amat_type, amat_type, 156 sizeof(amat_type), &option_set)); 157 if (option_set) PetscCall(PetscStrallocpy(amat_type, (char **)&app_ctx->amat_type)); 158 } 159 { 160 PetscBool option_set; 161 PetscCall(PetscOptionsHasName(NULL, NULL, "-pmat_pbdiagonal", &option_set)); 162 if (option_set) PetscCall(PetscPrintf(comm, "Warning! -pmat_pbdiagonal no longer used. Pmat assembly determined from -pc_type setting\n")); 163 } 164 165 // Provide default ceed resource if not specified 166 if (!ceed_flag) { 167 const char *ceed_resource = "/cpu/self"; 168 strncpy(app_ctx->ceed_resource, ceed_resource, 10); 169 } 170 // If we request a GPU, make sure PETSc has initialized its device (which is 171 // MPI-aware in case multiple devices are available) before CeedInit so that 172 // PETSc and libCEED agree about which device to use. 173 if (strncmp(app_ctx->ceed_resource, "/gpu", 4) == 0) PetscCall(PetscDeviceInitialize(PETSC_DEVICE_DEFAULT())); 174 175 // Provide default problem if not specified 176 if (!problem_flag) { 177 const char *problem_name = "density_current"; 178 strncpy(app_ctx->problem_name, problem_name, 16); 179 } 180 181 // Statistics Options 182 app_ctx->turb_spanstats_collect_interval = 1; 183 PetscCall(PetscOptionsInt("-ts_monitor_turbulence_spanstats_collect_interval", "Number of timesteps between statistics collection", NULL, 184 app_ctx->turb_spanstats_collect_interval, &app_ctx->turb_spanstats_collect_interval, NULL)); 185 186 app_ctx->turb_spanstats_viewer_interval = -1; 187 PetscCall(PetscOptionsInt("-ts_monitor_turbulence_spanstats_viewer_interval", "Number of timesteps between statistics viewer writing", NULL, 188 app_ctx->turb_spanstats_viewer_interval, &app_ctx->turb_spanstats_viewer_interval, NULL)); 189 190 PetscCall(PetscOptionsViewer("-ts_monitor_turbulence_spanstats_viewer", "Viewer for the statistics", NULL, &app_ctx->turb_spanstats_viewer, 191 &app_ctx->turb_spanstats_viewer_format, &app_ctx->turb_spanstats_enable)); 192 193 PetscCall(PetscOptionsViewer("-ts_monitor_wall_force", "Viewer for force on each (no-slip) wall", NULL, &app_ctx->wall_forces.viewer, 194 &app_ctx->wall_forces.viewer_format, NULL)); 195 196 // SGS Model Options 197 app_ctx->sgs_model_type = SGS_MODEL_NONE; 198 PetscCall(PetscOptionsEnum("-sgs_model_type", "Subgrid Stress Model type", NULL, SGSModelTypes, (PetscEnum)app_ctx->sgs_model_type, 199 (PetscEnum *)&app_ctx->sgs_model_type, NULL)); 200 201 PetscCall(PetscOptionsBool("-diff_filter_monitor", "Enable differential filtering TSMonitor", NULL, app_ctx->diff_filter_monitor, 202 &app_ctx->diff_filter_monitor, NULL)); 203 204 // Mesh Transformation Options 205 app_ctx->mesh_transform_type = MESH_TRANSFORM_NONE; 206 PetscCall(PetscOptionsEnum("-mesh_transform", "Mesh transform to perform", NULL, MeshTransformTypes, (PetscEnum)app_ctx->mesh_transform_type, 207 (PetscEnum *)&app_ctx->mesh_transform_type, NULL)); 208 209 PetscCall( 210 PetscOptionsBool("-sgs_train_enable", "Enable Data-Driven SGS training", NULL, app_ctx->sgs_train_enable, &app_ctx->sgs_train_enable, NULL)); 211 if (app_ctx->sgs_train_enable) honee->set_poststep = PETSC_TRUE; 212 213 PetscCall(PetscOptionsEnum("-div_diff_flux_projection_method", "Method of divergence of diffusive flux projection", NULL, 214 DivDiffFluxProjectionMethods, (PetscEnum)(app_ctx->divFdiffproj_method), (PetscEnum *)&app_ctx->divFdiffproj_method, 215 NULL)); 216 217 app_ctx->check_step_interval = -1; 218 PetscCall(PetscOptionsDeprecated("-ts_monitor_nan_interval", "-honee_check_step_interval", "HONEE 0.0", NULL)); 219 PetscCall(PetscOptionsInt("-honee_check_step_interval", "Number of timesteps between verifying the validity of the solution", NULL, 220 app_ctx->check_step_interval, &app_ctx->check_step_interval, NULL)); 221 if (app_ctx->check_step_interval > 0) honee->set_poststep = PETSC_TRUE; 222 223 { 224 char buffer[2048] = "0"; 225 time_t max_wall_time_buffer, max_wall_time_duration; 226 PetscCall(PetscOptionsString("-honee_max_wall_time_duration", "Maximum wall time duration HONEE should wait before stopping TSSolve", NULL, 227 buffer, buffer, sizeof(buffer), NULL)); 228 PetscCall(ISO8601TimeDurationToSeconds(comm, buffer, &max_wall_time_duration)); 229 PetscCall(PetscStrncpy(buffer, "0:1", sizeof(buffer))); // Default 1 minute buffer 230 PetscCall(PetscOptionsString("-honee_max_wall_time_buffer", 231 "Time before max_wall_time_duration when TSSolve should be stopped and checkpoint files written", NULL, buffer, 232 buffer, sizeof(buffer), NULL)); 233 PetscCall(ISO8601TimeDurationToSeconds(comm, buffer, &max_wall_time_buffer)); 234 if (max_wall_time_duration == 0) honee->max_wall_time = -1; 235 else { 236 honee->set_poststep = PETSC_TRUE; 237 honee->max_wall_time = honee->start_time + max_wall_time_duration - max_wall_time_buffer; 238 } 239 240 honee->max_wall_time_interval = 1; 241 PetscCall(PetscOptionsInt("-honee_max_wall_time_interval", 242 "Number of timesteps between checking whether TSSolve should be stopped due to max_wall_time", NULL, 243 honee->max_wall_time_interval, &honee->max_wall_time_interval, NULL)); 244 } 245 246 PetscOptionsEnd(); 247 PetscFunctionReturn(PETSC_SUCCESS); 248 } 249