xref: /libCEED/examples/fluids/src/cloptions.c (revision 8ec64e9ae9d5df169dba8c8ee61d8ec8907b8f80)
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 
13 #include "../navierstokes.h"
14 
15 // Register problems to be available on the command line
16 PetscErrorCode RegisterProblems_NS(AppCtx app_ctx) {
17   app_ctx->problems = NULL;
18   PetscFunctionBeginUser;
19 
20   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "density_current", NS_DENSITY_CURRENT));
21   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "euler_vortex", NS_EULER_VORTEX));
22   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "shocktube", NS_SHOCKTUBE));
23   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "advection", NS_ADVECTION));
24   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "advection2d", NS_ADVECTION2D));
25   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "blasius", NS_BLASIUS));
26   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "channel", NS_CHANNEL));
27   PetscCall(PetscFunctionListAdd(&app_ctx->problems, "newtonian_wave", NS_NEWTONIAN_WAVE));
28 
29   PetscFunctionReturn(0);
30 }
31 
32 // Process general command line options
33 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc) {
34   PetscBool ceed_flag    = PETSC_FALSE;
35   PetscBool problem_flag = PETSC_FALSE;
36   PetscBool option_set   = PETSC_FALSE;
37 
38   PetscFunctionBeginUser;
39 
40   PetscOptionsBegin(comm, NULL, "Navier-Stokes in PETSc with libCEED", NULL);
41 
42   PetscCall(PetscOptionsString("-ceed", "CEED resource specifier", NULL, app_ctx->ceed_resource, app_ctx->ceed_resource,
43                                sizeof(app_ctx->ceed_resource), &ceed_flag));
44 
45   app_ctx->test_mode = PETSC_FALSE;
46   PetscCall(PetscOptionsBool("-test", "Run in test mode", NULL, app_ctx->test_mode, &app_ctx->test_mode, NULL));
47 
48   app_ctx->test_tol = 1E-11;
49   PetscCall(PetscOptionsScalar("-compare_final_state_atol", "Test absolute tolerance", NULL, app_ctx->test_tol, &app_ctx->test_tol, NULL));
50 
51   PetscCall(PetscOptionsString("-compare_final_state_filename", "Test filename", NULL, app_ctx->file_path, app_ctx->file_path,
52                                sizeof(app_ctx->file_path), NULL));
53 
54   PetscCall(PetscOptionsFList("-problem", "Problem to solve", NULL, app_ctx->problems, app_ctx->problem_name, app_ctx->problem_name,
55                               sizeof(app_ctx->problem_name), &problem_flag));
56 
57   app_ctx->viz_refine = 0;
58   PetscCall(PetscOptionsInt("-viz_refine", "Regular refinement levels for visualization", NULL, app_ctx->viz_refine, &app_ctx->viz_refine, NULL));
59 
60   app_ctx->output_freq = 10;
61   PetscCall(PetscOptionsInt("-output_freq", "Frequency of output, in number of steps", NULL, app_ctx->output_freq, &app_ctx->output_freq, NULL));
62 
63   PetscCall(PetscOptionsBool("-output_add_stepnum2bin", "Add step number to the binary outputs", NULL, app_ctx->add_stepnum2bin,
64                              &app_ctx->add_stepnum2bin, NULL));
65 
66   PetscCall(PetscStrncpy(app_ctx->output_dir, ".", 2));
67   PetscCall(PetscOptionsString("-output_dir", "Output directory", NULL, app_ctx->output_dir, app_ctx->output_dir, sizeof(app_ctx->output_dir), NULL));
68 
69   app_ctx->cont_steps = 0;
70   PetscCall(PetscOptionsInt("-continue", "Continue from previous solution", NULL, app_ctx->cont_steps, &app_ctx->cont_steps, NULL));
71 
72   PetscCall(PetscStrcpy(app_ctx->cont_file, "[output_dir]/ns-solution.bin"));
73   PetscCall(PetscOptionsString("-continue_filename", "Filename to get initial condition from", NULL, app_ctx->cont_file, app_ctx->cont_file,
74                                sizeof(app_ctx->cont_file), &option_set));
75   if (!option_set) PetscCall(PetscSNPrintf(app_ctx->cont_file, sizeof app_ctx->cont_file, "%s/ns-solution.bin", app_ctx->output_dir));
76 
77   PetscCall(PetscStrcpy(app_ctx->cont_time_file, "[output_dir]/ns-time.bin"));
78   PetscCall(PetscOptionsString("-continue_time_filename", "Filename to get initial condition time from", NULL, app_ctx->cont_time_file,
79                                app_ctx->cont_time_file, sizeof(app_ctx->cont_time_file), &option_set));
80   if (!option_set) PetscCall(PetscSNPrintf(app_ctx->cont_time_file, sizeof app_ctx->cont_time_file, "%s/ns-time.bin", app_ctx->output_dir));
81 
82   app_ctx->degree = 1;
83   PetscCall(PetscOptionsInt("-degree", "Polynomial degree of finite elements", NULL, app_ctx->degree, &app_ctx->degree, NULL));
84 
85   app_ctx->q_extra = 0;
86   PetscCall(PetscOptionsInt("-q_extra", "Number of extra quadrature points", NULL, app_ctx->q_extra, &app_ctx->q_extra, NULL));
87 
88   {
89     PetscBool option_set;
90     char      amat_type[256] = "";
91     PetscCall(PetscOptionsFList("-amat_type", "Set the type of Amat distinct from Pmat (-dm_mat_type)", NULL, MatList, amat_type, amat_type,
92                                 sizeof(amat_type), &option_set));
93     if (option_set) PetscCall(PetscStrallocpy(amat_type, (char **)&app_ctx->amat_type));
94   }
95   PetscCall(PetscOptionsBool("-pmat_pbdiagonal", "Assemble only point-block diagonal for Pmat", NULL, app_ctx->pmat_pbdiagonal,
96                              &app_ctx->pmat_pbdiagonal, NULL));
97 
98   // Provide default ceed resource if not specified
99   if (!ceed_flag) {
100     const char *ceed_resource = "/cpu/self";
101     strncpy(app_ctx->ceed_resource, ceed_resource, 10);
102   }
103   // If we request a GPU, make sure PETSc has initialized its device (which is
104   // MPI-aware in case multiple devices are available) before CeedInit so that
105   // PETSc and libCEED agree about which device to use.
106   if (strncmp(app_ctx->ceed_resource, "/gpu", 4) == 0) PetscCall(PetscDeviceInitialize(PETSC_DEVICE_DEFAULT()));
107 
108   // Provide default problem if not specified
109   if (!problem_flag) {
110     const char *problem_name = "density_current";
111     strncpy(app_ctx->problem_name, problem_name, 16);
112   }
113 
114   // Wall Boundary Conditions
115   bc->num_wall = 16;
116   PetscBool flg;
117   PetscCall(PetscOptionsIntArray("-bc_wall", "Face IDs to apply wall BC", NULL, bc->walls, &bc->num_wall, NULL));
118   bc->num_comps = 5;
119   PetscCall(PetscOptionsIntArray("-wall_comps", "An array of constrained component numbers", NULL, bc->wall_comps, &bc->num_comps, &flg));
120   // Slip Boundary Conditions
121   for (PetscInt j = 0; j < 3; j++) {
122     bc->num_slip[j] = 16;
123     PetscBool   flg;
124     const char *flags[3] = {"-bc_slip_x", "-bc_slip_y", "-bc_slip_z"};
125     PetscCall(PetscOptionsIntArray(flags[j], "Face IDs to apply slip BC", NULL, bc->slips[j], &bc->num_slip[j], &flg));
126     if (flg) bc->user_bc = PETSC_TRUE;
127   }
128 
129   // Error if wall and slip BCs are set on the same face
130   if (bc->user_bc)
131     for (PetscInt c = 0; c < 3; c++)
132       for (PetscInt s = 0; s < bc->num_slip[c]; s++)
133         for (PetscInt w = 0; w < bc->num_wall; w++)
134           if (bc->slips[c][s] == bc->walls[w])
135             SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Boundary condition already set on face %" PetscInt_FMT "!\n", bc->walls[w]);
136 
137   // Inflow BCs
138   bc->num_inflow = 16;
139   PetscCall(PetscOptionsIntArray("-bc_inflow", "Face IDs to apply inflow BC", NULL, bc->inflows, &bc->num_inflow, NULL));
140   // Outflow BCs
141   bc->num_outflow = 16;
142   PetscCall(PetscOptionsIntArray("-bc_outflow", "Face IDs to apply outflow BC", NULL, bc->outflows, &bc->num_outflow, NULL));
143   // Freestream BCs
144   bc->num_freestream = 16;
145   PetscCall(PetscOptionsIntArray("-bc_freestream", "Face IDs to apply freestream BC", NULL, bc->freestreams, &bc->num_freestream, NULL));
146 
147   PetscOptionsEnd();
148 
149   PetscFunctionReturn(0);
150 }
151