xref: /libCEED/examples/fluids/problems/stg_shur14.c (revision 49aac155e7a09736f56fb3abac0f57dab29f7cbf)
1ba6664aeSJames Wright // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
2ba6664aeSJames Wright // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3ba6664aeSJames Wright //
4ba6664aeSJames Wright // SPDX-License-Identifier: BSD-2-Clause
5ba6664aeSJames Wright //
6ba6664aeSJames Wright // This file is part of CEED:  http://github.com/ceed
7ba6664aeSJames Wright 
8ba6664aeSJames Wright /// @file
9ba6664aeSJames Wright /// Implementation of the Synthetic Turbulence Generation (STG) algorithm
10ba6664aeSJames Wright /// presented in Shur et al. 2014
11ba6664aeSJames Wright 
122b730f8bSJeremy L Thompson #include "stg_shur14.h"
132b730f8bSJeremy L Thompson 
14*49aac155SJeremy L Thompson #include <ceed.h>
15ba6664aeSJames Wright #include <math.h>
16*49aac155SJeremy L Thompson #include <petscdm.h>
172b730f8bSJeremy L Thompson #include <stdlib.h>
182b730f8bSJeremy L Thompson 
19ba6664aeSJames Wright #include "../navierstokes.h"
20ba6664aeSJames Wright #include "../qfunctions/stg_shur14.h"
21ba6664aeSJames Wright 
2265dd5cafSJames Wright STGShur14Context global_stg_ctx;
2365dd5cafSJames Wright 
24ba6664aeSJames Wright /*
25ba6664aeSJames Wright  * @brief Perform Cholesky decomposition on array of symmetric 3x3 matrices
26ba6664aeSJames Wright  *
27ea61e9acSJeremy L Thompson  * This assumes the input matrices are in order [11,22,33,12,13,23].
28ea61e9acSJeremy L Thompson  * This format is also used for the output.
29ba6664aeSJames Wright  *
30ba6664aeSJames Wright  * @param[in]  comm   MPI_Comm
31ba6664aeSJames Wright  * @param[in]  nprofs Number of matrices in Rij
32ba6664aeSJames Wright  * @param[in]  Rij    Array of the symmetric matrices [6,nprofs]
33ba6664aeSJames Wright  * @param[out] Cij    Array of the Cholesky Decomposition matrices, [6,nprofs]
34ba6664aeSJames Wright  */
352b730f8bSJeremy L Thompson PetscErrorCode CalcCholeskyDecomp(MPI_Comm comm, PetscInt nprofs, const CeedScalar Rij[6][nprofs], CeedScalar Cij[6][nprofs]) {
36ba6664aeSJames Wright   PetscFunctionBeginUser;
37ba6664aeSJames Wright   for (PetscInt i = 0; i < nprofs; i++) {
38ba6664aeSJames Wright     Cij[0][i] = sqrt(Rij[0][i]);
39ba6664aeSJames Wright     Cij[3][i] = Rij[3][i] / Cij[0][i];
40ba6664aeSJames Wright     Cij[1][i] = sqrt(Rij[1][i] - pow(Cij[3][i], 2));
41ba6664aeSJames Wright     Cij[4][i] = Rij[4][i] / Cij[0][i];
42ba6664aeSJames Wright     Cij[5][i] = (Rij[5][i] - Cij[3][i] * Cij[4][i]) / Cij[1][i];
43ba6664aeSJames Wright     Cij[2][i] = sqrt(Rij[2][i] - pow(Cij[4][i], 2) - pow(Cij[5][i], 2));
44ba6664aeSJames Wright 
452b730f8bSJeremy L Thompson     if (isnan(Cij[0][i]) || isnan(Cij[1][i]) || isnan(Cij[2][i])) {
462b730f8bSJeremy L Thompson       SETERRQ(comm, -1, "Cholesky decomposition failed at profile point %" PetscInt_FMT ". Either STGInflow has non-SPD matrix or contains nan.",
472b730f8bSJeremy L Thompson               i + 1);
482b730f8bSJeremy L Thompson     }
49ba6664aeSJames Wright   }
50ba6664aeSJames Wright   PetscFunctionReturn(0);
51ba6664aeSJames Wright }
52ba6664aeSJames Wright 
53ba6664aeSJames Wright /*
54ba6664aeSJames Wright  * @brief Open a PHASTA *.dat file, grabbing dimensions and file pointer
55ba6664aeSJames Wright  *
56ea61e9acSJeremy L Thompson  * This function opens the file specified by `path` using `PetscFOpen` and passes the file pointer in `fp`.
57ea61e9acSJeremy L Thompson  * It is not closed in this function, thus `fp` must be closed sometime after this function has been called (using `PetscFClose` for example).
58ba6664aeSJames Wright  *
59ea61e9acSJeremy L Thompson  * Assumes that the first line of the file has the number of rows and columns as the only two entries, separated by a single space.
60ba6664aeSJames Wright  *
61ba6664aeSJames Wright  * @param[in]  comm           MPI_Comm for the program
62ba6664aeSJames Wright  * @param[in]  path           Path to the file
63ba6664aeSJames Wright  * @param[in]  char_array_len Length of the character array that should contain each line
64ba6664aeSJames Wright  * @param[out] dims           Dimensions of the file, taken from the first line of the file
65ba6664aeSJames Wright  * @param[out] fp File        pointer to the opened file
66ba6664aeSJames Wright  */
672b730f8bSJeremy L Thompson static PetscErrorCode OpenPHASTADatFile(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
682b730f8bSJeremy L Thompson                                         FILE **fp) {
69ba6664aeSJames Wright   PetscInt ndims;
70ba6664aeSJames Wright   char     line[char_array_len];
71ba6664aeSJames Wright   char   **array;
72ba6664aeSJames Wright 
73ba6664aeSJames Wright   PetscFunctionBeginUser;
7424941a69SJames Wright   PetscCall(PetscFOpen(comm, path, "r", fp));
7524941a69SJames Wright   PetscCall(PetscSynchronizedFGets(comm, *fp, char_array_len, line));
7624941a69SJames Wright   PetscCall(PetscStrToArray(line, ' ', &ndims, &array));
772b730f8bSJeremy L Thompson   if (ndims != 2) {
782b730f8bSJeremy L Thompson     SETERRQ(comm, -1, "Found %" PetscInt_FMT " dimensions instead of 2 on the first line of %s", ndims, path);
792b730f8bSJeremy L Thompson   }
80ba6664aeSJames Wright 
81ba6664aeSJames Wright   for (PetscInt i = 0; i < ndims; i++) dims[i] = atoi(array[i]);
8224941a69SJames Wright   PetscCall(PetscStrToArrayDestroy(ndims, array));
832b730f8bSJeremy L Thompson 
84ba6664aeSJames Wright   PetscFunctionReturn(0);
85ba6664aeSJames Wright }
86ba6664aeSJames Wright 
87ba6664aeSJames Wright /*
88ea61e9acSJeremy L Thompson  * @brief Get the number of rows for the PHASTA file at path.
89ba6664aeSJames Wright  *
90ea61e9acSJeremy L Thompson  * Assumes that the first line of the file has the number of rows and columns as the only two entries, separated by a single space.
91ba6664aeSJames Wright  *
92ba6664aeSJames Wright  * @param[in]  comm  MPI_Comm for the program
93ba6664aeSJames Wright  * @param[in]  path  Path to the file
94ba6664aeSJames Wright  * @param[out] nrows Number of rows
95ba6664aeSJames Wright  */
962b730f8bSJeremy L Thompson static PetscErrorCode GetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows) {
97ba6664aeSJames Wright   const PetscInt char_array_len = 512;
98ba6664aeSJames Wright   PetscInt       dims[2];
99ba6664aeSJames Wright   FILE          *fp;
100ba6664aeSJames Wright 
101ba6664aeSJames Wright   PetscFunctionBeginUser;
10224941a69SJames Wright   PetscCall(OpenPHASTADatFile(comm, path, char_array_len, dims, &fp));
103ba6664aeSJames Wright   *nrows = dims[0];
10424941a69SJames Wright   PetscCall(PetscFClose(comm, fp));
1052b730f8bSJeremy L Thompson 
106ba6664aeSJames Wright   PetscFunctionReturn(0);
107ba6664aeSJames Wright }
108ba6664aeSJames Wright 
109ba6664aeSJames Wright /*
110ba6664aeSJames Wright  * @brief Read the STGInflow file and load the contents into stg_ctx
111ba6664aeSJames Wright  *
112ea61e9acSJeremy L Thompson  * Assumes that the first line of the file has the number of rows and columns as the only two entries, separated by a single space.
113ea61e9acSJeremy L Thompson  * Assumes there are 14 columns in the file.
114ba6664aeSJames Wright  *
115ea61e9acSJeremy L Thompson  * Function calculates the Cholesky decomposition from the Reynolds stress profile found in the file.
116ba6664aeSJames Wright  *
117ba6664aeSJames Wright  * @param[in]     comm    MPI_Comm for the program
118ba6664aeSJames Wright  * @param[in]     path    Path to the STGInflow.dat file
119ea61e9acSJeremy L Thompson  * @param[in,out] stg_ctx STGShur14Context where the data will be loaded into
120ba6664aeSJames Wright  */
1212b730f8bSJeremy L Thompson static PetscErrorCode ReadSTGInflow(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], STGShur14Context stg_ctx) {
122ba6664aeSJames Wright   PetscInt       ndims, dims[2];
123ba6664aeSJames Wright   FILE          *fp;
124ba6664aeSJames Wright   const PetscInt char_array_len = 512;
125ba6664aeSJames Wright   char           line[char_array_len];
126ba6664aeSJames Wright   char         **array;
127ba6664aeSJames Wright 
128ba6664aeSJames Wright   PetscFunctionBeginUser;
129ba6664aeSJames Wright 
13024941a69SJames Wright   PetscCall(OpenPHASTADatFile(comm, path, char_array_len, dims, &fp));
131ba6664aeSJames Wright 
132ba6664aeSJames Wright   CeedScalar  rij[6][stg_ctx->nprofs];
133175f00a6SJames Wright   CeedScalar *wall_dist              = &stg_ctx->data[stg_ctx->offsets.wall_dist];
134ba6664aeSJames Wright   CeedScalar *eps                    = &stg_ctx->data[stg_ctx->offsets.eps];
135ba6664aeSJames Wright   CeedScalar *lt                     = &stg_ctx->data[stg_ctx->offsets.lt];
1362b730f8bSJeremy L Thompson   CeedScalar(*ubar)[stg_ctx->nprofs] = (CeedScalar(*)[stg_ctx->nprofs]) & stg_ctx->data[stg_ctx->offsets.ubar];
137ba6664aeSJames Wright 
138ba6664aeSJames Wright   for (PetscInt i = 0; i < stg_ctx->nprofs; i++) {
13924941a69SJames Wright     PetscCall(PetscSynchronizedFGets(comm, fp, char_array_len, line));
14024941a69SJames Wright     PetscCall(PetscStrToArray(line, ' ', &ndims, &array));
1412b730f8bSJeremy L Thompson     if (ndims < dims[1]) {
1422b730f8bSJeremy L Thompson       SETERRQ(comm, -1, "Line %" PetscInt_FMT " of %s does not contain enough columns (%" PetscInt_FMT " instead of %" PetscInt_FMT ")", i, path,
1432b730f8bSJeremy L Thompson               ndims, dims[1]);
1442b730f8bSJeremy L Thompson     }
145ba6664aeSJames Wright 
146175f00a6SJames Wright     wall_dist[i] = (CeedScalar)atof(array[0]);
147ba6664aeSJames Wright     ubar[0][i]   = (CeedScalar)atof(array[1]);
148ba6664aeSJames Wright     ubar[1][i]   = (CeedScalar)atof(array[2]);
149ba6664aeSJames Wright     ubar[2][i]   = (CeedScalar)atof(array[3]);
150ba6664aeSJames Wright     rij[0][i]    = (CeedScalar)atof(array[4]);
151ba6664aeSJames Wright     rij[1][i]    = (CeedScalar)atof(array[5]);
152ba6664aeSJames Wright     rij[2][i]    = (CeedScalar)atof(array[6]);
153ba6664aeSJames Wright     rij[3][i]    = (CeedScalar)atof(array[7]);
154ba6664aeSJames Wright     rij[4][i]    = (CeedScalar)atof(array[8]);
155ba6664aeSJames Wright     rij[5][i]    = (CeedScalar)atof(array[9]);
156ba6664aeSJames Wright     lt[i]        = (CeedScalar)atof(array[12]);
157ba6664aeSJames Wright     eps[i]       = (CeedScalar)atof(array[13]);
158ba6664aeSJames Wright 
1592b730f8bSJeremy L Thompson     if (wall_dist[i] < 0) SETERRQ(comm, -1, "Distance to wall in %s cannot be negative", path);
1602b730f8bSJeremy L Thompson     if (lt[i] < 0) SETERRQ(comm, -1, "Turbulent length scale in %s cannot be negative", path);
1612b730f8bSJeremy L Thompson     if (eps[i] < 0) SETERRQ(comm, -1, "Turbulent dissipation in %s cannot be negative", path);
162ba6664aeSJames Wright   }
1632b730f8bSJeremy L Thompson   CeedScalar(*cij)[stg_ctx->nprofs] = (CeedScalar(*)[stg_ctx->nprofs]) & stg_ctx->data[stg_ctx->offsets.cij];
16424941a69SJames Wright   PetscCall(CalcCholeskyDecomp(comm, stg_ctx->nprofs, rij, cij));
16524941a69SJames Wright   PetscCall(PetscFClose(comm, fp));
1662b730f8bSJeremy L Thompson 
167ba6664aeSJames Wright   PetscFunctionReturn(0);
168ba6664aeSJames Wright }
169ba6664aeSJames Wright 
170ba6664aeSJames Wright /*
171ba6664aeSJames Wright  * @brief Read the STGRand file and load the contents into stg_ctx
172ba6664aeSJames Wright  *
173ea61e9acSJeremy L Thompson  * Assumes that the first line of the file has the number of rows and columns as the only two entries, separated by a single space.
174ea61e9acSJeremy L Thompson  * Assumes there are 7 columns in the file.
175ba6664aeSJames Wright  *
176ba6664aeSJames Wright  * @param[in]     comm    MPI_Comm for the program
177ba6664aeSJames Wright  * @param[in]     path    Path to the STGRand.dat file
178ea61e9acSJeremy L Thompson  * @param[in,out] stg_ctx STGShur14Context where the data will be loaded into
179ba6664aeSJames Wright  */
1802b730f8bSJeremy L Thompson static PetscErrorCode ReadSTGRand(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], STGShur14Context stg_ctx) {
181ba6664aeSJames Wright   PetscInt       ndims, dims[2];
182ba6664aeSJames Wright   FILE          *fp;
183ba6664aeSJames Wright   const PetscInt char_array_len = 512;
184ba6664aeSJames Wright   char           line[char_array_len];
185ba6664aeSJames Wright   char         **array;
186ba6664aeSJames Wright 
187ba6664aeSJames Wright   PetscFunctionBeginUser;
18824941a69SJames Wright   PetscCall(OpenPHASTADatFile(comm, path, char_array_len, dims, &fp));
189ba6664aeSJames Wright 
190ba6664aeSJames Wright   CeedScalar *phi                     = &stg_ctx->data[stg_ctx->offsets.phi];
1912b730f8bSJeremy L Thompson   CeedScalar(*d)[stg_ctx->nmodes]     = (CeedScalar(*)[stg_ctx->nmodes]) & stg_ctx->data[stg_ctx->offsets.d];
1922b730f8bSJeremy L Thompson   CeedScalar(*sigma)[stg_ctx->nmodes] = (CeedScalar(*)[stg_ctx->nmodes]) & stg_ctx->data[stg_ctx->offsets.sigma];
193ba6664aeSJames Wright 
194ba6664aeSJames Wright   for (PetscInt i = 0; i < stg_ctx->nmodes; i++) {
19524941a69SJames Wright     PetscCall(PetscSynchronizedFGets(comm, fp, char_array_len, line));
19624941a69SJames Wright     PetscCall(PetscStrToArray(line, ' ', &ndims, &array));
1972b730f8bSJeremy L Thompson     if (ndims < dims[1]) {
1982b730f8bSJeremy L Thompson       SETERRQ(comm, -1, "Line %" PetscInt_FMT " of %s does not contain enough columns (%" PetscInt_FMT " instead of %" PetscInt_FMT ")", i, path,
1992b730f8bSJeremy L Thompson               ndims, dims[1]);
2002b730f8bSJeremy L Thompson     }
201ba6664aeSJames Wright 
202ba6664aeSJames Wright     d[0][i]     = (CeedScalar)atof(array[0]);
203ba6664aeSJames Wright     d[1][i]     = (CeedScalar)atof(array[1]);
204ba6664aeSJames Wright     d[2][i]     = (CeedScalar)atof(array[2]);
205ba6664aeSJames Wright     phi[i]      = (CeedScalar)atof(array[3]);
206ba6664aeSJames Wright     sigma[0][i] = (CeedScalar)atof(array[4]);
207ba6664aeSJames Wright     sigma[1][i] = (CeedScalar)atof(array[5]);
208ba6664aeSJames Wright     sigma[2][i] = (CeedScalar)atof(array[6]);
209ba6664aeSJames Wright   }
21024941a69SJames Wright   PetscCall(PetscFClose(comm, fp));
2112b730f8bSJeremy L Thompson 
212ba6664aeSJames Wright   PetscFunctionReturn(0);
213ba6664aeSJames Wright }
214ba6664aeSJames Wright 
215ba6664aeSJames Wright /*
216ba6664aeSJames Wright  * @brief Read STG data from input paths and put in STGShur14Context
217ba6664aeSJames Wright  *
218ba6664aeSJames Wright  * Reads data from input paths and puts them into a STGShur14Context object.
219ea61e9acSJeremy L Thompson  * Data stored initially in `*pstg_ctx` will be copied over to the new STGShur14Context instance.
220ba6664aeSJames Wright  *
221ba6664aeSJames Wright  * @param[in]     comm            MPI_Comm for the program
222ba6664aeSJames Wright  * @param[in]     dm              DM for the program
223ba6664aeSJames Wright  * @param[in]     stg_inflow_path Path to STGInflow.dat file
224ba6664aeSJames Wright  * @param[in]     stg_rand_path   Path to STGRand.dat file
225ea61e9acSJeremy L Thompson  * @param[in,out] pstg_ctx        Pointer to STGShur14Context where the data will be loaded into
226ba6664aeSJames Wright  */
2272b730f8bSJeremy L Thompson PetscErrorCode GetSTGContextData(const MPI_Comm comm, const DM dm, char stg_inflow_path[PETSC_MAX_PATH_LEN], char stg_rand_path[PETSC_MAX_PATH_LEN],
2282b730f8bSJeremy L Thompson                                  STGShur14Context *pstg_ctx, const CeedScalar ynodes[]) {
229ba6664aeSJames Wright   PetscInt         nmodes, nprofs;
230ba6664aeSJames Wright   STGShur14Context stg_ctx;
231ba6664aeSJames Wright   PetscFunctionBeginUser;
232ba6664aeSJames Wright 
233ba6664aeSJames Wright   // Get options
23424941a69SJames Wright   PetscCall(GetNRows(comm, stg_rand_path, &nmodes));
23524941a69SJames Wright   PetscCall(GetNRows(comm, stg_inflow_path, &nprofs));
236*49aac155SJeremy L Thompson   if (nmodes > STG_NMODES_MAX) {
2372b730f8bSJeremy L Thompson     SETERRQ(comm, 1,
2382b730f8bSJeremy L Thompson             "Number of wavemodes in %s (%" PetscInt_FMT ") exceeds STG_NMODES_MAX (%" PetscInt_FMT
2392b730f8bSJeremy L Thompson             "). "
2402b730f8bSJeremy L Thompson             "Change size of STG_NMODES_MAX and recompile",
2412b730f8bSJeremy L Thompson             stg_rand_path, nmodes, STG_NMODES_MAX);
242*49aac155SJeremy L Thompson   }
243ba6664aeSJames Wright 
244ba6664aeSJames Wright   {
245ba6664aeSJames Wright     STGShur14Context s;
24624941a69SJames Wright     PetscCall(PetscCalloc1(1, &s));
247ba6664aeSJames Wright     *s                         = **pstg_ctx;
248ba6664aeSJames Wright     s->nmodes                  = nmodes;
249ba6664aeSJames Wright     s->nprofs                  = nprofs;
250ba6664aeSJames Wright     s->offsets.sigma           = 0;
251ba6664aeSJames Wright     s->offsets.d               = nmodes * 3;
252ba6664aeSJames Wright     s->offsets.phi             = s->offsets.d + nmodes * 3;
253ba6664aeSJames Wright     s->offsets.kappa           = s->offsets.phi + nmodes;
254175f00a6SJames Wright     s->offsets.wall_dist       = s->offsets.kappa + nmodes;
255175f00a6SJames Wright     s->offsets.ubar            = s->offsets.wall_dist + nprofs;
256ba6664aeSJames Wright     s->offsets.cij             = s->offsets.ubar + nprofs * 3;
257ba6664aeSJames Wright     s->offsets.eps             = s->offsets.cij + nprofs * 6;
258ba6664aeSJames Wright     s->offsets.lt              = s->offsets.eps + nprofs;
2594e139266SJames Wright     s->offsets.ynodes          = s->offsets.lt + nprofs;
2604e139266SJames Wright     PetscInt total_num_scalars = s->offsets.ynodes + s->nynodes;
261ba6664aeSJames Wright     s->total_bytes             = sizeof(*stg_ctx) + total_num_scalars * sizeof(stg_ctx->data[0]);
26224941a69SJames Wright     PetscCall(PetscMalloc(s->total_bytes, &stg_ctx));
263ba6664aeSJames Wright     *stg_ctx = *s;
26424941a69SJames Wright     PetscCall(PetscFree(s));
265ba6664aeSJames Wright   }
266ba6664aeSJames Wright 
26724941a69SJames Wright   PetscCall(ReadSTGInflow(comm, stg_inflow_path, stg_ctx));
26824941a69SJames Wright   PetscCall(ReadSTGRand(comm, stg_rand_path, stg_ctx));
269ba6664aeSJames Wright 
2704e139266SJames Wright   if (stg_ctx->nynodes > 0) {
2714e139266SJames Wright     CeedScalar *ynodes_ctx = &stg_ctx->data[stg_ctx->offsets.ynodes];
2724e139266SJames Wright     for (PetscInt i = 0; i < stg_ctx->nynodes; i++) ynodes_ctx[i] = ynodes[i];
2734e139266SJames Wright   }
2744e139266SJames Wright 
275ba6664aeSJames Wright   // -- Calculate kappa
276ba6664aeSJames Wright   {
277ba6664aeSJames Wright     CeedScalar *kappa     = &stg_ctx->data[stg_ctx->offsets.kappa];
278175f00a6SJames Wright     CeedScalar *wall_dist = &stg_ctx->data[stg_ctx->offsets.wall_dist];
279ba6664aeSJames Wright     CeedScalar *lt        = &stg_ctx->data[stg_ctx->offsets.lt];
280ba6664aeSJames Wright     CeedScalar  le, le_max = 0;
281ba6664aeSJames Wright 
2822b730f8bSJeremy L Thompson     CeedPragmaSIMD for (PetscInt i = 0; i < stg_ctx->nprofs; i++) {
283175f00a6SJames Wright       le = PetscMin(2 * wall_dist[i], 3 * lt[i]);
284ba6664aeSJames Wright       if (le_max < le) le_max = le;
285ba6664aeSJames Wright     }
286ba6664aeSJames Wright     CeedScalar kmin = M_PI / le_max;
287ba6664aeSJames Wright 
2882b730f8bSJeremy L Thompson     CeedPragmaSIMD for (PetscInt i = 0; i < stg_ctx->nmodes; i++) { kappa[i] = kmin * pow(stg_ctx->alpha, i); }
289ba6664aeSJames Wright   }  // end calculate kappa
290ba6664aeSJames Wright 
29124941a69SJames Wright   PetscCall(PetscFree(*pstg_ctx));
292ba6664aeSJames Wright   *pstg_ctx = stg_ctx;
293ba6664aeSJames Wright   PetscFunctionReturn(0);
294ba6664aeSJames Wright }
295ba6664aeSJames Wright 
2962b730f8bSJeremy L Thompson PetscErrorCode SetupSTG(const MPI_Comm comm, const DM dm, ProblemData *problem, User user, const bool prescribe_T, const CeedScalar theta0,
2972b730f8bSJeremy L Thompson                         const CeedScalar P0, const CeedScalar ynodes[], const CeedInt nynodes) {
298ba6664aeSJames Wright   char                     stg_inflow_path[PETSC_MAX_PATH_LEN] = "./STGInflow.dat";
299ba6664aeSJames Wright   char                     stg_rand_path[PETSC_MAX_PATH_LEN]   = "./STGRand.dat";
3002b730f8bSJeremy L Thompson   PetscBool                mean_only = PETSC_FALSE, use_stgstrong = PETSC_FALSE, use_fluctuating_IC = PETSC_FALSE;
3012b730f8bSJeremy L Thompson   CeedScalar               u0 = 0.0, alpha = 1.01;
302ba6664aeSJames Wright   CeedQFunctionContext     stg_context;
303ba6664aeSJames Wright   NewtonianIdealGasContext newtonian_ig_ctx;
304ba6664aeSJames Wright   PetscFunctionBeginUser;
305ba6664aeSJames Wright 
306ba6664aeSJames Wright   // Get options
307ba6664aeSJames Wright   PetscOptionsBegin(comm, NULL, "STG Boundary Condition Options", NULL);
3082b730f8bSJeremy L Thompson   PetscCall(PetscOptionsString("-stg_inflow_path", "Path to STGInflow.dat", NULL, stg_inflow_path, stg_inflow_path, sizeof(stg_inflow_path), NULL));
3092b730f8bSJeremy L Thompson   PetscCall(PetscOptionsString("-stg_rand_path", "Path to STGInflow.dat", NULL, stg_rand_path, stg_rand_path, sizeof(stg_rand_path), NULL));
3102b730f8bSJeremy L Thompson   PetscCall(PetscOptionsReal("-stg_alpha", "Growth rate of the wavemodes", NULL, alpha, &alpha, NULL));
3112b730f8bSJeremy L Thompson   PetscCall(PetscOptionsReal("-stg_u0", "Advective velocity for the fluctuations", NULL, u0, &u0, NULL));
3122b730f8bSJeremy L Thompson   PetscCall(PetscOptionsBool("-stg_mean_only", "Only apply mean profile", NULL, mean_only, &mean_only, NULL));
3132b730f8bSJeremy L Thompson   PetscCall(PetscOptionsBool("-stg_strong", "Enforce STG inflow strongly", NULL, use_stgstrong, &use_stgstrong, NULL));
3142b730f8bSJeremy L Thompson   PetscCall(PetscOptionsBool("-stg_fluctuating_IC", "\"Extrude\" the fluctuations through the domain as an initial condition", NULL,
3152b730f8bSJeremy L Thompson                              use_fluctuating_IC, &use_fluctuating_IC, NULL));
316ba6664aeSJames Wright   PetscOptionsEnd();
317ba6664aeSJames Wright 
31824941a69SJames Wright   PetscCall(PetscCalloc1(1, &global_stg_ctx));
31965dd5cafSJames Wright   global_stg_ctx->alpha              = alpha;
32065dd5cafSJames Wright   global_stg_ctx->u0                 = u0;
32165dd5cafSJames Wright   global_stg_ctx->is_implicit        = user->phys->implicit;
32265dd5cafSJames Wright   global_stg_ctx->prescribe_T        = prescribe_T;
32365dd5cafSJames Wright   global_stg_ctx->mean_only          = mean_only;
32489060322SJames Wright   global_stg_ctx->use_fluctuating_IC = use_fluctuating_IC;
32565dd5cafSJames Wright   global_stg_ctx->theta0             = theta0;
32665dd5cafSJames Wright   global_stg_ctx->P0                 = P0;
32765dd5cafSJames Wright   global_stg_ctx->nynodes            = nynodes;
328ba6664aeSJames Wright 
329ba6664aeSJames Wright   {
330ba6664aeSJames Wright     // Calculate dx assuming constant spacing
331ba6664aeSJames Wright     PetscReal domain_min[3], domain_max[3], domain_size[3];
33224941a69SJames Wright     PetscCall(DMGetBoundingBox(dm, domain_min, domain_max));
333ba6664aeSJames Wright     for (PetscInt i = 0; i < 3; i++) domain_size[i] = domain_max[i] - domain_min[i];
334ba6664aeSJames Wright 
335ba6664aeSJames Wright     PetscInt nmax = 3, faces[3];
3362b730f8bSJeremy L Thompson     PetscCall(PetscOptionsGetIntArray(NULL, NULL, "-dm_plex_box_faces", faces, &nmax, NULL));
33765dd5cafSJames Wright     global_stg_ctx->dx = domain_size[0] / faces[0];
33865dd5cafSJames Wright     global_stg_ctx->dz = domain_size[2] / faces[2];
339ba6664aeSJames Wright   }
340ba6664aeSJames Wright 
3412b730f8bSJeremy L Thompson   CeedQFunctionContextGetData(problem->apply_vol_rhs.qfunction_context, CEED_MEM_HOST, &newtonian_ig_ctx);
34265dd5cafSJames Wright   global_stg_ctx->newtonian_ctx = *newtonian_ig_ctx;
3432b730f8bSJeremy L Thompson   CeedQFunctionContextRestoreData(problem->apply_vol_rhs.qfunction_context, &newtonian_ig_ctx);
344ba6664aeSJames Wright 
3452b730f8bSJeremy L Thompson   PetscCall(GetSTGContextData(comm, dm, stg_inflow_path, stg_rand_path, &global_stg_ctx, ynodes));
346ba6664aeSJames Wright 
347ba6664aeSJames Wright   CeedQFunctionContextCreate(user->ceed, &stg_context);
3482b730f8bSJeremy L Thompson   CeedQFunctionContextSetData(stg_context, CEED_MEM_HOST, CEED_USE_POINTER, global_stg_ctx->total_bytes, global_stg_ctx);
3492b730f8bSJeremy L Thompson   CeedQFunctionContextSetDataDestroy(stg_context, CEED_MEM_HOST, FreeContextPetsc);
3502b730f8bSJeremy L Thompson   CeedQFunctionContextRegisterDouble(stg_context, "solution time", offsetof(struct STGShur14Context_, time), 1, "Physical time of the solution");
351ba6664aeSJames Wright 
352b77c53c9SJames Wright   CeedQFunctionContextDestroy(&problem->ics.qfunction_context);
353b77c53c9SJames Wright   problem->ics.qfunction         = ICsSTG;
354b77c53c9SJames Wright   problem->ics.qfunction_loc     = ICsSTG_loc;
355b77c53c9SJames Wright   problem->ics.qfunction_context = stg_context;
356b77c53c9SJames Wright 
3574e139266SJames Wright   if (use_stgstrong) {
35865dd5cafSJames Wright     // Use default boundary integral QF (BoundaryIntegral) in newtonian.h
359dada6cc0SJames Wright     problem->use_dirichlet_ceed = PETSC_TRUE;
36036b31e27SJames Wright     problem->bc_from_ics        = PETSC_FALSE;
3614e139266SJames Wright   } else {
362ba6664aeSJames Wright     problem->apply_inflow.qfunction              = STGShur14_Inflow;
363ba6664aeSJames Wright     problem->apply_inflow.qfunction_loc          = STGShur14_Inflow_loc;
3644dbab5e5SJames Wright     problem->apply_inflow_jacobian.qfunction     = STGShur14_Inflow_Jacobian;
3654dbab5e5SJames Wright     problem->apply_inflow_jacobian.qfunction_loc = STGShur14_Inflow_Jacobian_loc;
3662b730f8bSJeremy L Thompson     CeedQFunctionContextReferenceCopy(stg_context, &problem->apply_inflow.qfunction_context);
3672b730f8bSJeremy L Thompson     CeedQFunctionContextReferenceCopy(stg_context, &problem->apply_inflow_jacobian.qfunction_context);
36836b31e27SJames Wright     problem->bc_from_ics = PETSC_TRUE;
3694e139266SJames Wright   }
370ba6664aeSJames Wright 
371ba6664aeSJames Wright   PetscFunctionReturn(0);
372ba6664aeSJames Wright }
3734e139266SJames Wright 
3742b730f8bSJeremy L Thompson static inline PetscScalar FindDy(const PetscScalar ynodes[], const PetscInt nynodes, const PetscScalar y) {
3754e139266SJames Wright   const PetscScalar half_mindy = 0.5 * (ynodes[1] - ynodes[0]);
3764e139266SJames Wright   // ^^assuming min(dy) is first element off the wall
3774e139266SJames Wright   PetscInt idx = -1;  // Index
3784e139266SJames Wright 
3794e139266SJames Wright   for (PetscInt i = 0; i < nynodes; i++) {
3804e139266SJames Wright     if (y < ynodes[i] + half_mindy) {
3812b730f8bSJeremy L Thompson       idx = i;
3822b730f8bSJeremy L Thompson       break;
3834e139266SJames Wright     }
3844e139266SJames Wright   }
3854e139266SJames Wright   if (idx == 0) return ynodes[1] - ynodes[0];
3864e139266SJames Wright   else if (idx == nynodes - 1) return ynodes[nynodes - 2] - ynodes[nynodes - 1];
3874e139266SJames Wright   else return 0.5 * (ynodes[idx + 1] - ynodes[idx - 1]);
3884e139266SJames Wright }
3894e139266SJames Wright 
3904e139266SJames Wright // Function passed to DMAddBoundary
391dada6cc0SJames Wright // NOTE: Not used in favor of QFunction-based method
3922b730f8bSJeremy L Thompson PetscErrorCode StrongSTGbcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[], void *ctx) {
3934e139266SJames Wright   PetscFunctionBeginUser;
3942b730f8bSJeremy L Thompson 
3954e139266SJames Wright   const STGShur14Context stg_ctx = (STGShur14Context)ctx;
3964e139266SJames Wright   PetscScalar            qn[stg_ctx->nmodes], u[3], ubar[3], cij[6], eps, lt;
3974e139266SJames Wright   const bool             mean_only = stg_ctx->mean_only;
3984e139266SJames Wright   const PetscScalar      dx        = stg_ctx->dx;
3994e139266SJames Wright   const PetscScalar      dz        = stg_ctx->dz;
4004e139266SJames Wright   const PetscScalar      mu        = stg_ctx->newtonian_ctx.mu;
4014e139266SJames Wright   const PetscScalar      theta0    = stg_ctx->theta0;
4024e139266SJames Wright   const PetscScalar      P0        = stg_ctx->P0;
4034e139266SJames Wright   const PetscScalar      cv        = stg_ctx->newtonian_ctx.cv;
4044e139266SJames Wright   const PetscScalar      cp        = stg_ctx->newtonian_ctx.cp;
4054e139266SJames Wright   const PetscScalar      Rd        = cp - cv;
4064e139266SJames Wright 
4074e139266SJames Wright   const CeedScalar rho = P0 / (Rd * theta0);
4084e139266SJames Wright   InterpolateProfile(x[1], ubar, cij, &eps, &lt, stg_ctx);
4094e139266SJames Wright   if (!mean_only) {
4104e139266SJames Wright     const PetscInt     nynodes = stg_ctx->nynodes;
4114e139266SJames Wright     const PetscScalar *ynodes  = &stg_ctx->data[stg_ctx->offsets.ynodes];
4124e139266SJames Wright     const PetscScalar  h[3]    = {dx, FindDy(ynodes, nynodes, x[1]), dz};
4134e139266SJames Wright     CalcSpectrum(x[1], eps, lt, h, mu / rho, qn, stg_ctx);
4144e139266SJames Wright     STGShur14_Calc(x, time, ubar, cij, qn, u, stg_ctx);
4154e139266SJames Wright   } else {
4164e139266SJames Wright     for (CeedInt j = 0; j < 3; j++) u[j] = ubar[j];
4174e139266SJames Wright   }
4184e139266SJames Wright 
4194e139266SJames Wright   bcval[0] = rho;
4204e139266SJames Wright   bcval[1] = rho * u[0];
4214e139266SJames Wright   bcval[2] = rho * u[1];
4224e139266SJames Wright   bcval[3] = rho * u[2];
4234e139266SJames Wright   PetscFunctionReturn(0);
4244e139266SJames Wright }
4254e139266SJames Wright 
4262b730f8bSJeremy L Thompson PetscErrorCode SetupStrongSTG(DM dm, SimpleBC bc, ProblemData *problem, Physics phys) {
4274e139266SJames Wright   DMLabel label;
4284e139266SJames Wright   PetscFunctionBeginUser;
4294e139266SJames Wright 
430192a7459SJames Wright   PetscInt comps[5], num_comps = 4;
43197baf651SJames Wright   switch (phys->state_var) {
43297baf651SJames Wright     case STATEVAR_CONSERVATIVE:
433192a7459SJames Wright       // {0,1,2,3} for rho, rho*u, rho*v, rho*w
434192a7459SJames Wright       for (int i = 0; i < 4; i++) comps[i] = i;
43597baf651SJames Wright       break;
43697baf651SJames Wright 
43797baf651SJames Wright     case STATEVAR_PRIMITIVE:
43897baf651SJames Wright       // {1,2,3,4} for u, v, w, T
43997baf651SJames Wright       for (int i = 0; i < 4; i++) comps[i] = i + 1;
44097baf651SJames Wright       break;
441192a7459SJames Wright   }
442192a7459SJames Wright 
44324941a69SJames Wright   PetscCall(DMGetLabel(dm, "Face Sets", &label));
4444e139266SJames Wright   // Set wall BCs
4454e139266SJames Wright   if (bc->num_inflow > 0) {
4462b730f8bSJeremy L Thompson     PetscCall(DMAddBoundary(dm, DM_BC_ESSENTIAL, "STG", label, bc->num_inflow, bc->inflows, 0, num_comps, comps, (void (*)(void))StrongSTGbcFunc,
44724941a69SJames Wright                             NULL, global_stg_ctx, NULL));
4484e139266SJames Wright   }
4494e139266SJames Wright 
4504e139266SJames Wright   PetscFunctionReturn(0);
4514e139266SJames Wright }
452dada6cc0SJames Wright 
4532b730f8bSJeremy L Thompson PetscErrorCode SetupStrongSTG_QF(Ceed ceed, ProblemData *problem, CeedInt num_comp_x, CeedInt num_comp_q, CeedInt stg_data_size,
4545dc40723SJames Wright                                  CeedInt q_data_size_sur, CeedQFunction *pqf_strongbc) {
455dada6cc0SJames Wright   CeedQFunction qf_strongbc;
456dada6cc0SJames Wright   PetscFunctionBeginUser;
4572b730f8bSJeremy L Thompson   CeedQFunctionCreateInterior(ceed, 1, STGShur14_Inflow_StrongQF, STGShur14_Inflow_StrongQF_loc, &qf_strongbc);
4582b730f8bSJeremy L Thompson   CeedQFunctionAddInput(qf_strongbc, "surface qdata", q_data_size_sur, CEED_EVAL_NONE);
459dada6cc0SJames Wright   CeedQFunctionAddInput(qf_strongbc, "x", num_comp_x, CEED_EVAL_NONE);
460dada6cc0SJames Wright   CeedQFunctionAddInput(qf_strongbc, "scale", 1, CEED_EVAL_NONE);
4615dc40723SJames Wright   CeedQFunctionAddInput(qf_strongbc, "stg data", stg_data_size, CEED_EVAL_NONE);
462dada6cc0SJames Wright   CeedQFunctionAddOutput(qf_strongbc, "q", num_comp_q, CEED_EVAL_NONE);
463dada6cc0SJames Wright 
464dada6cc0SJames Wright   CeedQFunctionSetContext(qf_strongbc, problem->ics.qfunction_context);
465dada6cc0SJames Wright   *pqf_strongbc = qf_strongbc;
466dada6cc0SJames Wright   PetscFunctionReturn(0);
467dada6cc0SJames Wright }
4685dc40723SJames Wright 
4692b730f8bSJeremy L Thompson PetscErrorCode SetupStrongSTG_PreProcessing(Ceed ceed, ProblemData *problem, CeedInt num_comp_x, CeedInt stg_data_size, CeedInt q_data_size_sur,
4705dc40723SJames Wright                                             CeedQFunction *pqf_strongbc) {
4715dc40723SJames Wright   CeedQFunction qf_strongbc;
4725dc40723SJames Wright   PetscFunctionBeginUser;
4732b730f8bSJeremy L Thompson   CeedQFunctionCreateInterior(ceed, 1, Preprocess_STGShur14, Preprocess_STGShur14_loc, &qf_strongbc);
4742b730f8bSJeremy L Thompson   CeedQFunctionAddInput(qf_strongbc, "surface qdata", q_data_size_sur, CEED_EVAL_NONE);
4755dc40723SJames Wright   CeedQFunctionAddInput(qf_strongbc, "x", num_comp_x, CEED_EVAL_NONE);
4765dc40723SJames Wright   CeedQFunctionAddOutput(qf_strongbc, "stg data", stg_data_size, CEED_EVAL_NONE);
4775dc40723SJames Wright 
4785dc40723SJames Wright   CeedQFunctionSetContext(qf_strongbc, problem->ics.qfunction_context);
4795dc40723SJames Wright   *pqf_strongbc = qf_strongbc;
4805dc40723SJames Wright   PetscFunctionReturn(0);
4815dc40723SJames Wright }
482