xref: /honee/qfunctions/stg_shur14.h (revision 78e8b7da6af85c065c35ddcb7a107c82a97d64cc)
1ae2b091fSJames Wright // SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors.
2ae2b091fSJames Wright // SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause
3493642f1SJames Wright 
4493642f1SJames Wright /// @file
5493642f1SJames Wright /// Implementation of the Synthetic Turbulence Generation (STG) algorithm
6493642f1SJames Wright /// presented in Shur et al. 2014
7493642f1SJames Wright //
804e40bb6SJeremy L Thompson /// SetupSTG_Rand reads in the input files and fills in STGShur14Context.
904e40bb6SJeremy L Thompson /// Then STGShur14_CalcQF is run over quadrature points.
1004e40bb6SJeremy L Thompson /// Before the program exits, TearDownSTG is run to free the memory of the allocated arrays.
11493642f1SJames Wright #include <ceed.h>
12d0cce58aSJeremy L Thompson #include <math.h>
13493642f1SJames Wright #include <stdlib.h>
142b916ea7SJeremy L Thompson 
153d65b166SJames Wright #include "newtonian_state.h"
161a74fa30SJames Wright #include "setupgeo_helpers.h"
17493642f1SJames Wright #include "stg_shur14_type.h"
18704b8bbeSJames Wright #include "utils.h"
19493642f1SJames Wright 
20493642f1SJames Wright #define STG_NMODES_MAX 1024
21493642f1SJames Wright 
22493642f1SJames Wright /*
23493642f1SJames Wright  * @brief Interpolate quantities from input profile to given location
24493642f1SJames Wright  *
25c77f3192SJames Wright  * Assumed that prof_wd[i+1] > prof_wd[i] and prof_wd[0] = 0
26c77f3192SJames Wright  * If wall_dist > prof_wd[-1], then the interpolation takes the values at prof_wd[-1]
27493642f1SJames Wright  *
28c77f3192SJames Wright  * @param[in]  wall_dist Distance to the nearest wall
29c77f3192SJames Wright  * @param[out] ubar      Mean velocity at wall_dist
30c77f3192SJames Wright  * @param[out] cij       Cholesky decomposition at wall_dist
31c77f3192SJames Wright  * @param[out] eps       Turbulent dissipation at wall_dist
32c77f3192SJames Wright  * @param[out] lt        Turbulent length scale at wall_dist
33493642f1SJames Wright  * @param[in]  stg_ctx   STGShur14Context for the problem
34493642f1SJames Wright  */
352b916ea7SJeremy L Thompson CEED_QFUNCTION_HELPER void InterpolateProfile(const CeedScalar wall_dist, CeedScalar ubar[3], CeedScalar cij[6], CeedScalar *eps, CeedScalar *lt,
3642454adaSJames Wright                                               const StgShur14Context stg_ctx) {
37493642f1SJames Wright   const CeedInt     nprofs    = stg_ctx->nprofs;
38c77f3192SJames Wright   const CeedScalar *prof_wd   = &stg_ctx->data[stg_ctx->offsets.wall_dist];
39493642f1SJames Wright   const CeedScalar *prof_eps  = &stg_ctx->data[stg_ctx->offsets.eps];
40493642f1SJames Wright   const CeedScalar *prof_lt   = &stg_ctx->data[stg_ctx->offsets.lt];
41493642f1SJames Wright   const CeedScalar *prof_ubar = &stg_ctx->data[stg_ctx->offsets.ubar];
42493642f1SJames Wright   const CeedScalar *prof_cij  = &stg_ctx->data[stg_ctx->offsets.cij];
43493642f1SJames Wright   CeedInt           idx       = -1;
44493642f1SJames Wright 
45493642f1SJames Wright   for (CeedInt i = 0; i < nprofs; i++) {
46c77f3192SJames Wright     if (wall_dist < prof_wd[i]) {
47493642f1SJames Wright       idx = i;
48493642f1SJames Wright       break;
49493642f1SJames Wright     }
50493642f1SJames Wright   }
51493642f1SJames Wright 
52c77f3192SJames Wright   if (idx > 0) {  // y within the bounds of prof_wd
53c77f3192SJames Wright     CeedScalar coeff = (wall_dist - prof_wd[idx - 1]) / (prof_wd[idx] - prof_wd[idx - 1]);
54c77f3192SJames Wright 
55493642f1SJames Wright     ubar[0] = prof_ubar[0 * nprofs + idx - 1] + coeff * (prof_ubar[0 * nprofs + idx] - prof_ubar[0 * nprofs + idx - 1]);
56493642f1SJames Wright     ubar[1] = prof_ubar[1 * nprofs + idx - 1] + coeff * (prof_ubar[1 * nprofs + idx] - prof_ubar[1 * nprofs + idx - 1]);
57493642f1SJames Wright     ubar[2] = prof_ubar[2 * nprofs + idx - 1] + coeff * (prof_ubar[2 * nprofs + idx] - prof_ubar[2 * nprofs + idx - 1]);
58493642f1SJames Wright     cij[0]  = prof_cij[0 * nprofs + idx - 1] + coeff * (prof_cij[0 * nprofs + idx] - prof_cij[0 * nprofs + idx - 1]);
59493642f1SJames Wright     cij[1]  = prof_cij[1 * nprofs + idx - 1] + coeff * (prof_cij[1 * nprofs + idx] - prof_cij[1 * nprofs + idx - 1]);
60493642f1SJames Wright     cij[2]  = prof_cij[2 * nprofs + idx - 1] + coeff * (prof_cij[2 * nprofs + idx] - prof_cij[2 * nprofs + idx - 1]);
61493642f1SJames Wright     cij[3]  = prof_cij[3 * nprofs + idx - 1] + coeff * (prof_cij[3 * nprofs + idx] - prof_cij[3 * nprofs + idx - 1]);
62493642f1SJames Wright     cij[4]  = prof_cij[4 * nprofs + idx - 1] + coeff * (prof_cij[4 * nprofs + idx] - prof_cij[4 * nprofs + idx - 1]);
63493642f1SJames Wright     cij[5]  = prof_cij[5 * nprofs + idx - 1] + coeff * (prof_cij[5 * nprofs + idx] - prof_cij[5 * nprofs + idx - 1]);
64493642f1SJames Wright     *eps    = prof_eps[idx - 1] + coeff * (prof_eps[idx] - prof_eps[idx - 1]);
65493642f1SJames Wright     *lt     = prof_lt[idx - 1] + coeff * (prof_lt[idx] - prof_lt[idx - 1]);
66c77f3192SJames Wright   } else {  // y outside bounds of prof_wd
67493642f1SJames Wright     ubar[0] = prof_ubar[1 * nprofs - 1];
68493642f1SJames Wright     ubar[1] = prof_ubar[2 * nprofs - 1];
69493642f1SJames Wright     ubar[2] = prof_ubar[3 * nprofs - 1];
70493642f1SJames Wright     cij[0]  = prof_cij[1 * nprofs - 1];
71493642f1SJames Wright     cij[1]  = prof_cij[2 * nprofs - 1];
72493642f1SJames Wright     cij[2]  = prof_cij[3 * nprofs - 1];
73493642f1SJames Wright     cij[3]  = prof_cij[4 * nprofs - 1];
74493642f1SJames Wright     cij[4]  = prof_cij[5 * nprofs - 1];
75493642f1SJames Wright     cij[5]  = prof_cij[6 * nprofs - 1];
76493642f1SJames Wright     *eps    = prof_eps[nprofs - 1];
77493642f1SJames Wright     *lt     = prof_lt[nprofs - 1];
78493642f1SJames Wright   }
79493642f1SJames Wright }
80493642f1SJames Wright 
81493642f1SJames Wright /*
8271cd6200SJames Wright  * @brief Calculate spectrum coefficient, qn
8371cd6200SJames Wright  *
8471cd6200SJames Wright  * Calculates q_n at a given distance to the wall
8571cd6200SJames Wright  *
8671cd6200SJames Wright  * @param[in]  kappa     nth wavenumber
8771cd6200SJames Wright  * @param[in]  dkappa    Difference between wavenumbers
8871cd6200SJames Wright  * @param[in]  keta      Dissipation wavenumber
8971cd6200SJames Wright  * @param[in]  kcut      Mesh-induced cutoff wavenumber
9071cd6200SJames Wright  * @param[in]  ke        Energy-containing wavenumber
919ef62cddSJames Wright  * @param[in]  Ektot_inv Inverse of total turbulent kinetic energy of spectrum
9271cd6200SJames Wright  * @returns    qn        Spectrum coefficient
9371cd6200SJames Wright  */
942b916ea7SJeremy L Thompson CEED_QFUNCTION_HELPER CeedScalar Calc_qn(const CeedScalar kappa, const CeedScalar dkappa, const CeedScalar keta, const CeedScalar kcut,
9570b0cb14SJames Wright                                          const CeedScalar ke, const CeedScalar Ektot_inv) {
962b916ea7SJeremy L Thompson   const CeedScalar feta_x_fcut = exp(-Square(12 * kappa / keta) - Cube(4 * Max(kappa - 0.9 * kcut, 0) / kcut));
972b916ea7SJeremy L Thompson   return pow(kappa / ke, 4.) * pow(1 + 2.4 * Square(kappa / ke), -17. / 6) * feta_x_fcut * dkappa * Ektot_inv;
9871cd6200SJames Wright }
9971cd6200SJames Wright 
10071cd6200SJames Wright // Calculate hmax, ke, keta, and kcut
10184b557acSJames Wright CEED_QFUNCTION_HELPER void SpectrumConstants(const CeedScalar wall_dist, const CeedScalar eps, const CeedScalar lt, const CeedScalar hNodSep[3],
1022b916ea7SJeremy L Thompson                                              const CeedScalar nu, CeedScalar *hmax, CeedScalar *ke, CeedScalar *keta, CeedScalar *kcut) {
10384b557acSJames Wright   *hmax = Max(Max(hNodSep[0], hNodSep[1]), hNodSep[2]);
104c77f3192SJames Wright   *ke   = wall_dist == 0 ? 1e16 : 2 * M_PI / Min(2 * wall_dist, 3 * lt);
10571cd6200SJames Wright   *keta = 2 * M_PI * pow(Cube(nu) / eps, -0.25);
10684b557acSJames Wright   *kcut = M_PI / Min(Max(Max(hNodSep[1], hNodSep[2]), 0.3 * (*hmax)) + 0.1 * wall_dist, *hmax);
10771cd6200SJames Wright }
10871cd6200SJames Wright 
10971cd6200SJames Wright /*
110493642f1SJames Wright  * @brief Calculate spectrum coefficients for STG
111493642f1SJames Wright  *
112493642f1SJames Wright  * Calculates q_n at a given distance to the wall
113493642f1SJames Wright  *
114c77f3192SJames Wright  * @param[in]  wall_dist  Distance to the nearest wall
115c77f3192SJames Wright  * @param[in]  eps        Turbulent dissipation w/rt wall_dist
116c77f3192SJames Wright  * @param[in]  lt         Turbulent length scale w/rt wall_dist
11784b557acSJames Wright  * @param[in]  h_node_sep Element lengths in coordinate directions
118493642f1SJames Wright  * @param[in]  nu         Dynamic Viscosity;
119493642f1SJames Wright  * @param[in]  stg_ctx    STGShur14Context for the problem
120493642f1SJames Wright  * @param[out] qn         Spectrum coefficients, [nmodes]
121493642f1SJames Wright  */
12284b557acSJames Wright CEED_QFUNCTION_HELPER void CalcSpectrum(const CeedScalar wall_dist, const CeedScalar eps, const CeedScalar lt, const CeedScalar h_node_sep[3],
12342454adaSJames Wright                                         const CeedScalar nu, CeedScalar qn[], const StgShur14Context stg_ctx) {
124493642f1SJames Wright   const CeedInt     nmodes = stg_ctx->nmodes;
125493642f1SJames Wright   const CeedScalar *kappa  = &stg_ctx->data[stg_ctx->offsets.kappa];
12671cd6200SJames Wright   CeedScalar        hmax, ke, keta, kcut, Ektot = 0.0;
1272b916ea7SJeremy L Thompson 
12884b557acSJames Wright   SpectrumConstants(wall_dist, eps, lt, h_node_sep, nu, &hmax, &ke, &keta, &kcut);
129493642f1SJames Wright 
130493642f1SJames Wright   for (CeedInt n = 0; n < nmodes; n++) {
13171cd6200SJames Wright     const CeedScalar dkappa = n == 0 ? kappa[0] : kappa[n] - kappa[n - 1];
13271cd6200SJames Wright     qn[n]                   = Calc_qn(kappa[n], dkappa, keta, kcut, ke, 1.0);
133493642f1SJames Wright     Ektot += qn[n];
134493642f1SJames Wright   }
135493642f1SJames Wright 
1360a8dc919SJames Wright   if (Ektot == 0) return;
137493642f1SJames Wright   for (CeedInt n = 0; n < nmodes; n++) qn[n] /= Ektot;
138493642f1SJames Wright }
139493642f1SJames Wright 
140493642f1SJames Wright /******************************************************
141493642f1SJames Wright  * @brief Calculate u(x,t) for STG inflow condition
142493642f1SJames Wright  *
143493642f1SJames Wright  * @param[in]  X       Location to evaluate u(X,t)
144493642f1SJames Wright  * @param[in]  t       Time to evaluate u(X,t)
145493642f1SJames Wright  * @param[in]  ubar    Mean velocity at X
146493642f1SJames Wright  * @param[in]  cij     Cholesky decomposition at X
147493642f1SJames Wright  * @param[in]  qn      Wavemode amplitudes at X, [nmodes]
148493642f1SJames Wright  * @param[out] u       Velocity at X and t
149493642f1SJames Wright  * @param[in]  stg_ctx STGShur14Context for the problem
150493642f1SJames Wright  */
15142454adaSJames Wright CEED_QFUNCTION_HELPER void StgShur14Calc(const CeedScalar X[3], const CeedScalar t, const CeedScalar ubar[3], const CeedScalar cij[6],
15242454adaSJames Wright                                          const CeedScalar qn[], CeedScalar u[3], const StgShur14Context stg_ctx) {
153493642f1SJames Wright   const CeedInt     nmodes = stg_ctx->nmodes;
154493642f1SJames Wright   const CeedScalar *kappa  = &stg_ctx->data[stg_ctx->offsets.kappa];
155493642f1SJames Wright   const CeedScalar *phi    = &stg_ctx->data[stg_ctx->offsets.phi];
156493642f1SJames Wright   const CeedScalar *sigma  = &stg_ctx->data[stg_ctx->offsets.sigma];
157493642f1SJames Wright   const CeedScalar *d      = &stg_ctx->data[stg_ctx->offsets.d];
158493642f1SJames Wright   CeedScalar        xdotd, vp[3] = {0.};
159493642f1SJames Wright   CeedScalar        xhat[] = {0., X[1], X[2]};
160493642f1SJames Wright 
1612b916ea7SJeremy L Thompson   CeedPragmaSIMD for (CeedInt n = 0; n < nmodes; n++) {
162493642f1SJames Wright     xhat[0] = (X[0] - stg_ctx->u0 * t) * Max(2 * kappa[0] / kappa[n], 0.1);
163493642f1SJames Wright     xdotd   = 0.;
164493642f1SJames Wright     for (CeedInt i = 0; i < 3; i++) xdotd += d[i * nmodes + n] * xhat[i];
165493642f1SJames Wright     const CeedScalar cos_kxdp = cos(kappa[n] * xdotd + phi[n]);
1660a8dc919SJames Wright     vp[0] += sqrt(qn[n]) * sigma[0 * nmodes + n] * cos_kxdp;
1670a8dc919SJames Wright     vp[1] += sqrt(qn[n]) * sigma[1 * nmodes + n] * cos_kxdp;
1680a8dc919SJames Wright     vp[2] += sqrt(qn[n]) * sigma[2 * nmodes + n] * cos_kxdp;
169493642f1SJames Wright   }
1700a8dc919SJames Wright   for (CeedInt i = 0; i < 3; i++) vp[i] *= 2 * sqrt(1.5);
171493642f1SJames Wright 
172493642f1SJames Wright   u[0] = ubar[0] + cij[0] * vp[0];
173493642f1SJames Wright   u[1] = ubar[1] + cij[3] * vp[0] + cij[1] * vp[1];
174493642f1SJames Wright   u[2] = ubar[2] + cij[4] * vp[0] + cij[5] * vp[1] + cij[2] * vp[2];
175493642f1SJames Wright }
176493642f1SJames Wright 
1778eea80fcSJames Wright /******************************************************
1788eea80fcSJames Wright  * @brief Calculate u(x,t) for STG inflow condition
1798eea80fcSJames Wright  *
1808eea80fcSJames Wright  * @param[in]  X          Location to evaluate u(X,t)
1818eea80fcSJames Wright  * @param[in]  t          Time to evaluate u(X,t)
1828eea80fcSJames Wright  * @param[in]  ubar       Mean velocity at X
1838eea80fcSJames Wright  * @param[in]  cij        Cholesky decomposition at X
184c77f3192SJames Wright  * @param[in]  Ektot      Total spectrum energy at this location
18584b557acSJames Wright  * @param[in]  h_node_sep Element size in 3 directions
186c77f3192SJames Wright  * @param[in]  wall_dist  Distance to closest wall
187c77f3192SJames Wright  * @param[in]  eps        Turbulent dissipation
188c77f3192SJames Wright  * @param[in]  lt         Turbulent length scale
1898eea80fcSJames Wright  * @param[out] u          Velocity at X and t
1908eea80fcSJames Wright  * @param[in]  stg_ctx    STGShur14Context for the problem
1918eea80fcSJames Wright  */
19242454adaSJames Wright CEED_QFUNCTION_HELPER void StgShur14Calc_PrecompEktot(const CeedScalar X[3], const CeedScalar t, const CeedScalar ubar[3], const CeedScalar cij[6],
19384b557acSJames Wright                                                       const CeedScalar Ektot, const CeedScalar h_node_sep[3], const CeedScalar wall_dist,
19484b557acSJames Wright                                                       const CeedScalar eps, const CeedScalar lt, const CeedScalar nu, CeedScalar u[3],
19584b557acSJames Wright                                                       const StgShur14Context stg_ctx) {
1968eea80fcSJames Wright   const CeedInt     nmodes = stg_ctx->nmodes;
1978eea80fcSJames Wright   const CeedScalar *kappa  = &stg_ctx->data[stg_ctx->offsets.kappa];
1988eea80fcSJames Wright   const CeedScalar *phi    = &stg_ctx->data[stg_ctx->offsets.phi];
1998eea80fcSJames Wright   const CeedScalar *sigma  = &stg_ctx->data[stg_ctx->offsets.sigma];
2008eea80fcSJames Wright   const CeedScalar *d      = &stg_ctx->data[stg_ctx->offsets.d];
2018eea80fcSJames Wright   CeedScalar        hmax, ke, keta, kcut;
20284b557acSJames Wright   SpectrumConstants(wall_dist, eps, lt, h_node_sep, nu, &hmax, &ke, &keta, &kcut);
2038eea80fcSJames Wright   CeedScalar xdotd, vp[3] = {0.};
2048eea80fcSJames Wright   CeedScalar xhat[] = {0., X[1], X[2]};
2058eea80fcSJames Wright 
2062b916ea7SJeremy L Thompson   CeedPragmaSIMD for (CeedInt n = 0; n < nmodes; n++) {
2078eea80fcSJames Wright     xhat[0] = (X[0] - stg_ctx->u0 * t) * Max(2 * kappa[0] / kappa[n], 0.1);
2088eea80fcSJames Wright     xdotd   = 0.;
2098eea80fcSJames Wright     for (CeedInt i = 0; i < 3; i++) xdotd += d[i * nmodes + n] * xhat[i];
2108eea80fcSJames Wright     const CeedScalar cos_kxdp = cos(kappa[n] * xdotd + phi[n]);
2118eea80fcSJames Wright     const CeedScalar dkappa   = n == 0 ? kappa[0] : kappa[n] - kappa[n - 1];
2128eea80fcSJames Wright     const CeedScalar qn       = Calc_qn(kappa[n], dkappa, keta, kcut, ke, Ektot);
2138eea80fcSJames Wright     vp[0] += sqrt(qn) * sigma[0 * nmodes + n] * cos_kxdp;
2148eea80fcSJames Wright     vp[1] += sqrt(qn) * sigma[1 * nmodes + n] * cos_kxdp;
2158eea80fcSJames Wright     vp[2] += sqrt(qn) * sigma[2 * nmodes + n] * cos_kxdp;
2168eea80fcSJames Wright   }
2178eea80fcSJames Wright   for (CeedInt i = 0; i < 3; i++) vp[i] *= 2 * sqrt(1.5);
2188eea80fcSJames Wright 
2198eea80fcSJames Wright   u[0] = ubar[0] + cij[0] * vp[0];
2208eea80fcSJames Wright   u[1] = ubar[1] + cij[3] * vp[0] + cij[1] * vp[1];
2218eea80fcSJames Wright   u[2] = ubar[2] + cij[4] * vp[0] + cij[5] * vp[1] + cij[2] * vp[2];
2228eea80fcSJames Wright }
2238eea80fcSJames Wright 
2248424c23aSJames Wright /**
2258424c23aSJames Wright    @brief Calculate the element length scales based on dXdx
2268424c23aSJames Wright 
2278424c23aSJames Wright    WARNING: This assumes the reference domain is [-1,1], which is not true for tetrahedral elements
2288424c23aSJames Wright 
2298424c23aSJames Wright    @param[in]  dXdx    Inverse mapping Jacobian, d\xi/dx
2308424c23aSJames Wright    @param[in]  scale   Scale factor for the element lengths
2318424c23aSJames Wright    @param[out] lengths The element lengths in each cartesian direction
2328424c23aSJames Wright **/
2338424c23aSJames Wright CEED_QFUNCTION_HELPER void CalculateElementLengths(CeedScalar dXdx[3][3], CeedScalar scale, CeedScalar lengths[3]) {
2348424c23aSJames Wright   for (CeedInt j = 0; j < 3; j++) lengths[j] = 2 / sqrt(Square(dXdx[0][j]) + Square(dXdx[1][j]) + Square(dXdx[2][j]));
2358424c23aSJames Wright   ScaleN(lengths, scale, 3);
2368424c23aSJames Wright }
2378424c23aSJames Wright 
23870b0cb14SJames Wright // Create preprocessed input for the stg calculation
23970b0cb14SJames Wright //
24070b0cb14SJames Wright // stg_data[0] = 1 / Ektot (inverse of total spectrum energy)
24142454adaSJames Wright CEED_QFUNCTION(StgShur14Preprocess)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) {
24221ba7ba4SJames Wright   const CeedScalar *dXdx_q         = in[0];
2433d65b166SJames Wright   const CeedScalar(*x)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[1];
2448eea80fcSJames Wright 
2458eea80fcSJames Wright   CeedScalar(*stg_data) = (CeedScalar(*))out[0];
2468eea80fcSJames Wright 
2478eea80fcSJames Wright   CeedScalar             ubar[3], cij[6], eps, lt;
24842454adaSJames Wright   const StgShur14Context stg_ctx = (StgShur14Context)ctx;
2498eea80fcSJames Wright   const CeedScalar       mu      = stg_ctx->newtonian_ctx.mu;
2508eea80fcSJames Wright   const CeedScalar       theta0  = stg_ctx->theta0;
2518eea80fcSJames Wright   const CeedScalar       P0      = stg_ctx->P0;
2523d65b166SJames Wright   const CeedScalar       Rd      = GasConstant(&stg_ctx->newtonian_ctx);
2538eea80fcSJames Wright   const CeedScalar       rho     = P0 / (Rd * theta0);
2548eea80fcSJames Wright   const CeedScalar       nu      = mu / rho;
2558eea80fcSJames Wright 
2568eea80fcSJames Wright   const CeedInt     nmodes = stg_ctx->nmodes;
2578eea80fcSJames Wright   const CeedScalar *kappa  = &stg_ctx->data[stg_ctx->offsets.kappa];
2589eeef72bSJames Wright   CeedScalar        hmax, ke, keta, kcut;
2598eea80fcSJames Wright 
2602b916ea7SJeremy L Thompson   CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) {
261c77f3192SJames Wright     const CeedScalar wall_dist = x[1][i];
2628424c23aSJames Wright     CeedScalar       dXdx[3][3], h_node_sep[3];
26321ba7ba4SJames Wright     StoredValuesUnpack(Q, i, 0, 9, dXdx_q, (CeedScalar *)dXdx);
2648eea80fcSJames Wright 
2658424c23aSJames Wright     CalculateElementLengths(dXdx, stg_ctx->h_scale_factor, h_node_sep);
266c77f3192SJames Wright     InterpolateProfile(wall_dist, ubar, cij, &eps, &lt, stg_ctx);
26784b557acSJames Wright     SpectrumConstants(wall_dist, eps, lt, h_node_sep, nu, &hmax, &ke, &keta, &kcut);
2688eea80fcSJames Wright 
2698eea80fcSJames Wright     // Calculate total TKE per spectrum
2702f638ed2SJames Wright     CeedScalar Ek_tot = 0;
2712b916ea7SJeremy L Thompson     CeedPragmaSIMD for (CeedInt n = 0; n < nmodes; n++) {
2728eea80fcSJames Wright       const CeedScalar dkappa = n == 0 ? kappa[0] : kappa[n] - kappa[n - 1];
2732f638ed2SJames Wright       Ek_tot += Calc_qn(kappa[n], dkappa, keta, kcut, ke, 1.0);
2748eea80fcSJames Wright     }
2752f638ed2SJames Wright     // avoid underflowed and poorly defined spectrum coefficients
2762f638ed2SJames Wright     stg_data[i] = Ek_tot != 0 ? 1 / Ek_tot : 0;
2778eea80fcSJames Wright   }
2788eea80fcSJames Wright   return 0;
2798eea80fcSJames Wright }
2808eea80fcSJames Wright 
28143bff553SJames Wright // Extrude the STGInflow profile through out the domain for an initial condition
28242454adaSJames Wright CEED_QFUNCTION(ICsStg)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) {
2833d65b166SJames Wright   const CeedScalar(*x)[CEED_Q_VLA]    = (const CeedScalar(*)[CEED_Q_VLA])in[0];
2844f0244d1SJeremy L Thompson   const CeedScalar(*J)[3][CEED_Q_VLA] = (const CeedScalar(*)[3][CEED_Q_VLA])in[1];
28543bff553SJames Wright   CeedScalar(*q0)[CEED_Q_VLA]         = (CeedScalar(*)[CEED_Q_VLA])out[0];
28643bff553SJames Wright 
28742454adaSJames Wright   const StgShur14Context         stg_ctx = (StgShur14Context)ctx;
2889b103f75SJames Wright   const NewtonianIdealGasContext gas     = &stg_ctx->newtonian_ctx;
289d4e0f297SJames Wright   CeedScalar                     qn[STG_NMODES_MAX], u[3], ubar[3], cij[6], eps, lt;
290d4e0f297SJames Wright   const CeedScalar               dx     = stg_ctx->dx;
291d4e0f297SJames Wright   const CeedScalar               time   = stg_ctx->time;
29243bff553SJames Wright   const CeedScalar               theta0 = stg_ctx->theta0;
29343bff553SJames Wright   const CeedScalar               P0     = stg_ctx->P0;
2949b103f75SJames Wright   const CeedScalar               rho    = P0 / (GasConstant(gas) * theta0);
2959b103f75SJames Wright   const CeedScalar               nu     = gas->mu / rho;
29643bff553SJames Wright 
2972b916ea7SJeremy L Thompson   CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) {
298d4e0f297SJames Wright     const CeedScalar x_i[3] = {x[0][i], x[1][i], x[2][i]};
2994f0244d1SJeremy L Thompson     CeedScalar       dXdx[3][3];
3001a74fa30SJames Wright     InvertMappingJacobian_3D(Q, i, J, dXdx, NULL);
30184b557acSJames Wright     CeedScalar h_node_sep[3];
30284b557acSJames Wright     h_node_sep[0] = dx;
30384b557acSJames Wright     for (CeedInt j = 1; j < 3; j++) h_node_sep[j] = 2 / sqrt(Square(dXdx[0][j]) + Square(dXdx[1][j]) + Square(dXdx[2][j]));
30484b557acSJames Wright     ScaleN(h_node_sep, stg_ctx->h_scale_factor, 3);
305d4e0f297SJames Wright 
306d4e0f297SJames Wright     InterpolateProfile(x_i[1], ubar, cij, &eps, &lt, stg_ctx);
307d4e0f297SJames Wright     if (stg_ctx->use_fluctuating_IC) {
30884b557acSJames Wright       CalcSpectrum(x_i[1], eps, lt, h_node_sep, nu, qn, stg_ctx);
30942454adaSJames Wright       StgShur14Calc(x_i, time, ubar, cij, qn, u, stg_ctx);
310d4e0f297SJames Wright     } else {
311d4e0f297SJames Wright       for (CeedInt j = 0; j < 3; j++) u[j] = ubar[j];
312d4e0f297SJames Wright     }
31343bff553SJames Wright 
3149b103f75SJames Wright     CeedScalar Y[5] = {P0, u[0], u[1], u[2], theta0}, q[5];
3159b103f75SJames Wright     State      s    = StateFromY(gas, Y);
3169b103f75SJames Wright     StateToQ(gas, s, q, gas->state_var);
3179b103f75SJames Wright     for (CeedInt j = 0; j < 5; j++) {
3189b103f75SJames Wright       q0[j][i] = q[j];
31988243482SJames Wright     }
320b193fadcSJames Wright   }
32143bff553SJames Wright   return 0;
32243bff553SJames Wright }
32343bff553SJames Wright 
324493642f1SJames Wright /********************************************************************
325493642f1SJames Wright  * @brief QFunction to calculate the inflow boundary condition
326493642f1SJames Wright  *
327493642f1SJames Wright  * This will loop through quadrature points, calculate the wavemode amplitudes
328493642f1SJames Wright  * at each location, then calculate the actual velocity.
329493642f1SJames Wright  */
33042454adaSJames Wright CEED_QFUNCTION(StgShur14Inflow)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) {
3313d65b166SJames Wright   const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0];
332ade49511SJames Wright   const CeedScalar(*q_data_sur)    = in[2];
3333d65b166SJames Wright   const CeedScalar(*X)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[3];
334493642f1SJames Wright 
3353d65b166SJames Wright   CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0];
336ade49511SJames Wright   CeedScalar(*jac_data_sur)  = out[1];
337493642f1SJames Wright 
33842454adaSJames Wright   const StgShur14Context stg_ctx = (StgShur14Context)ctx;
339493642f1SJames Wright   CeedScalar             qn[STG_NMODES_MAX], u[3], ubar[3], cij[6], eps, lt;
340493642f1SJames Wright   const bool             is_implicit = stg_ctx->is_implicit;
341493642f1SJames Wright   const bool             mean_only   = stg_ctx->mean_only;
342493642f1SJames Wright   const bool             prescribe_T = stg_ctx->prescribe_T;
343493642f1SJames Wright   const CeedScalar       dx          = stg_ctx->dx;
344493642f1SJames Wright   const CeedScalar       mu          = stg_ctx->newtonian_ctx.mu;
345493642f1SJames Wright   const CeedScalar       time        = stg_ctx->time;
346493642f1SJames Wright   const CeedScalar       theta0      = stg_ctx->theta0;
347493642f1SJames Wright   const CeedScalar       P0          = stg_ctx->P0;
348493642f1SJames Wright   const CeedScalar       cv          = stg_ctx->newtonian_ctx.cv;
3493d65b166SJames Wright   const CeedScalar       Rd          = GasConstant(&stg_ctx->newtonian_ctx);
3503d65b166SJames Wright   const CeedScalar       gamma       = HeatCapacityRatio(&stg_ctx->newtonian_ctx);
351493642f1SJames Wright 
3522b916ea7SJeremy L Thompson   CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) {
353493642f1SJames Wright     const CeedScalar rho = prescribe_T ? q[0][i] : P0 / (Rd * theta0);
354493642f1SJames Wright     const CeedScalar x[] = {X[0][i], X[1][i], X[2][i]};
355*78e8b7daSJames Wright     CeedScalar       wdetJb, dXdx[2][3], normal[3];
356*78e8b7daSJames Wright     QdataBoundaryUnpack_3D(Q, i, q_data_sur, &wdetJb, dXdx, normal);
357ade49511SJames Wright     wdetJb *= is_implicit ? -1. : 1.;
358493642f1SJames Wright 
35984b557acSJames Wright     CeedScalar h_node_sep[3];
36084b557acSJames Wright     h_node_sep[0] = dx;
36184b557acSJames Wright     for (CeedInt j = 1; j < 3; j++) h_node_sep[j] = 2 / sqrt(Square(dXdx[0][j]) + Square(dXdx[1][j]));
36284b557acSJames Wright     ScaleN(h_node_sep, stg_ctx->h_scale_factor, 3);
363493642f1SJames Wright 
364493642f1SJames Wright     InterpolateProfile(X[1][i], ubar, cij, &eps, &lt, stg_ctx);
365493642f1SJames Wright     if (!mean_only) {
36684b557acSJames Wright       CalcSpectrum(X[1][i], eps, lt, h_node_sep, mu / rho, qn, stg_ctx);
36742454adaSJames Wright       StgShur14Calc(x, time, ubar, cij, qn, u, stg_ctx);
368493642f1SJames Wright     } else {
369493642f1SJames Wright       for (CeedInt j = 0; j < 3; j++) u[j] = ubar[j];
370493642f1SJames Wright     }
371493642f1SJames Wright 
372a6e8f989SJames Wright     const CeedScalar E_kinetic = .5 * rho * Dot3(u, u);
373493642f1SJames Wright     CeedScalar       E_internal, P;
374493642f1SJames Wright     if (prescribe_T) {
375493642f1SJames Wright       // Temperature is being set weakly (theta0) and for constant cv this sets E_internal
376493642f1SJames Wright       E_internal = rho * cv * theta0;
377493642f1SJames Wright       // Find pressure using
378493642f1SJames Wright       P = rho * Rd * theta0;  // interior rho with exterior T
379493642f1SJames Wright     } else {
380493642f1SJames Wright       E_internal = q[4][i] - E_kinetic;  // uses prescribed rho and u, E from solution
381493642f1SJames Wright       P          = E_internal * (gamma - 1.);
382493642f1SJames Wright     }
383493642f1SJames Wright 
384493642f1SJames Wright     const CeedScalar E = E_internal + E_kinetic;
385493642f1SJames Wright 
386493642f1SJames Wright     // Velocity normal to the boundary
387*78e8b7daSJames Wright     const CeedScalar u_normal = Dot3(normal, u);
388a6e8f989SJames Wright 
389493642f1SJames Wright     // The Physics
390493642f1SJames Wright     // Zero v so all future terms can safely sum into it
391493642f1SJames Wright     for (CeedInt j = 0; j < 5; j++) v[j][i] = 0.;
392493642f1SJames Wright 
393493642f1SJames Wright     // The Physics
394493642f1SJames Wright     // -- Density
395493642f1SJames Wright     v[0][i] -= wdetJb * rho * u_normal;
396493642f1SJames Wright 
397493642f1SJames Wright     // -- Momentum
398*78e8b7daSJames Wright     for (CeedInt j = 0; j < 3; j++) v[j + 1][i] -= wdetJb * (rho * u_normal * u[j] + normal[j] * P);
399493642f1SJames Wright 
400493642f1SJames Wright     // -- Total Energy Density
401493642f1SJames Wright     v[4][i] -= wdetJb * u_normal * (E + P);
402a6e8f989SJames Wright 
403ade49511SJames Wright     const CeedScalar U[] = {rho, u[0], u[1], u[2], E}, kmstress[6] = {0.};
404ade49511SJames Wright     StoredValuesPack(Q, i, 0, 5, U, jac_data_sur);
405ade49511SJames Wright     StoredValuesPack(Q, i, 5, 6, kmstress, jac_data_sur);
406493642f1SJames Wright   }
407493642f1SJames Wright   return 0;
408493642f1SJames Wright }
409493642f1SJames Wright 
41042454adaSJames Wright CEED_QFUNCTION(StgShur14Inflow_Jacobian)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) {
4113d65b166SJames Wright   const CeedScalar(*dq)[CEED_Q_VLA]           = (const CeedScalar(*)[CEED_Q_VLA])in[0];
4123d65b166SJames Wright   const CeedScalar(*q_data_sur)[CEED_Q_VLA]   = (const CeedScalar(*)[CEED_Q_VLA])in[2];
4133d65b166SJames Wright   const CeedScalar(*jac_data_sur)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[4];
414a6e8f989SJames Wright   CeedScalar(*v)[CEED_Q_VLA]                  = (CeedScalar(*)[CEED_Q_VLA])out[0];
4153d65b166SJames Wright 
41642454adaSJames Wright   const StgShur14Context stg_ctx  = (StgShur14Context)ctx;
417a6e8f989SJames Wright   const bool             implicit = stg_ctx->is_implicit;
418a6e8f989SJames Wright   const CeedScalar       cv       = stg_ctx->newtonian_ctx.cv;
4193d65b166SJames Wright   const CeedScalar       Rd       = GasConstant(&stg_ctx->newtonian_ctx);
4203d65b166SJames Wright   const CeedScalar       gamma    = HeatCapacityRatio(&stg_ctx->newtonian_ctx);
421a6e8f989SJames Wright 
422a6e8f989SJames Wright   const CeedScalar theta0      = stg_ctx->theta0;
423a6e8f989SJames Wright   const bool       prescribe_T = stg_ctx->prescribe_T;
424a6e8f989SJames Wright 
425b193fadcSJames Wright   CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) {
426a6e8f989SJames Wright     // Setup
427a6e8f989SJames Wright     // -- Interp-to-Interp q_data
428a6e8f989SJames Wright     // For explicit mode, the surface integral is on the RHS of ODE q_dot = f(q).
429a6e8f989SJames Wright     // For implicit mode, it gets pulled to the LHS of implicit ODE/DAE g(q_dot, q).
430a6e8f989SJames Wright     // We can effect this by swapping the sign on this weight
431a6e8f989SJames Wright     const CeedScalar wdetJb = (implicit ? -1. : 1.) * q_data_sur[0][i];
432a6e8f989SJames Wright 
433a6e8f989SJames Wright     // Calculate inflow values
434a6e8f989SJames Wright     CeedScalar velocity[3];
435a6e8f989SJames Wright     for (CeedInt j = 0; j < 3; j++) velocity[j] = jac_data_sur[5 + j][i];
436ade49511SJames Wright     // TODO This is almost certainly a bug. Velocity isn't stored here, only 0s.
437a6e8f989SJames Wright 
438a6e8f989SJames Wright     // enabling user to choose between weak T and weak rho inflow
439a6e8f989SJames Wright     CeedScalar drho, dE, dP;
440a6e8f989SJames Wright     if (prescribe_T) {
441a6e8f989SJames Wright       // rho should be from the current solution
442a6e8f989SJames Wright       drho                   = dq[0][i];
443a6e8f989SJames Wright       CeedScalar dE_internal = drho * cv * theta0;
444a6e8f989SJames Wright       CeedScalar dE_kinetic  = .5 * drho * Dot3(velocity, velocity);
445a6e8f989SJames Wright       dE                     = dE_internal + dE_kinetic;
446a6e8f989SJames Wright       dP                     = drho * Rd * theta0;  // interior rho with exterior T
447a6e8f989SJames Wright     } else {                                        // rho specified, E_internal from solution
448a6e8f989SJames Wright       drho = 0;
449a6e8f989SJames Wright       dE   = dq[4][i];
450a6e8f989SJames Wright       dP   = dE * (gamma - 1.);
451a6e8f989SJames Wright     }
452*78e8b7daSJames Wright     const CeedScalar normal[3] = {q_data_sur[1][i], q_data_sur[2][i], q_data_sur[3][i]};
453a6e8f989SJames Wright 
454*78e8b7daSJames Wright     const CeedScalar u_normal = Dot3(normal, velocity);
455a6e8f989SJames Wright 
456a6e8f989SJames Wright     v[0][i] = -wdetJb * drho * u_normal;
457*78e8b7daSJames Wright     for (int j = 0; j < 3; j++) v[j + 1][i] = -wdetJb * (drho * u_normal * velocity[j] + normal[j] * dP);
458a6e8f989SJames Wright     v[4][i] = -wdetJb * u_normal * (dE + dP);
459b193fadcSJames Wright   }
460a6e8f989SJames Wright   return 0;
461a6e8f989SJames Wright }
462a6e8f989SJames Wright 
463b7190ff7SJames Wright /********************************************************************
464b7190ff7SJames Wright  * @brief QFunction to calculate the strongly enforce inflow BC
465b7190ff7SJames Wright  *
466b7190ff7SJames Wright  * This QF is for the strong application of STG via libCEED (rather than
467b7190ff7SJames Wright  * through the native PETSc `DMAddBoundary` -> `bcFunc` method.
468b7190ff7SJames Wright  */
46942454adaSJames Wright CEED_QFUNCTION(StgShur14InflowStrongQF)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) {
47021ba7ba4SJames Wright   const CeedScalar *dXdx_q              = in[0];
4713d65b166SJames Wright   const CeedScalar(*coords)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[1];
4723d65b166SJames Wright   const CeedScalar(*scale)              = (const CeedScalar(*))in[2];
4739ef62cddSJames Wright   const CeedScalar(*inv_Ektotal)        = (const CeedScalar(*))in[3];
474b7190ff7SJames Wright   CeedScalar(*bcval)[CEED_Q_VLA]        = (CeedScalar(*)[CEED_Q_VLA])out[0];
475b7190ff7SJames Wright 
47642454adaSJames Wright   const StgShur14Context         stg_ctx = (StgShur14Context)ctx;
4779b103f75SJames Wright   const NewtonianIdealGasContext gas     = &stg_ctx->newtonian_ctx;
47870b0cb14SJames Wright   CeedScalar                     u[3], ubar[3], cij[6], eps, lt;
479b7190ff7SJames Wright   const bool                     mean_only = stg_ctx->mean_only;
480b7190ff7SJames Wright   const CeedScalar               time      = stg_ctx->time;
481b7190ff7SJames Wright   const CeedScalar               theta0    = stg_ctx->theta0;
482b7190ff7SJames Wright   const CeedScalar               P0        = stg_ctx->P0;
4839b103f75SJames Wright   const CeedScalar               rho       = P0 / (GasConstant(gas) * theta0);
4849b103f75SJames Wright   const CeedScalar               nu        = gas->mu / rho;
485b7190ff7SJames Wright 
4862b916ea7SJeremy L Thompson   CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) {
487b7190ff7SJames Wright     const CeedScalar x[] = {coords[0][i], coords[1][i], coords[2][i]};
4888424c23aSJames Wright     CeedScalar       dXdx[3][3], h_node_sep[3];
48921ba7ba4SJames Wright     StoredValuesUnpack(Q, i, 0, 9, dXdx_q, (CeedScalar *)dXdx);
490b7190ff7SJames Wright 
4918424c23aSJames Wright     CalculateElementLengths(dXdx, stg_ctx->h_scale_factor, h_node_sep);
492b7190ff7SJames Wright     InterpolateProfile(coords[1][i], ubar, cij, &eps, &lt, stg_ctx);
493b7190ff7SJames Wright     if (!mean_only) {
49470b0cb14SJames Wright       if (1) {
49584b557acSJames Wright         StgShur14Calc_PrecompEktot(x, time, ubar, cij, inv_Ektotal[i], h_node_sep, x[1], eps, lt, nu, u, stg_ctx);
49670b0cb14SJames Wright       } else {  // Original way
49770b0cb14SJames Wright         CeedScalar qn[STG_NMODES_MAX];
49884b557acSJames Wright         CalcSpectrum(coords[1][i], eps, lt, h_node_sep, nu, qn, stg_ctx);
49942454adaSJames Wright         StgShur14Calc(x, time, ubar, cij, qn, u, stg_ctx);
50070b0cb14SJames Wright       }
501b7190ff7SJames Wright     } else {
502b7190ff7SJames Wright       for (CeedInt j = 0; j < 3; j++) u[j] = ubar[j];
503b7190ff7SJames Wright     }
504b7190ff7SJames Wright 
5059b103f75SJames Wright     CeedScalar Y[5] = {P0, u[0], u[1], u[2], theta0}, q[5];
5069b103f75SJames Wright     State      s    = StateFromY(gas, Y);
5079b103f75SJames Wright     StateToQ(gas, s, q, gas->state_var);
5089b103f75SJames Wright     switch (gas->state_var) {
5093636f6a4SJames Wright       case STATEVAR_CONSERVATIVE:
5109b103f75SJames Wright         q[4] = 0.;  // Don't set energy
5113636f6a4SJames Wright         break;
5123636f6a4SJames Wright       case STATEVAR_PRIMITIVE:
5139b103f75SJames Wright         q[0] = 0;  // Don't set pressure
5143636f6a4SJames Wright         break;
5159b103f75SJames Wright       case STATEVAR_ENTROPY:
5169b103f75SJames Wright         q[0] = 0;  // Don't set V_density
5179b103f75SJames Wright         break;
5189b103f75SJames Wright     }
5199b103f75SJames Wright     for (CeedInt j = 0; j < 5; j++) {
5209b103f75SJames Wright       bcval[j][i] = scale[i] * q[j];
521b7190ff7SJames Wright     }
52288243482SJames Wright   }
523b7190ff7SJames Wright   return 0;
524b7190ff7SJames Wright }
525