xref: /libCEED/examples/fluids/qfunctions/stg_shur14.h (revision c3e017a42e1d587d084e2f836fe7db08abf77849)
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 /// Implementation of the Synthetic Turbulence Generation (STG) algorithm
10 /// presented in Shur et al. 2014
11 //
12 /// SetupSTG_Rand reads in the input files and fills in STGShur14Context. Then
13 /// STGShur14_CalcQF is run over quadrature points. Before the program exits,
14 /// TearDownSTG is run to free the memory of the allocated arrays.
15 
16 #ifndef stg_shur14_h
17 #define stg_shur14_h
18 
19 #include <math.h>
20 #include <ceed.h>
21 #include <stdlib.h>
22 #include "stg_shur14_type.h"
23 #include "utils.h"
24 
25 #define STG_NMODES_MAX 1024
26 
27 /*
28  * @brief Interpolate quantities from input profile to given location
29  *
30  * Assumed that prof_dw[i+1] > prof_dw[i] and prof_dw[0] = 0
31  * If dw > prof_dw[-1], then the interpolation takes the values at prof_dw[-1]
32  *
33  * @param[in]  dw      Distance to the nearest wall
34  * @param[out] ubar    Mean velocity at dw
35  * @param[out] cij     Cholesky decomposition at dw
36  * @param[out] eps     Turbulent dissipation at dw
37  * @param[out] lt      Turbulent length scale at dw
38  * @param[in]  stg_ctx STGShur14Context for the problem
39  */
40 CEED_QFUNCTION_HELPER void InterpolateProfile(const CeedScalar dw,
41     CeedScalar ubar[3], CeedScalar cij[6], CeedScalar *eps, CeedScalar *lt,
42     const STGShur14Context stg_ctx) {
43 
44   const CeedInt    nprofs    = stg_ctx->nprofs;
45   const CeedScalar *prof_dw  = &stg_ctx->data[stg_ctx->offsets.prof_dw];
46   const CeedScalar *prof_eps = &stg_ctx->data[stg_ctx->offsets.eps];
47   const CeedScalar *prof_lt  = &stg_ctx->data[stg_ctx->offsets.lt];
48   const CeedScalar *prof_ubar = &stg_ctx->data[stg_ctx->offsets.ubar];
49   const CeedScalar *prof_cij  = &stg_ctx->data[stg_ctx->offsets.cij];
50   CeedInt idx=-1;
51 
52   for(CeedInt i=0; i<nprofs; i++) {
53     if (dw < prof_dw[i]) {
54       idx = i;
55       break;
56     }
57   }
58 
59   if (idx > 0) { // y within the bounds of prof_dw
60     CeedScalar coeff = (dw - prof_dw[idx-1]) / (prof_dw[idx] - prof_dw[idx-1]);
61 
62     //*INDENT-OFF*
63     ubar[0] = prof_ubar[0*nprofs+idx-1] + coeff*( prof_ubar[0*nprofs+idx] - prof_ubar[0*nprofs+idx-1] );
64     ubar[1] = prof_ubar[1*nprofs+idx-1] + coeff*( prof_ubar[1*nprofs+idx] - prof_ubar[1*nprofs+idx-1] );
65     ubar[2] = prof_ubar[2*nprofs+idx-1] + coeff*( prof_ubar[2*nprofs+idx] - prof_ubar[2*nprofs+idx-1] );
66     cij[0]  = prof_cij[0*nprofs+idx-1]  + coeff*( prof_cij[0*nprofs+idx]  - prof_cij[0*nprofs+idx-1] );
67     cij[1]  = prof_cij[1*nprofs+idx-1]  + coeff*( prof_cij[1*nprofs+idx]  - prof_cij[1*nprofs+idx-1] );
68     cij[2]  = prof_cij[2*nprofs+idx-1]  + coeff*( prof_cij[2*nprofs+idx]  - prof_cij[2*nprofs+idx-1] );
69     cij[3]  = prof_cij[3*nprofs+idx-1]  + coeff*( prof_cij[3*nprofs+idx]  - prof_cij[3*nprofs+idx-1] );
70     cij[4]  = prof_cij[4*nprofs+idx-1]  + coeff*( prof_cij[4*nprofs+idx]  - prof_cij[4*nprofs+idx-1] );
71     cij[5]  = prof_cij[5*nprofs+idx-1]  + coeff*( prof_cij[5*nprofs+idx]  - prof_cij[5*nprofs+idx-1] );
72     *eps    = prof_eps[idx-1]           + coeff*( prof_eps[idx]           - prof_eps[idx-1] );
73     *lt     = prof_lt[idx-1]            + coeff*( prof_lt[idx]            - prof_lt[idx-1] );
74     //*INDENT-ON*
75   } else { // y outside bounds of prof_dw
76     ubar[0] = prof_ubar[1*nprofs-1];
77     ubar[1] = prof_ubar[2*nprofs-1];
78     ubar[2] = prof_ubar[3*nprofs-1];
79     cij[0]  = prof_cij[1*nprofs-1];
80     cij[1]  = prof_cij[2*nprofs-1];
81     cij[2]  = prof_cij[3*nprofs-1];
82     cij[3]  = prof_cij[4*nprofs-1];
83     cij[4]  = prof_cij[5*nprofs-1];
84     cij[5]  = prof_cij[6*nprofs-1];
85     *eps    = prof_eps[nprofs-1];
86     *lt     = prof_lt[nprofs-1];
87   }
88 }
89 
90 /*
91  * @brief Calculate spectrum coefficient, qn
92  *
93  * Calculates q_n at a given distance to the wall
94  *
95  * @param[in]  kappa  nth wavenumber
96  * @param[in]  dkappa Difference between wavenumbers
97  * @param[in]  keta   Dissipation wavenumber
98  * @param[in]  kcut   Mesh-induced cutoff wavenumber
99  * @param[in]  ke     Energy-containing wavenumber
100  * @param[in]  Ektot  Total turbulent kinetic energy of spectrum
101  * @returns    qn     Spectrum coefficient
102  */
103 CeedScalar CEED_QFUNCTION_HELPER(Calc_qn)(const CeedScalar kappa,
104     const CeedScalar dkappa, const CeedScalar keta, const CeedScalar kcut,
105     const CeedScalar ke, const CeedScalar Ektot_inv) {
106   const CeedScalar feta_x_fcut   = exp(-Square(12*kappa/keta)
107                                        -Cube(4*Max(kappa - 0.9*kcut, 0)/kcut) );
108   return pow(kappa/ke, 4.) * pow(1 + 2.4*Square(kappa/ke),-17./6)
109          *feta_x_fcut*dkappa * Ektot_inv;
110 }
111 
112 // Calculate hmax, ke, keta, and kcut
113 void CEED_QFUNCTION_HELPER(SpectrumConstants)(const CeedScalar dw,
114     const CeedScalar eps, const CeedScalar lt, const CeedScalar h[3],
115     const CeedScalar nu, CeedScalar *hmax, CeedScalar *ke,
116     CeedScalar *keta, CeedScalar *kcut) {
117   *hmax = Max( Max(h[0], h[1]), h[2]);
118   *ke   = dw==0 ? 1e16 : 2*M_PI/Min(2*dw, 3*lt);
119   *keta = 2*M_PI*pow(Cube(nu)/eps, -0.25);
120   *kcut = M_PI/ Min( Max(Max(h[1], h[2]), 0.3*(*hmax)) + 0.1*dw, *hmax );
121 }
122 
123 /*
124  * @brief Calculate spectrum coefficients for STG
125  *
126  * Calculates q_n at a given distance to the wall
127  *
128  * @param[in]  dw      Distance to the nearest wall
129  * @param[in]  eps     Turbulent dissipation w/rt dw
130  * @param[in]  lt      Turbulent length scale w/rt dw
131  * @param[in]  h       Element lengths in coordinate directions
132  * @param[in]  nu      Dynamic Viscosity;
133  * @param[in]  stg_ctx STGShur14Context for the problem
134  * @param[out] qn      Spectrum coefficients, [nmodes]
135  */
136 void CEED_QFUNCTION_HELPER(CalcSpectrum)(const CeedScalar dw,
137     const CeedScalar eps, const CeedScalar lt, const CeedScalar h[3],
138     const CeedScalar nu, CeedScalar qn[], const STGShur14Context stg_ctx) {
139 
140   const CeedInt    nmodes = stg_ctx->nmodes;
141   const CeedScalar *kappa = &stg_ctx->data[stg_ctx->offsets.kappa];
142   CeedScalar hmax, ke, keta, kcut, Ektot=0.0;
143   SpectrumConstants(dw, eps, lt, h, nu, &hmax, &ke, &keta, &kcut);
144 
145   for(CeedInt n=0; n<nmodes; n++) {
146     const CeedScalar dkappa = n==0 ? kappa[0] : kappa[n] - kappa[n-1];
147     qn[n] = Calc_qn(kappa[n], dkappa, keta, kcut, ke, 1.0);
148     Ektot += qn[n];
149   }
150 
151   if (Ektot == 0) return;
152   for(CeedInt n=0; n<nmodes; n++) qn[n] /= Ektot;
153 }
154 
155 /******************************************************
156  * @brief Calculate u(x,t) for STG inflow condition
157  *
158  * @param[in]  X       Location to evaluate u(X,t)
159  * @param[in]  t       Time to evaluate u(X,t)
160  * @param[in]  ubar    Mean velocity at X
161  * @param[in]  cij     Cholesky decomposition at X
162  * @param[in]  qn      Wavemode amplitudes at X, [nmodes]
163  * @param[out] u       Velocity at X and t
164  * @param[in]  stg_ctx STGShur14Context for the problem
165  */
166 void CEED_QFUNCTION_HELPER(STGShur14_Calc)(const CeedScalar X[3],
167     const CeedScalar t, const CeedScalar ubar[3], const CeedScalar cij[6],
168     const CeedScalar qn[], CeedScalar u[3],
169     const STGShur14Context stg_ctx) {
170 
171   //*INDENT-OFF*
172   const CeedInt    nmodes = stg_ctx->nmodes;
173   const CeedScalar *kappa = &stg_ctx->data[stg_ctx->offsets.kappa];
174   const CeedScalar *phi   = &stg_ctx->data[stg_ctx->offsets.phi];
175   const CeedScalar *sigma = &stg_ctx->data[stg_ctx->offsets.sigma];
176   const CeedScalar *d     = &stg_ctx->data[stg_ctx->offsets.d];
177   //*INDENT-ON*
178   CeedScalar xdotd, vp[3] = {0.};
179   CeedScalar xhat[] = {0., X[1], X[2]};
180 
181   CeedPragmaSIMD
182   for(CeedInt n=0; n<nmodes; n++) {
183     xhat[0] = (X[0] - stg_ctx->u0*t)*Max(2*kappa[0]/kappa[n], 0.1);
184     xdotd = 0.;
185     for(CeedInt i=0; i<3; i++) xdotd += d[i*nmodes+n]*xhat[i];
186     const CeedScalar cos_kxdp = cos(kappa[n]*xdotd + phi[n]);
187     vp[0] += sqrt(qn[n])*sigma[0*nmodes+n] * cos_kxdp;
188     vp[1] += sqrt(qn[n])*sigma[1*nmodes+n] * cos_kxdp;
189     vp[2] += sqrt(qn[n])*sigma[2*nmodes+n] * cos_kxdp;
190   }
191   for(CeedInt i=0; i<3; i++) vp[i] *= 2*sqrt(1.5);
192 
193   u[0] = ubar[0] + cij[0]*vp[0];
194   u[1] = ubar[1] + cij[3]*vp[0] + cij[1]*vp[1];
195   u[2] = ubar[2] + cij[4]*vp[0] + cij[5]*vp[1] + cij[2]*vp[2];
196 }
197 
198 /******************************************************
199  * @brief Calculate u(x,t) for STG inflow condition
200  *
201  * @param[in]  X       Location to evaluate u(X,t)
202  * @param[in]  t       Time to evaluate u(X,t)
203  * @param[in]  ubar    Mean velocity at X
204  * @param[in]  cij     Cholesky decomposition at X
205  * @param[in]  qn      Wavemode amplitudes at X, [nmodes]
206  * @param[out] u       Velocity at X and t
207  * @param[in]  stg_ctx STGShur14Context for the problem
208  */
209 void CEED_QFUNCTION_HELPER(STGShur14_Calc_PrecompEktot)(const CeedScalar X[3],
210     const CeedScalar t, const CeedScalar ubar[3], const CeedScalar cij[6],
211     const CeedScalar Ektot, const CeedScalar h[3], const CeedScalar dw,
212     const CeedScalar eps, const CeedScalar lt, const CeedScalar nu, CeedScalar u[3],
213     const STGShur14Context stg_ctx) {
214 
215   //*INDENT-OFF*
216   const CeedInt    nmodes = stg_ctx->nmodes;
217   const CeedScalar *kappa = &stg_ctx->data[stg_ctx->offsets.kappa];
218   const CeedScalar *phi   = &stg_ctx->data[stg_ctx->offsets.phi];
219   const CeedScalar *sigma = &stg_ctx->data[stg_ctx->offsets.sigma];
220   const CeedScalar *d     = &stg_ctx->data[stg_ctx->offsets.d];
221   //*INDENT-ON*
222   CeedScalar hmax, ke, keta, kcut;
223   SpectrumConstants(dw, eps, lt, h, nu, &hmax, &ke, &keta, &kcut);
224   CeedScalar xdotd, vp[3] = {0.};
225   CeedScalar xhat[] = {0., X[1], X[2]};
226 
227   CeedPragmaSIMD
228   for(CeedInt n=0; n<nmodes; n++) {
229     xhat[0] = (X[0] - stg_ctx->u0*t)*Max(2*kappa[0]/kappa[n], 0.1);
230     xdotd = 0.;
231     for(CeedInt i=0; i<3; i++) xdotd += d[i*nmodes+n]*xhat[i];
232     const CeedScalar cos_kxdp = cos(kappa[n]*xdotd + phi[n]);
233     const CeedScalar dkappa   = n==0 ? kappa[0] : kappa[n] - kappa[n-1];
234     const CeedScalar qn       = Calc_qn(kappa[n], dkappa, keta, kcut, ke, Ektot);
235     vp[0] += sqrt(qn)*sigma[0*nmodes+n] * cos_kxdp;
236     vp[1] += sqrt(qn)*sigma[1*nmodes+n] * cos_kxdp;
237     vp[2] += sqrt(qn)*sigma[2*nmodes+n] * cos_kxdp;
238   }
239   for(CeedInt i=0; i<3; i++) vp[i] *= 2*sqrt(1.5);
240 
241   u[0] = ubar[0] + cij[0]*vp[0];
242   u[1] = ubar[1] + cij[3]*vp[0] + cij[1]*vp[1];
243   u[2] = ubar[2] + cij[4]*vp[0] + cij[5]*vp[1] + cij[2]*vp[2];
244 }
245 
246 // Create preprocessed input for the stg calculation
247 //
248 // stg_data[0] = 1 / Ektot (inverse of total spectrum energy)
249 CEED_QFUNCTION(Preprocess_STGShur14)(void *ctx, CeedInt Q,
250                                      const CeedScalar *const *in, CeedScalar *const *out) {
251   //*INDENT-OFF*
252   const CeedScalar (*q_data_sur)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA]) in[0],
253                    (*x)[CEED_Q_VLA]          = (const CeedScalar(*)[CEED_Q_VLA]) in[1];
254 
255   CeedScalar (*stg_data) = (CeedScalar(*)) out[0];
256 
257   //*INDENT-ON*
258   CeedScalar ubar[3], cij[6], eps, lt;
259   const STGShur14Context stg_ctx = (STGShur14Context) ctx;
260   const CeedScalar dx     = stg_ctx->dx;
261   const CeedScalar mu     = stg_ctx->newtonian_ctx.mu;
262   const CeedScalar theta0 = stg_ctx->theta0;
263   const CeedScalar P0     = stg_ctx->P0;
264   const CeedScalar cv     = stg_ctx->newtonian_ctx.cv;
265   const CeedScalar cp     = stg_ctx->newtonian_ctx.cp;
266   const CeedScalar Rd     = cp - cv;
267   const CeedScalar rho    = P0 / (Rd * theta0);
268   const CeedScalar nu     = mu / rho;
269 
270   const CeedInt    nmodes = stg_ctx->nmodes;
271   const CeedScalar *kappa = &stg_ctx->data[stg_ctx->offsets.kappa];
272   CeedScalar hmax, ke, keta, kcut;
273 
274   CeedPragmaSIMD
275   for(CeedInt i=0; i<Q; i++) {
276     const CeedScalar dw = x[1][i];
277     const CeedScalar dXdx[2][3] = {
278       {q_data_sur[4][i], q_data_sur[5][i], q_data_sur[6][i]},
279       {q_data_sur[7][i], q_data_sur[8][i], q_data_sur[9][i]}
280     };
281 
282     CeedScalar h[3];
283     h[0] = dx;
284     for (CeedInt j=1; j<3; j++)
285       h[j] = 2/sqrt(dXdx[0][j]*dXdx[0][j] + dXdx[1][j]*dXdx[1][j]);
286 
287     InterpolateProfile(dw, ubar, cij, &eps, &lt, stg_ctx);
288     SpectrumConstants(dw, eps, lt, h, nu, &hmax, &ke, &keta, &kcut);
289 
290     // Calculate total TKE per spectrum
291     stg_data[i] = 0.;
292     CeedPragmaSIMD
293     for(CeedInt n=0; n<nmodes; n++) {
294       const CeedScalar dkappa = n==0 ? kappa[0] : kappa[n] - kappa[n-1];
295       stg_data[i] += Calc_qn(kappa[n], dkappa, keta, kcut, ke, 1.0);
296     }
297     stg_data[i] = 1/stg_data[i];
298   }
299   return 0;
300 }
301 
302 // Extrude the STGInflow profile through out the domain for an initial condition
303 CEED_QFUNCTION(ICsSTG)(void *ctx, CeedInt Q,
304                        const CeedScalar *const *in, CeedScalar *const *out) {
305   // Inputs
306   const CeedScalar (*X)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0];
307 
308   // Outputs
309   CeedScalar (*q0)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0];
310 
311   const STGShur14Context stg_ctx = (STGShur14Context) ctx;
312   CeedScalar u[3], cij[6], eps, lt;
313   const CeedScalar theta0 = stg_ctx->theta0;
314   const CeedScalar P0     = stg_ctx->P0;
315   const CeedScalar cv     = stg_ctx->newtonian_ctx.cv;
316   const CeedScalar cp     = stg_ctx->newtonian_ctx.cp;
317   const CeedScalar Rd     = cp - cv;
318   const CeedScalar rho    = P0 / (Rd * theta0);
319 
320   CeedPragmaSIMD
321   for(CeedInt i=0; i<Q; i++) {
322     InterpolateProfile(X[1][i], u, cij, &eps, &lt, stg_ctx);
323 
324     q0[0][i] = rho;
325     q0[1][i] = u[0] * rho;
326     q0[2][i] = u[1] * rho;
327     q0[3][i] = u[2] * rho;
328     q0[4][i] = rho * (0.5 * Dot3(u, u) + cv * theta0);
329   } // End of Quadrature Point Loop
330   return 0;
331 }
332 
333 /********************************************************************
334  * @brief QFunction to calculate the inflow boundary condition
335  *
336  * This will loop through quadrature points, calculate the wavemode amplitudes
337  * at each location, then calculate the actual velocity.
338  */
339 CEED_QFUNCTION(STGShur14_Inflow)(void *ctx, CeedInt Q,
340                                  const CeedScalar *const *in,
341                                  CeedScalar *const *out) {
342 
343   //*INDENT-OFF*
344   const CeedScalar (*q)[CEED_Q_VLA]          = (const CeedScalar(*)[CEED_Q_VLA]) in[0],
345                    (*q_data_sur)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA]) in[2],
346                    (*X)[CEED_Q_VLA]          = (const CeedScalar(*)[CEED_Q_VLA]) in[3];
347 
348   CeedScalar(*v)[CEED_Q_VLA]            = (CeedScalar(*)[CEED_Q_VLA]) out[0],
349             (*jac_data_sur)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA]) out[1];
350 
351   //*INDENT-ON*
352 
353   const STGShur14Context stg_ctx = (STGShur14Context) ctx;
354   CeedScalar qn[STG_NMODES_MAX], u[3], ubar[3], cij[6], eps, lt;
355   const bool is_implicit  = stg_ctx->is_implicit;
356   const bool mean_only    = stg_ctx->mean_only;
357   const bool prescribe_T  = stg_ctx->prescribe_T;
358   const CeedScalar dx     = stg_ctx->dx;
359   const CeedScalar mu     = stg_ctx->newtonian_ctx.mu;
360   const CeedScalar time   = stg_ctx->time;
361   const CeedScalar theta0 = stg_ctx->theta0;
362   const CeedScalar P0     = stg_ctx->P0;
363   const CeedScalar cv     = stg_ctx->newtonian_ctx.cv;
364   const CeedScalar cp     = stg_ctx->newtonian_ctx.cp;
365   const CeedScalar Rd     = cp - cv;
366   const CeedScalar gamma  = cp/cv;
367 
368   CeedPragmaSIMD
369   for(CeedInt i=0; i<Q; i++) {
370     const CeedScalar rho = prescribe_T ? q[0][i] : P0 / (Rd * theta0);
371     const CeedScalar x[] = { X[0][i], X[1][i], X[2][i] };
372     const CeedScalar dXdx[2][3] = {
373       {q_data_sur[4][i], q_data_sur[5][i], q_data_sur[6][i]},
374       {q_data_sur[7][i], q_data_sur[8][i], q_data_sur[9][i]}
375     };
376 
377     CeedScalar h[3];
378     h[0] = dx;
379     for (CeedInt j=1; j<3; j++)
380       h[j] = 2/sqrt(Square(dXdx[0][j]) + Square(dXdx[1][j]));
381 
382     InterpolateProfile(X[1][i], ubar, cij, &eps, &lt, stg_ctx);
383     if (!mean_only) {
384       CalcSpectrum(X[1][i], eps, lt, h, mu/rho, qn, stg_ctx);
385       STGShur14_Calc(x, time, ubar, cij, qn, u, stg_ctx);
386     } else {
387       for (CeedInt j=0; j<3; j++) u[j] = ubar[j];
388     }
389 
390     const CeedScalar E_kinetic = .5 * rho * Dot3(u, u);
391     CeedScalar E_internal, P;
392     if (prescribe_T) {
393       // Temperature is being set weakly (theta0) and for constant cv this sets E_internal
394       E_internal = rho * cv * theta0;
395       // Find pressure using
396       P = rho * Rd * theta0; // interior rho with exterior T
397     } else {
398       E_internal = q[4][i] - E_kinetic; // uses prescribed rho and u, E from solution
399       P = E_internal * (gamma - 1.);
400     }
401 
402     const CeedScalar wdetJb  = (is_implicit ? -1. : 1.) * q_data_sur[0][i];
403     // ---- Normal vect
404     const CeedScalar norm[3] = {q_data_sur[1][i],
405                                 q_data_sur[2][i],
406                                 q_data_sur[3][i]
407                                };
408 
409     const CeedScalar E = E_internal + E_kinetic;
410 
411     // Velocity normal to the boundary
412     const CeedScalar u_normal = Dot3(norm, u);
413 
414     // The Physics
415     // Zero v so all future terms can safely sum into it
416     for (CeedInt j=0; j<5; j++) v[j][i] = 0.;
417 
418     // The Physics
419     // -- Density
420     v[0][i] -= wdetJb * rho * u_normal;
421 
422     // -- Momentum
423     for (CeedInt j=0; j<3; j++)
424       v[j+1][i] -= wdetJb *(rho * u_normal * u[j] +
425                             norm[j] * P);
426 
427     // -- Total Energy Density
428     v[4][i] -= wdetJb * u_normal * (E + P);
429 
430     jac_data_sur[0][i] = rho;
431     jac_data_sur[1][i] = u[0];
432     jac_data_sur[2][i] = u[1];
433     jac_data_sur[3][i] = u[2];
434     jac_data_sur[4][i] = E;
435     for (int j=0; j<6; j++) jac_data_sur[5+j][i] = 0.;
436   }
437   return 0;
438 }
439 
440 CEED_QFUNCTION(STGShur14_Inflow_Jacobian)(void *ctx, CeedInt Q,
441     const CeedScalar *const *in,
442     CeedScalar *const *out) {
443   // *INDENT-OFF*
444   // Inputs
445   const CeedScalar (*dq)[CEED_Q_VLA]           = (const CeedScalar(*)[CEED_Q_VLA])in[0],
446                    (*q_data_sur)[CEED_Q_VLA]   = (const CeedScalar(*)[CEED_Q_VLA])in[2],
447                    (*jac_data_sur)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[4];
448   // Outputs
449   CeedScalar (*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0];
450   // *INDENT-ON*
451   const STGShur14Context stg_ctx = (STGShur14Context)ctx;
452   const bool implicit     = stg_ctx->is_implicit;
453   const CeedScalar cv     = stg_ctx->newtonian_ctx.cv;
454   const CeedScalar cp     = stg_ctx->newtonian_ctx.cp;
455   const CeedScalar Rd     = cp - cv;
456   const CeedScalar gamma  = cp/cv;
457 
458   const CeedScalar theta0 = stg_ctx->theta0;
459   const bool prescribe_T  = stg_ctx->prescribe_T;
460 
461   CeedPragmaSIMD
462   // Quadrature Point Loop
463   for (CeedInt i=0; i<Q; i++) {
464     // Setup
465     // Setup
466     // -- Interp-to-Interp q_data
467     // For explicit mode, the surface integral is on the RHS of ODE q_dot = f(q).
468     // For implicit mode, it gets pulled to the LHS of implicit ODE/DAE g(q_dot, q).
469     // We can effect this by swapping the sign on this weight
470     const CeedScalar wdetJb  = (implicit ? -1. : 1.) * q_data_sur[0][i];
471 
472     // Calculate inflow values
473     CeedScalar velocity[3];
474     for (CeedInt j=0; j<3; j++) velocity[j] = jac_data_sur[5+j][i];
475 
476     // enabling user to choose between weak T and weak rho inflow
477     CeedScalar drho, dE, dP;
478     if (prescribe_T) {
479       // rho should be from the current solution
480       drho = dq[0][i];
481       CeedScalar dE_internal = drho * cv * theta0;
482       CeedScalar dE_kinetic = .5 * drho * Dot3(velocity, velocity);
483       dE = dE_internal + dE_kinetic;
484       dP = drho * Rd * theta0; // interior rho with exterior T
485     } else { // rho specified, E_internal from solution
486       drho = 0;
487       dE = dq[4][i];
488       dP = dE * (gamma - 1.);
489     }
490     const CeedScalar norm[3] = {q_data_sur[1][i],
491                                 q_data_sur[2][i],
492                                 q_data_sur[3][i]
493                                };
494 
495     const CeedScalar u_normal = Dot3(norm, velocity);
496 
497     v[0][i] = - wdetJb * drho * u_normal;
498     for (int j=0; j<3; j++)
499       v[j+1][i] = -wdetJb * (drho * u_normal * velocity[j] + norm[j] * dP);
500     v[4][i] = - wdetJb * u_normal * (dE + dP);
501   } // End Quadrature Point Loop
502   return 0;
503 }
504 
505 /********************************************************************
506  * @brief QFunction to calculate the strongly enforce inflow BC
507  *
508  * This QF is for the strong application of STG via libCEED (rather than
509  * through the native PETSc `DMAddBoundary` -> `bcFunc` method.
510  */
511 CEED_QFUNCTION(STGShur14_Inflow_StrongQF)(void *ctx, CeedInt Q,
512     const CeedScalar *const *in, CeedScalar *const *out) {
513 
514   //*INDENT-OFF*
515   const CeedScalar (*q_data_sur)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA]) in[0],
516                    (*coords)[CEED_Q_VLA]     = (const CeedScalar(*)[CEED_Q_VLA]) in[1],
517                    (*scale)                  = (const CeedScalar(*)) in[2],
518                    (*stg_data)[CEED_Q_VLA]   = (const CeedScalar(*)[CEED_Q_VLA]) in[3];
519 
520   CeedScalar(*bcval)[CEED_Q_VLA]            = (CeedScalar(*)[CEED_Q_VLA]) out[0];
521   //*INDENT-ON*
522 
523   const STGShur14Context stg_ctx = (STGShur14Context) ctx;
524   CeedScalar u[3], ubar[3], cij[6], eps, lt;
525   const bool mean_only    = stg_ctx->mean_only;
526   const CeedScalar dx     = stg_ctx->dx;
527   const CeedScalar mu     = stg_ctx->newtonian_ctx.mu;
528   const CeedScalar time   = stg_ctx->time;
529   const CeedScalar theta0 = stg_ctx->theta0;
530   const CeedScalar P0     = stg_ctx->P0;
531   const CeedScalar cv     = stg_ctx->newtonian_ctx.cv;
532   const CeedScalar cp     = stg_ctx->newtonian_ctx.cp;
533   const CeedScalar Rd     = cp - cv;
534   const CeedScalar rho    = P0 / (Rd * theta0);
535 
536   CeedPragmaSIMD
537   for(CeedInt i=0; i<Q; i++) {
538     const CeedScalar x[] = { coords[0][i], coords[1][i], coords[2][i] };
539     const CeedScalar dXdx[2][3] = {
540       {q_data_sur[4][i], q_data_sur[5][i], q_data_sur[6][i]},
541       {q_data_sur[7][i], q_data_sur[8][i], q_data_sur[9][i]}
542     };
543 
544     CeedScalar h[3];
545     h[0] = dx;
546     for (CeedInt j=1; j<3; j++)
547       h[j] = 2/sqrt(Square(dXdx[0][j]) + Square(dXdx[1][j]));
548 
549     InterpolateProfile(coords[1][i], ubar, cij, &eps, &lt, stg_ctx);
550     if (!mean_only) {
551       if (1) {
552         STGShur14_Calc_PrecompEktot(x, time, ubar, cij, stg_data[0][i],
553                                     h, x[1], eps, lt, mu/rho, u, stg_ctx);
554       } else { // Original way
555         CeedScalar qn[STG_NMODES_MAX];
556         CalcSpectrum(coords[1][i], eps, lt, h, mu/rho, qn, stg_ctx);
557         STGShur14_Calc(x, time, ubar, cij, qn, u, stg_ctx);
558       }
559     } else {
560       for (CeedInt j=0; j<3; j++) u[j] = ubar[j];
561     }
562 
563     bcval[0][i] = scale[i] * rho;
564     bcval[1][i] = scale[i] * rho * u[0];
565     bcval[2][i] = scale[i] * rho * u[1];
566     bcval[3][i] = scale[i] * rho * u[2];
567     bcval[4][i] = 0.;
568   }
569   return 0;
570 }
571 
572 #endif // stg_shur14_h
573