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 /// @file 9 /// Command line option processing for Navier-Stokes example using PETSc 10 11 #include <petscdevice.h> 12 #include <petscsys.h> 13 14 #include "../navierstokes.h" 15 16 // Register problems to be available on the command line 17 PetscErrorCode RegisterProblems_NS(AppCtx app_ctx) { 18 app_ctx->problems = NULL; 19 PetscFunctionBeginUser; 20 21 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "density_current", NS_DENSITY_CURRENT)); 22 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "euler_vortex", NS_EULER_VORTEX)); 23 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "shocktube", NS_SHOCKTUBE)); 24 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "advection", NS_ADVECTION)); 25 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "advection2d", NS_ADVECTION2D)); 26 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "blasius", NS_BLASIUS)); 27 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "channel", NS_CHANNEL)); 28 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "gaussian_wave", NS_GAUSSIAN_WAVE)); 29 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "newtonian", NS_NEWTONIAN_IG)); 30 PetscCall(PetscFunctionListAdd(&app_ctx->problems, "taylor_green", NS_TAYLOR_GREEN)); 31 32 PetscFunctionReturn(PETSC_SUCCESS); 33 } 34 35 // Process general command line options 36 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc) { 37 PetscBool ceed_flag = PETSC_FALSE; 38 PetscBool problem_flag = PETSC_FALSE; 39 PetscBool option_set = PETSC_FALSE; 40 41 PetscFunctionBeginUser; 42 43 PetscOptionsBegin(comm, NULL, "Navier-Stokes in PETSc with libCEED", NULL); 44 45 PetscCall(PetscOptionsString("-ceed", "CEED resource specifier", NULL, app_ctx->ceed_resource, app_ctx->ceed_resource, 46 sizeof(app_ctx->ceed_resource), &ceed_flag)); 47 48 app_ctx->test_type = TESTTYPE_NONE; 49 PetscCall(PetscOptionsEnum("-test_type", "Type of test to run", NULL, TestTypes, (PetscEnum)(app_ctx->test_type), (PetscEnum *)&app_ctx->test_type, 50 NULL)); 51 52 app_ctx->test_tol = 1E-11; 53 PetscCall(PetscOptionsScalar("-compare_final_state_atol", "Test absolute tolerance", NULL, app_ctx->test_tol, &app_ctx->test_tol, NULL)); 54 55 PetscCall(PetscOptionsString("-compare_final_state_filename", "Test filename", NULL, app_ctx->test_file_path, app_ctx->test_file_path, 56 sizeof(app_ctx->test_file_path), NULL)); 57 58 PetscCall(PetscOptionsFList("-problem", "Problem to solve", NULL, app_ctx->problems, app_ctx->problem_name, app_ctx->problem_name, 59 sizeof(app_ctx->problem_name), &problem_flag)); 60 61 app_ctx->viz_refine = 0; 62 PetscCall(PetscOptionsInt("-viz_refine", "Regular refinement levels for visualization", NULL, app_ctx->viz_refine, &app_ctx->viz_refine, NULL)); 63 64 app_ctx->checkpoint_interval = 10; 65 app_ctx->checkpoint_vtk = PETSC_FALSE; 66 PetscCall(PetscOptionsDeprecated("-output_freq", "-checkpoint_interval", "libCEED 0.11.1", "Use -checkpoint_vtk true to include VTK output")); 67 PetscCall(PetscOptionsInt("-output_freq", "Frequency of output, in number of steps", NULL, app_ctx->checkpoint_interval, 68 &app_ctx->checkpoint_interval, &option_set)); 69 if (option_set) app_ctx->checkpoint_vtk = PETSC_TRUE; 70 PetscCall(PetscOptionsInt("-checkpoint_interval", "Frequency of output, in number of steps", NULL, app_ctx->checkpoint_interval, 71 &app_ctx->checkpoint_interval, NULL)); 72 PetscCall(PetscOptionsBool("-checkpoint_vtk", "Include VTK (*.vtu) output at each binary checkpoint", NULL, app_ctx->checkpoint_vtk, 73 &app_ctx->checkpoint_vtk, NULL)); 74 75 PetscCall(PetscOptionsBool("-output_add_stepnum2bin", "Add step number to the binary outputs", NULL, app_ctx->add_stepnum2bin, 76 &app_ctx->add_stepnum2bin, NULL)); 77 78 PetscCall(PetscStrncpy(app_ctx->output_dir, ".", 2)); 79 PetscCall(PetscOptionsString("-output_dir", "Output directory", NULL, app_ctx->output_dir, app_ctx->output_dir, sizeof(app_ctx->output_dir), NULL)); 80 81 app_ctx->cont_steps = 0; 82 PetscCall(PetscOptionsInt("-continue", "Continue from previous solution", NULL, app_ctx->cont_steps, &app_ctx->cont_steps, NULL)); 83 84 PetscCall(PetscStrcpy(app_ctx->cont_file, "[output_dir]/ns-solution.bin")); 85 PetscCall(PetscOptionsString("-continue_filename", "Filename to get initial condition from", NULL, app_ctx->cont_file, app_ctx->cont_file, 86 sizeof(app_ctx->cont_file), &option_set)); 87 if (!option_set) PetscCall(PetscSNPrintf(app_ctx->cont_file, sizeof app_ctx->cont_file, "%s/ns-solution.bin", app_ctx->output_dir)); 88 if (option_set && app_ctx->cont_steps == 0) app_ctx->cont_steps = -1; // Read time from file 89 90 PetscCall(PetscStrcpy(app_ctx->cont_time_file, "[output_dir]/ns-time.bin")); 91 PetscCall(PetscOptionsString("-continue_time_filename", "Filename to get initial condition time from", NULL, app_ctx->cont_time_file, 92 app_ctx->cont_time_file, sizeof(app_ctx->cont_time_file), &option_set)); 93 if (!option_set) PetscCall(PetscSNPrintf(app_ctx->cont_time_file, sizeof app_ctx->cont_time_file, "%s/ns-time.bin", app_ctx->output_dir)); 94 95 app_ctx->degree = 1; 96 PetscCall(PetscOptionsInt("-degree", "Polynomial degree of finite elements", NULL, app_ctx->degree, &app_ctx->degree, NULL)); 97 98 app_ctx->q_extra = 0; 99 PetscCall(PetscOptionsInt("-q_extra", "Number of extra quadrature points", NULL, app_ctx->q_extra, &app_ctx->q_extra, NULL)); 100 101 { 102 PetscBool option_set; 103 char amat_type[256] = ""; 104 PetscCall(PetscOptionsFList("-amat_type", "Set the type of Amat distinct from Pmat (-dm_mat_type)", NULL, MatList, amat_type, amat_type, 105 sizeof(amat_type), &option_set)); 106 if (option_set) PetscCall(PetscStrallocpy(amat_type, (char **)&app_ctx->amat_type)); 107 } 108 PetscCall(PetscOptionsBool("-pmat_pbdiagonal", "Assemble only point-block diagonal for Pmat", NULL, app_ctx->pmat_pbdiagonal, 109 &app_ctx->pmat_pbdiagonal, NULL)); 110 111 // Provide default ceed resource if not specified 112 if (!ceed_flag) { 113 const char *ceed_resource = "/cpu/self"; 114 strncpy(app_ctx->ceed_resource, ceed_resource, 10); 115 } 116 // If we request a GPU, make sure PETSc has initialized its device (which is 117 // MPI-aware in case multiple devices are available) before CeedInit so that 118 // PETSc and libCEED agree about which device to use. 119 if (strncmp(app_ctx->ceed_resource, "/gpu", 4) == 0) PetscCall(PetscDeviceInitialize(PETSC_DEVICE_DEFAULT())); 120 121 // Provide default problem if not specified 122 if (!problem_flag) { 123 const char *problem_name = "density_current"; 124 strncpy(app_ctx->problem_name, problem_name, 16); 125 } 126 127 // Wall Boundary Conditions 128 bc->num_wall = 16; 129 PetscBool flg; 130 PetscCall(PetscOptionsIntArray("-bc_wall", "Face IDs to apply wall BC", NULL, bc->walls, &bc->num_wall, NULL)); 131 bc->num_comps = 5; 132 PetscCall(PetscOptionsIntArray("-wall_comps", "An array of constrained component numbers", NULL, bc->wall_comps, &bc->num_comps, &flg)); 133 // Slip Boundary Conditions 134 for (PetscInt j = 0; j < 3; j++) { 135 bc->num_slip[j] = 16; 136 PetscBool flg; 137 const char *flags[3] = {"-bc_slip_x", "-bc_slip_y", "-bc_slip_z"}; 138 PetscCall(PetscOptionsIntArray(flags[j], "Face IDs to apply slip BC", NULL, bc->slips[j], &bc->num_slip[j], &flg)); 139 if (flg) bc->user_bc = PETSC_TRUE; 140 } 141 142 // Error if wall and slip BCs are set on the same face 143 if (bc->user_bc) { 144 for (PetscInt c = 0; c < 3; c++) { 145 for (PetscInt s = 0; s < bc->num_slip[c]; s++) { 146 for (PetscInt w = 0; w < bc->num_wall; w++) { 147 PetscCheck(bc->slips[c][s] != bc->walls[w], PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, 148 "Boundary condition already set on face %" PetscInt_FMT "!\n", bc->walls[w]); 149 } 150 } 151 } 152 } 153 app_ctx->wall_forces.num_wall = bc->num_wall; 154 PetscMalloc1(bc->num_wall, &app_ctx->wall_forces.walls); 155 PetscCall(PetscArraycpy(app_ctx->wall_forces.walls, bc->walls, bc->num_wall)); 156 157 // Inflow BCs 158 bc->num_inflow = 16; 159 PetscCall(PetscOptionsIntArray("-bc_inflow", "Face IDs to apply inflow BC", NULL, bc->inflows, &bc->num_inflow, NULL)); 160 // Outflow BCs 161 bc->num_outflow = 16; 162 PetscCall(PetscOptionsIntArray("-bc_outflow", "Face IDs to apply outflow BC", NULL, bc->outflows, &bc->num_outflow, NULL)); 163 // Freestream BCs 164 bc->num_freestream = 16; 165 PetscCall(PetscOptionsIntArray("-bc_freestream", "Face IDs to apply freestream BC", NULL, bc->freestreams, &bc->num_freestream, NULL)); 166 167 // Statistics Options 168 app_ctx->turb_spanstats_collect_interval = 1; 169 PetscCall(PetscOptionsInt("-ts_monitor_turbulence_spanstats_collect_interval", "Number of timesteps between statistics collection", NULL, 170 app_ctx->turb_spanstats_collect_interval, &app_ctx->turb_spanstats_collect_interval, NULL)); 171 172 app_ctx->turb_spanstats_viewer_interval = -1; 173 PetscCall(PetscOptionsInt("-ts_monitor_turbulence_spanstats_viewer_interval", "Number of timesteps between statistics viewer writing", NULL, 174 app_ctx->turb_spanstats_viewer_interval, &app_ctx->turb_spanstats_viewer_interval, NULL)); 175 176 PetscCall(PetscOptionsViewer("-ts_monitor_turbulence_spanstats_viewer", "Viewer for the statistics", NULL, &app_ctx->turb_spanstats_viewer, 177 &app_ctx->turb_spanstats_viewer_format, &app_ctx->turb_spanstats_enable)); 178 179 PetscCall(PetscOptionsViewer("-ts_monitor_wall_force", "Viewer for force on each (no-slip) wall", NULL, &app_ctx->wall_forces.viewer, 180 &app_ctx->wall_forces.viewer_format, NULL)); 181 182 // SGS Model Options 183 app_ctx->sgs_model_type = SGS_MODEL_NONE; 184 PetscCall(PetscOptionsEnum("-sgs_model_type", "Subgrid Stress Model type", NULL, SGSModelTypes, (PetscEnum)app_ctx->sgs_model_type, 185 (PetscEnum *)&app_ctx->sgs_model_type, NULL)); 186 187 PetscCall(PetscOptionsBool("-diff_filter_monitor", "Enable differential filtering TSMonitor", NULL, app_ctx->diff_filter_monitor, 188 &app_ctx->diff_filter_monitor, NULL)); 189 190 // Mesh Transformation Options 191 app_ctx->mesh_transform_type = MESH_TRANSFORM_NONE; 192 PetscCall(PetscOptionsEnum("-mesh_transform", "Mesh transform to perform", NULL, MeshTransformTypes, (PetscEnum)app_ctx->mesh_transform_type, 193 (PetscEnum *)&app_ctx->mesh_transform_type, NULL)); 194 195 PetscOptionsEnd(); 196 197 PetscFunctionReturn(PETSC_SUCCESS); 198 } 199