xref: /libCEED/examples/fluids/problems/blasius.c (revision 58549094d8a305d0f4b066b44680cf34cff212e7)
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(PETSC_SUCCESS);
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   PetscCheck(reason >= 0, 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(PETSC_SUCCESS);
111 }
112 
113 static PetscErrorCode GetYNodeLocs(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal **pynodes, PetscInt *nynodes) {
114   int            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     PetscCheck(ndims == dims[1], comm, PETSC_ERR_FILE_UNEXPECTED,
135                "Line %" PetscInt_FMT " of %s does not contain correct number of columns (%d instead of %d)", i, path, ndims, dims[1]);
136 
137     node_locs[i] = (PetscReal)atof(array[0]);
138   }
139   PetscCall(PetscFClose(comm, fp));
140   *pynodes = node_locs;
141   PetscFunctionReturn(PETSC_SUCCESS);
142 }
143 
144 /* \brief Modify the domain and mesh for blasius
145  *
146  * Modifies mesh such that `N` elements are within `refine_height` with a geometric growth ratio of `growth`. Excess elements are then distributed
147  * linearly in logspace to the top surface.
148  *
149  * The top surface is also angled downwards, so that it may be used as an outflow.
150  * It's angle is controlled by `top_angle` (in units of degrees).
151  *
152  * If `node_locs` is not NULL, then the nodes will be placed at `node_locs` locations.
153  * If it is NULL, then the modified coordinate values will be set in the array, along with `num_node_locs`.
154  */
155 static PetscErrorCode ModifyMesh(MPI_Comm comm, DM dm, PetscInt dim, PetscReal growth, PetscInt N, PetscReal refine_height, PetscReal top_angle,
156                                  PetscReal *node_locs[], PetscInt *num_node_locs) {
157   PetscInt     narr, ncoords;
158   PetscReal    domain_min[3], domain_max[3], domain_size[3];
159   PetscScalar *arr_coords;
160   Vec          vec_coords;
161   PetscFunctionBeginUser;
162 
163   PetscReal angle_coeff = tan(top_angle * (M_PI / 180));
164 
165   // Get domain boundary information
166   PetscCall(DMGetBoundingBox(dm, domain_min, domain_max));
167   for (PetscInt i = 0; i < 3; i++) domain_size[i] = domain_max[i] - domain_min[i];
168 
169   // Get coords array from DM
170   PetscCall(DMGetCoordinatesLocal(dm, &vec_coords));
171   PetscCall(VecGetLocalSize(vec_coords, &narr));
172   PetscCall(VecGetArray(vec_coords, &arr_coords));
173 
174   PetscScalar(*coords)[dim] = (PetscScalar(*)[dim])arr_coords;
175   ncoords                   = narr / dim;
176 
177   // Get mesh information
178   PetscInt nmax = 3, faces[3];
179   PetscCall(PetscOptionsGetIntArray(NULL, NULL, "-dm_plex_box_faces", faces, &nmax, NULL));
180   // Get element size of the box mesh, for indexing each node
181   const PetscReal dybox = domain_size[1] / faces[1];
182 
183   if (!*node_locs) {
184     // Calculate the first element height
185     PetscReal dy1 = refine_height * (growth - 1) / (pow(growth, N) - 1);
186 
187     // Calculate log of sizing outside BL
188     PetscReal logdy = (log(domain_max[1]) - log(refine_height)) / (faces[1] - N);
189 
190     *num_node_locs = faces[1] + 1;
191     PetscReal *temp_node_locs;
192     PetscCall(PetscMalloc1(*num_node_locs, &temp_node_locs));
193 
194     for (PetscInt i = 0; i < ncoords; i++) {
195       PetscInt y_box_index = round(coords[i][1] / dybox);
196       if (y_box_index <= N) {
197         coords[i][1] =
198             (1 - (coords[i][0] - domain_min[0]) * angle_coeff / domain_max[1]) * dy1 * (pow(growth, coords[i][1] / dybox) - 1) / (growth - 1);
199       } else {
200         PetscInt j   = y_box_index - N;
201         coords[i][1] = (1 - (coords[i][0] - domain_min[0]) * angle_coeff / domain_max[1]) * exp(log(refine_height) + logdy * j);
202       }
203       if (coords[i][0] == domain_min[0] && coords[i][2] == domain_min[2]) temp_node_locs[y_box_index] = coords[i][1];
204     }
205 
206     *node_locs = temp_node_locs;
207   } else {
208     PetscCheck(*num_node_locs >= faces[1] + 1, comm, PETSC_ERR_FILE_UNEXPECTED,
209                "The y_node_locs_path has too few locations; There are %" PetscInt_FMT " + 1 nodes, but only %" PetscInt_FMT " locations given",
210                faces[1] + 1, *num_node_locs);
211     if (*num_node_locs > faces[1] + 1) {
212       PetscCall(PetscPrintf(comm,
213                             "WARNING: y_node_locs_path has more locations (%" PetscInt_FMT ") "
214                             "than the mesh has nodes (%" PetscInt_FMT "). This maybe unintended.\n",
215                             *num_node_locs, faces[1] + 1));
216     }
217     PetscScalar max_y = (*node_locs)[faces[1]];
218 
219     for (PetscInt i = 0; i < ncoords; i++) {
220       // Determine which y-node we're at
221       PetscInt y_box_index = round(coords[i][1] / dybox);
222       coords[i][1]         = (1 - (coords[i][0] - domain_min[0]) * angle_coeff / max_y) * (*node_locs)[y_box_index];
223     }
224   }
225 
226   PetscCall(VecRestoreArray(vec_coords, &arr_coords));
227   PetscCall(DMSetCoordinatesLocal(dm, vec_coords));
228 
229   PetscFunctionReturn(PETSC_SUCCESS);
230 }
231 
232 PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc) {
233   User                     user    = *(User *)ctx;
234   MPI_Comm                 comm    = user->comm;
235   Ceed                     ceed    = user->ceed;
236   PetscBool                use_stg = PETSC_FALSE;
237   BlasiusContext           blasius_ctx;
238   NewtonianIdealGasContext newtonian_ig_ctx;
239   CeedQFunctionContext     blasius_context;
240 
241   PetscFunctionBeginUser;
242   PetscCall(NS_NEWTONIAN_IG(problem, dm, ctx, bc));
243   PetscCall(PetscCalloc1(1, &blasius_ctx));
244 
245   // ------------------------------------------------------
246   //               SET UP Blasius
247   // ------------------------------------------------------
248   problem->ics.qfunction     = ICsBlasius;
249   problem->ics.qfunction_loc = ICsBlasius_loc;
250 
251   CeedScalar U_inf                                = 40;           // m/s
252   CeedScalar T_inf                                = 288.;         // K
253   CeedScalar T_wall                               = 288.;         // K
254   CeedScalar delta0                               = 4.2e-3;       // m
255   CeedScalar P0                                   = 1.01e5;       // Pa
256   PetscInt   N                                    = 20;           // Number of Chebyshev terms
257   PetscBool  weakT                                = PETSC_FALSE;  // weak density or temperature
258   PetscReal  mesh_refine_height                   = 5.9e-4;       // m
259   PetscReal  mesh_growth                          = 1.08;         // [-]
260   PetscInt   mesh_Ndelta                          = 45;           // [-]
261   PetscReal  mesh_top_angle                       = 5;            // degrees
262   char       mesh_ynodes_path[PETSC_MAX_PATH_LEN] = "";
263 
264   PetscOptionsBegin(comm, NULL, "Options for BLASIUS problem", NULL);
265   PetscCall(PetscOptionsBool("-weakT", "Change from rho weak to T weak at inflow", NULL, weakT, &weakT, NULL));
266   PetscCall(PetscOptionsScalar("-velocity_infinity", "Velocity at boundary layer edge", NULL, U_inf, &U_inf, NULL));
267   PetscCall(PetscOptionsScalar("-temperature_infinity", "Temperature at boundary layer edge", NULL, T_inf, &T_inf, NULL));
268   PetscCall(PetscOptionsScalar("-temperature_wall", "Temperature at wall", NULL, T_wall, &T_wall, NULL));
269   PetscCall(PetscOptionsScalar("-delta0", "Boundary layer height at inflow", NULL, delta0, &delta0, NULL));
270   PetscCall(PetscOptionsScalar("-P0", "Pressure at outflow", NULL, P0, &P0, NULL));
271   PetscCall(PetscOptionsInt("-n_chebyshev", "Number of Chebyshev terms", NULL, N, &N, NULL));
272   PetscCheck(3 <= N && N <= BLASIUS_MAX_N_CHEBYSHEV, comm, PETSC_ERR_ARG_OUTOFRANGE, "-n_chebyshev %" PetscInt_FMT " must be in range [3, %d]", N,
273              BLASIUS_MAX_N_CHEBYSHEV);
274   PetscCall(PetscOptionsBoundedInt("-platemesh_Ndelta", "Velocity at boundary layer edge", NULL, mesh_Ndelta, &mesh_Ndelta, NULL, 1));
275   PetscCall(PetscOptionsScalar("-platemesh_refine_height", "Height of boundary layer mesh refinement", NULL, mesh_refine_height, &mesh_refine_height,
276                                NULL));
277   PetscCall(PetscOptionsScalar("-platemesh_growth", "Geometric growth rate of boundary layer mesh", NULL, mesh_growth, &mesh_growth, NULL));
278   PetscCall(
279       PetscOptionsScalar("-platemesh_top_angle", "Geometric top_angle rate of boundary layer mesh", NULL, mesh_top_angle, &mesh_top_angle, NULL));
280   PetscCall(PetscOptionsString("-platemesh_y_node_locs_path",
281                                "Path to file with y node locations. "
282                                "If empty, will use the algorithmic mesh warping.",
283                                NULL, mesh_ynodes_path, mesh_ynodes_path, sizeof(mesh_ynodes_path), NULL));
284   PetscCall(PetscOptionsBool("-stg_use", "Use STG inflow boundary condition", NULL, use_stg, &use_stg, NULL));
285   PetscOptionsEnd();
286 
287   PetscScalar meter  = user->units->meter;
288   PetscScalar second = user->units->second;
289   PetscScalar Kelvin = user->units->Kelvin;
290   PetscScalar Pascal = user->units->Pascal;
291 
292   T_inf *= Kelvin;
293   T_wall *= Kelvin;
294   P0 *= Pascal;
295   U_inf *= meter / second;
296   delta0 *= meter;
297 
298   PetscReal *mesh_ynodes  = NULL;
299   PetscInt   mesh_nynodes = 0;
300   if (strcmp(mesh_ynodes_path, "")) {
301     PetscCall(GetYNodeLocs(comm, mesh_ynodes_path, &mesh_ynodes, &mesh_nynodes));
302   }
303   PetscCall(ModifyMesh(comm, dm, problem->dim, mesh_growth, mesh_Ndelta, mesh_refine_height, mesh_top_angle, &mesh_ynodes, &mesh_nynodes));
304 
305   // Some properties depend on parameters from NewtonianIdealGas
306   PetscCallCeed(ceed, CeedQFunctionContextGetData(problem->apply_vol_rhs.qfunction_context, CEED_MEM_HOST, &newtonian_ig_ctx));
307 
308   blasius_ctx->weakT         = weakT;
309   blasius_ctx->U_inf         = U_inf;
310   blasius_ctx->T_inf         = T_inf;
311   blasius_ctx->T_wall        = T_wall;
312   blasius_ctx->delta0        = delta0;
313   blasius_ctx->P0            = P0;
314   blasius_ctx->n_cheb        = N;
315   newtonian_ig_ctx->P0       = P0;
316   blasius_ctx->implicit      = user->phys->implicit;
317   blasius_ctx->newtonian_ctx = *newtonian_ig_ctx;
318 
319   {
320     PetscReal domain_min[3], domain_max[3];
321     PetscCall(DMGetBoundingBox(dm, domain_min, domain_max));
322     blasius_ctx->x_inflow = domain_min[0];
323     blasius_ctx->eta_max  = 5 * domain_max[1] / blasius_ctx->delta0;
324   }
325   PetscBool diff_filter_mms = PETSC_FALSE;
326   PetscCall(PetscOptionsGetBool(NULL, NULL, "-diff_filter_mms", &diff_filter_mms, NULL));
327   if (!use_stg && !diff_filter_mms) PetscCall(ComputeChebyshevCoefficients(blasius_ctx));
328 
329   PetscCallCeed(ceed, CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfunction_context, &newtonian_ig_ctx));
330 
331   PetscCallCeed(ceed, CeedQFunctionContextCreate(user->ceed, &blasius_context));
332   PetscCallCeed(ceed, CeedQFunctionContextSetData(blasius_context, CEED_MEM_HOST, CEED_USE_POINTER, sizeof(*blasius_ctx), blasius_ctx));
333   PetscCallCeed(ceed, CeedQFunctionContextSetDataDestroy(blasius_context, CEED_MEM_HOST, FreeContextPetsc));
334 
335   PetscCallCeed(ceed, CeedQFunctionContextDestroy(&problem->ics.qfunction_context));
336   problem->ics.qfunction_context = blasius_context;
337   if (use_stg) {
338     PetscCall(SetupSTG(comm, dm, problem, user, weakT, T_inf, P0, mesh_ynodes, mesh_nynodes));
339   } else if (diff_filter_mms) {
340     PetscCall(DifferentialFilter_MMS_ICSetup(problem));
341   } else {
342     problem->apply_inflow.qfunction              = Blasius_Inflow;
343     problem->apply_inflow.qfunction_loc          = Blasius_Inflow_loc;
344     problem->apply_inflow_jacobian.qfunction     = Blasius_Inflow_Jacobian;
345     problem->apply_inflow_jacobian.qfunction_loc = Blasius_Inflow_Jacobian_loc;
346     PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(blasius_context, &problem->apply_inflow.qfunction_context));
347     PetscCallCeed(ceed, CeedQFunctionContextReferenceCopy(blasius_context, &problem->apply_inflow_jacobian.qfunction_context));
348   }
349   PetscCall(PetscFree(mesh_ynodes));
350   PetscFunctionReturn(PETSC_SUCCESS);
351 }
352