xref: /libCEED/examples/fluids/problems/blasius.c (revision 4febb80102c5c87c6a273a85e30d4673d8552be6)
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 /// Utility functions for setting up Blasius Boundary Layer
10 
11 #include "../qfunctions/blasius.h"
12 
13 #include <ceed.h>
14 #include <petscdm.h>
15 #include <petscdt.h>
16 
17 #include "../navierstokes.h"
18 #include "stg_shur14.h"
19 
20 PetscErrorCode CompressibleBlasiusResidual(SNES snes, Vec X, Vec R, void *ctx) {
21   const BlasiusContext blasius = (BlasiusContext)ctx;
22   const PetscScalar   *Tf, *Th;  // Chebyshev coefficients
23   PetscScalar         *r, f[4], h[4];
24   PetscInt             N  = blasius->n_cheb;
25   PetscScalar          Ma = Mach(&blasius->newtonian_ctx, blasius->T_inf, blasius->U_inf), Pr = Prandtl(&blasius->newtonian_ctx),
26               gamma = HeatCapacityRatio(&blasius->newtonian_ctx);
27   PetscFunctionBegin;
28   PetscCall(VecGetArrayRead(X, &Tf));
29   Th = Tf + N;
30   PetscCall(VecGetArray(R, &r));
31 
32   // Left boundary conditions f = f' = 0
33   ChebyshevEval(N, Tf, -1., blasius->eta_max, f);
34   r[0] = f[0];
35   r[1] = f[1];
36 
37   // f - right end boundary condition
38   ChebyshevEval(N, Tf, 1., blasius->eta_max, f);
39   r[2] = f[1] - 1.;
40 
41   for (int i = 0; i < N - 3; i++) {
42     ChebyshevEval(N, Tf, blasius->X[i], blasius->eta_max, f);
43     ChebyshevEval(N - 1, Th, blasius->X[i], blasius->eta_max, h);
44     // mu and rho generally depend on h.
45     // We naively assume constant mu.
46     // For an ideal gas at constant pressure, density is inversely proportional to enthalpy.
47     // The *_tilde values are *relative* to their freestream values, and we proved first derivatives here.
48     const PetscScalar mu_tilde[2]     = {1, 0};
49     const PetscScalar rho_tilde[2]    = {1 / h[0], -h[1] / PetscSqr(h[0])};
50     const PetscScalar mu_rho_tilde[2] = {
51         mu_tilde[0] * rho_tilde[0],
52         mu_tilde[1] * rho_tilde[0] + mu_tilde[0] * rho_tilde[1],
53     };
54     r[3 + i]     = 2 * (mu_rho_tilde[0] * f[3] + mu_rho_tilde[1] * f[2]) + f[2] * f[0];
55     r[N + 2 + i] = (mu_rho_tilde[0] * h[2] + mu_rho_tilde[1] * h[1]) + Pr * f[0] * h[1] + Pr * (gamma - 1) * mu_rho_tilde[0] * PetscSqr(Ma * f[2]);
56   }
57 
58   // h - left end boundary condition
59   ChebyshevEval(N - 1, Th, -1., blasius->eta_max, h);
60   r[N] = h[0] - blasius->T_wall / blasius->T_inf;
61 
62   // h - right end boundary condition
63   ChebyshevEval(N - 1, Th, 1., blasius->eta_max, h);
64   r[N + 1] = h[0] - 1.;
65 
66   // Restore vectors
67   PetscCall(VecRestoreArrayRead(X, &Tf));
68   PetscCall(VecRestoreArray(R, &r));
69   PetscFunctionReturn(0);
70 }
71 
72 PetscErrorCode ComputeChebyshevCoefficients(BlasiusContext blasius) {
73   SNES                snes;
74   Vec                 sol, res;
75   PetscReal          *w;
76   PetscInt            N = blasius->n_cheb;
77   SNESConvergedReason reason;
78   const PetscScalar  *cheb_coefs;
79   PetscFunctionBegin;
80 
81   // Allocate memory
82   PetscCall(PetscMalloc2(N - 3, &blasius->X, N - 3, &w));
83   PetscCall(PetscDTGaussQuadrature(N - 3, -1., 1., blasius->X, w));
84 
85   // Snes solve
86   PetscCall(SNESCreate(PETSC_COMM_SELF, &snes));
87   PetscCall(VecCreate(PETSC_COMM_SELF, &sol));
88   PetscCall(VecSetSizes(sol, PETSC_DECIDE, 2 * N - 1));
89   PetscCall(VecSetFromOptions(sol));
90   // Constant relative enthalpy 1 as initial guess
91   PetscCall(VecSetValue(sol, N, 1., INSERT_VALUES));
92   PetscCall(VecDuplicate(sol, &res));
93   PetscCall(SNESSetFunction(snes, res, CompressibleBlasiusResidual, blasius));
94   PetscCall(SNESSetOptionsPrefix(snes, "chebyshev_"));
95   PetscCall(SNESSetFromOptions(snes));
96   PetscCall(SNESSolve(snes, NULL, sol));
97   PetscCall(SNESGetConvergedReason(snes, &reason));
98   if (reason < 0) SETERRQ(PETSC_COMM_WORLD, PETSC_ERR_CONV_FAILED, "The Chebyshev solve failed.\n");
99 
100   // Assign Chebyshev coefficients
101   PetscCall(VecGetArrayRead(sol, &cheb_coefs));
102   for (int i = 0; i < N; i++) blasius->Tf_cheb[i] = cheb_coefs[i];
103   for (int i = 0; i < N - 1; i++) blasius->Th_cheb[i] = cheb_coefs[i + N];
104 
105   // Destroy objects
106   PetscCall(PetscFree2(blasius->X, w));
107   PetscCall(VecDestroy(&sol));
108   PetscCall(VecDestroy(&res));
109   PetscCall(SNESDestroy(&snes));
110   PetscFunctionReturn(0);
111 }
112 
113 static PetscErrorCode GetYNodeLocs(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal **pynodes, PetscInt *nynodes) {
114   PetscInt       ndims, dims[2];
115   FILE          *fp;
116   const PetscInt char_array_len = 512;
117   char           line[char_array_len];
118   char         **array;
119   PetscReal     *node_locs;
120   PetscFunctionBeginUser;
121 
122   PetscCall(PetscFOpen(comm, path, "r", &fp));
123   PetscCall(PetscSynchronizedFGets(comm, fp, char_array_len, line));
124   PetscCall(PetscStrToArray(line, ' ', &ndims, &array));
125 
126   for (PetscInt i = 0; i < ndims; i++) dims[i] = atoi(array[i]);
127   if (ndims < 2) dims[1] = 1;  // Assume 1 column of data is not otherwise specified
128   *nynodes = dims[0];
129   PetscCall(PetscMalloc1(*nynodes, &node_locs));
130 
131   for (PetscInt i = 0; i < dims[0]; i++) {
132     PetscCall(PetscSynchronizedFGets(comm, fp, char_array_len, line));
133     PetscCall(PetscStrToArray(line, ' ', &ndims, &array));
134     if (ndims < dims[1]) {
135       SETERRQ(comm, -1, "Line %" PetscInt_FMT " of %s does not contain enough columns (%" PetscInt_FMT " instead of %" PetscInt_FMT ")", i, path,
136               ndims, dims[1]);
137     }
138 
139     node_locs[i] = (PetscReal)atof(array[0]);
140   }
141   PetscCall(PetscFClose(comm, fp));
142   *pynodes = node_locs;
143   PetscFunctionReturn(0);
144 }
145 
146 /* \brief Modify the domain and mesh for blasius
147  *
148  * Modifies mesh such that `N` elements are within `refine_height` with a geometric growth ratio of `growth`. Excess elements are then distributed
149  * linearly in logspace to the top surface.
150  *
151  * The top surface is also angled downwards, so that it may be used as an outflow.
152  * It's angle is controlled by `top_angle` (in units of degrees).
153  *
154  * If `node_locs` is not NULL, then the nodes will be placed at `node_locs` locations.
155  * If it is NULL, then the modified coordinate values will be set in the array, along with `num_node_locs`.
156  */
157 static PetscErrorCode ModifyMesh(MPI_Comm comm, DM dm, PetscInt dim, PetscReal growth, PetscInt N, PetscReal refine_height, PetscReal top_angle,
158                                  PetscReal *node_locs[], PetscInt *num_node_locs) {
159   PetscInt     narr, ncoords;
160   PetscReal    domain_min[3], domain_max[3], domain_size[3];
161   PetscScalar *arr_coords;
162   Vec          vec_coords;
163   PetscFunctionBeginUser;
164 
165   PetscReal angle_coeff = tan(top_angle * (M_PI / 180));
166 
167   // Get domain boundary information
168   PetscCall(DMGetBoundingBox(dm, domain_min, domain_max));
169   for (PetscInt i = 0; i < 3; i++) domain_size[i] = domain_max[i] - domain_min[i];
170 
171   // Get coords array from DM
172   PetscCall(DMGetCoordinatesLocal(dm, &vec_coords));
173   PetscCall(VecGetLocalSize(vec_coords, &narr));
174   PetscCall(VecGetArray(vec_coords, &arr_coords));
175 
176   PetscScalar(*coords)[dim] = (PetscScalar(*)[dim])arr_coords;
177   ncoords                   = narr / dim;
178 
179   // Get mesh information
180   PetscInt nmax = 3, faces[3];
181   PetscCall(PetscOptionsGetIntArray(NULL, NULL, "-dm_plex_box_faces", faces, &nmax, NULL));
182   // Get element size of the box mesh, for indexing each node
183   const PetscReal dybox = domain_size[1] / faces[1];
184 
185   if (!*node_locs) {
186     // Calculate the first element height
187     PetscReal dy1 = refine_height * (growth - 1) / (pow(growth, N) - 1);
188 
189     // Calculate log of sizing outside BL
190     PetscReal logdy = (log(domain_max[1]) - log(refine_height)) / (faces[1] - N);
191 
192     *num_node_locs = faces[1] + 1;
193     PetscReal *temp_node_locs;
194     PetscCall(PetscMalloc1(*num_node_locs, &temp_node_locs));
195 
196     for (PetscInt i = 0; i < ncoords; i++) {
197       PetscInt y_box_index = round(coords[i][1] / dybox);
198       if (y_box_index <= N) {
199         coords[i][1] =
200             (1 - (coords[i][0] - domain_min[0]) * angle_coeff / domain_max[1]) * dy1 * (pow(growth, coords[i][1] / dybox) - 1) / (growth - 1);
201       } else {
202         PetscInt j   = y_box_index - N;
203         coords[i][1] = (1 - (coords[i][0] - domain_min[0]) * angle_coeff / domain_max[1]) * exp(log(refine_height) + logdy * j);
204       }
205       if (coords[i][0] == domain_min[0] && coords[i][2] == domain_min[2]) temp_node_locs[y_box_index] = coords[i][1];
206     }
207 
208     *node_locs = temp_node_locs;
209   } else {
210     // Error checking
211     if (*num_node_locs < faces[1] + 1) {
212       SETERRQ(comm, -1,
213               "The y_node_locs_path has too few locations; "
214               "There are %d + 1 nodes, but only %d locations given",
215               faces[1] + 1, *num_node_locs);
216     }
217     if (*num_node_locs > faces[1] + 1) {
218       PetscCall(PetscPrintf(comm,
219                             "WARNING: y_node_locs_path has more locations (%d) "
220                             "than the mesh has nodes (%d). This maybe unintended.\n",
221                             *num_node_locs, faces[1] + 1));
222     }
223     PetscScalar max_y = (*node_locs)[faces[1]];
224 
225     for (PetscInt i = 0; i < ncoords; i++) {
226       // Determine which y-node we're at
227       PetscInt y_box_index = round(coords[i][1] / dybox);
228       coords[i][1]         = (1 - (coords[i][0] - domain_min[0]) * angle_coeff / max_y) * (*node_locs)[y_box_index];
229     }
230   }
231 
232   PetscCall(VecRestoreArray(vec_coords, &arr_coords));
233   PetscCall(DMSetCoordinatesLocal(dm, vec_coords));
234 
235   PetscFunctionReturn(0);
236 }
237 
238 PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc) {
239   User                     user    = *(User *)ctx;
240   MPI_Comm                 comm    = PETSC_COMM_WORLD;
241   PetscBool                use_stg = PETSC_FALSE;
242   BlasiusContext           blasius_ctx;
243   NewtonianIdealGasContext newtonian_ig_ctx;
244   CeedQFunctionContext     blasius_context;
245 
246   PetscFunctionBeginUser;
247   PetscCall(NS_NEWTONIAN_IG(problem, dm, ctx, bc));
248   PetscCall(PetscCalloc1(1, &blasius_ctx));
249 
250   // ------------------------------------------------------
251   //               SET UP Blasius
252   // ------------------------------------------------------
253   problem->ics.qfunction     = ICsBlasius;
254   problem->ics.qfunction_loc = ICsBlasius_loc;
255 
256   CeedScalar U_inf                                = 40;           // m/s
257   CeedScalar T_inf                                = 288.;         // K
258   CeedScalar T_wall                               = 288.;         // K
259   CeedScalar delta0                               = 4.2e-3;       // m
260   CeedScalar P0                                   = 1.01e5;       // Pa
261   CeedInt    N                                    = 20;           // Number of Chebyshev terms
262   PetscBool  weakT                                = PETSC_FALSE;  // weak density or temperature
263   PetscReal  mesh_refine_height                   = 5.9e-4;       // m
264   PetscReal  mesh_growth                          = 1.08;         // [-]
265   PetscInt   mesh_Ndelta                          = 45;           // [-]
266   PetscReal  mesh_top_angle                       = 5;            // degrees
267   char       mesh_ynodes_path[PETSC_MAX_PATH_LEN] = "";
268 
269   PetscOptionsBegin(comm, NULL, "Options for BLASIUS problem", NULL);
270   PetscCall(PetscOptionsBool("-weakT", "Change from rho weak to T weak at inflow", NULL, weakT, &weakT, NULL));
271   PetscCall(PetscOptionsScalar("-velocity_infinity", "Velocity at boundary layer edge", NULL, U_inf, &U_inf, NULL));
272   PetscCall(PetscOptionsScalar("-temperature_infinity", "Temperature at boundary layer edge", NULL, T_inf, &T_inf, NULL));
273   PetscCall(PetscOptionsScalar("-temperature_wall", "Temperature at wall", NULL, T_wall, &T_wall, NULL));
274   PetscCall(PetscOptionsScalar("-delta0", "Boundary layer height at inflow", NULL, delta0, &delta0, NULL));
275   PetscCall(PetscOptionsScalar("-P0", "Pressure at outflow", NULL, P0, &P0, NULL));
276   PetscCall(PetscOptionsInt("-n_chebyshev", "Number of Chebyshev terms", NULL, N, &N, NULL));
277   PetscCheck(3 <= N && N <= BLASIUS_MAX_N_CHEBYSHEV, comm, PETSC_ERR_ARG_OUTOFRANGE, "-n_chebyshev %" PetscInt_FMT " must be in range [3, %d]", N,
278              BLASIUS_MAX_N_CHEBYSHEV);
279   PetscCall(PetscOptionsBoundedInt("-platemesh_Ndelta", "Velocity at boundary layer edge", NULL, mesh_Ndelta, &mesh_Ndelta, NULL, 1));
280   PetscCall(PetscOptionsScalar("-platemesh_refine_height", "Height of boundary layer mesh refinement", NULL, mesh_refine_height, &mesh_refine_height,
281                                NULL));
282   PetscCall(PetscOptionsScalar("-platemesh_growth", "Geometric growth rate of boundary layer mesh", NULL, mesh_growth, &mesh_growth, NULL));
283   PetscCall(
284       PetscOptionsScalar("-platemesh_top_angle", "Geometric top_angle rate of boundary layer mesh", NULL, mesh_top_angle, &mesh_top_angle, NULL));
285   PetscCall(PetscOptionsString("-platemesh_y_node_locs_path",
286                                "Path to file with y node locations. "
287                                "If empty, will use the algorithmic mesh warping.",
288                                NULL, mesh_ynodes_path, mesh_ynodes_path, sizeof(mesh_ynodes_path), NULL));
289   PetscCall(PetscOptionsBool("-stg_use", "Use STG inflow boundary condition", NULL, use_stg, &use_stg, NULL));
290   PetscOptionsEnd();
291 
292   PetscScalar meter  = user->units->meter;
293   PetscScalar second = user->units->second;
294   PetscScalar Kelvin = user->units->Kelvin;
295   PetscScalar Pascal = user->units->Pascal;
296 
297   T_inf *= Kelvin;
298   T_wall *= Kelvin;
299   P0 *= Pascal;
300   U_inf *= meter / second;
301   delta0 *= meter;
302 
303   PetscReal *mesh_ynodes  = NULL;
304   PetscInt   mesh_nynodes = 0;
305   if (strcmp(mesh_ynodes_path, "")) {
306     PetscCall(GetYNodeLocs(comm, mesh_ynodes_path, &mesh_ynodes, &mesh_nynodes));
307   }
308   PetscCall(ModifyMesh(comm, dm, problem->dim, mesh_growth, mesh_Ndelta, mesh_refine_height, mesh_top_angle, &mesh_ynodes, &mesh_nynodes));
309 
310   // Some properties depend on parameters from NewtonianIdealGas
311   CeedQFunctionContextGetData(problem->apply_vol_rhs.qfunction_context, CEED_MEM_HOST, &newtonian_ig_ctx);
312 
313   blasius_ctx->weakT         = weakT;
314   blasius_ctx->U_inf         = U_inf;
315   blasius_ctx->T_inf         = T_inf;
316   blasius_ctx->T_wall        = T_wall;
317   blasius_ctx->delta0        = delta0;
318   blasius_ctx->P0            = P0;
319   blasius_ctx->n_cheb        = N;
320   newtonian_ig_ctx->P0       = P0;
321   blasius_ctx->implicit      = user->phys->implicit;
322   blasius_ctx->newtonian_ctx = *newtonian_ig_ctx;
323 
324   {
325     PetscReal domain_min[3], domain_max[3];
326     PetscCall(DMGetBoundingBox(dm, domain_min, domain_max));
327     blasius_ctx->x_inflow = domain_min[0];
328     blasius_ctx->eta_max  = 5 * domain_max[1] / blasius_ctx->delta0;
329   }
330   if (!use_stg) PetscCall(ComputeChebyshevCoefficients(blasius_ctx));
331 
332   CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfunction_context, &newtonian_ig_ctx);
333 
334   CeedQFunctionContextCreate(user->ceed, &blasius_context);
335   CeedQFunctionContextSetData(blasius_context, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*blasius_ctx), blasius_ctx);
336   CeedQFunctionContextSetDataDestroy(blasius_context, CEED_MEM_HOST, FreeContextPetsc);
337 
338   CeedQFunctionContextDestroy(&problem->ics.qfunction_context);
339   problem->ics.qfunction_context = blasius_context;
340   if (use_stg) {
341     PetscCall(SetupSTG(comm, dm, problem, user, weakT, T_inf, P0, mesh_ynodes, mesh_nynodes));
342   } else {
343     problem->apply_inflow.qfunction              = Blasius_Inflow;
344     problem->apply_inflow.qfunction_loc          = Blasius_Inflow_loc;
345     problem->apply_inflow_jacobian.qfunction     = Blasius_Inflow_Jacobian;
346     problem->apply_inflow_jacobian.qfunction_loc = Blasius_Inflow_Jacobian_loc;
347     CeedQFunctionContextReferenceCopy(blasius_context, &problem->apply_inflow.qfunction_context);
348     CeedQFunctionContextReferenceCopy(blasius_context, &problem->apply_inflow_jacobian.qfunction_context);
349   }
350   PetscCall(PetscFree(mesh_ynodes));
351   PetscFunctionReturn(0);
352 }
353