// Copyright (c) 2017-2026, Lawrence Livermore National Security, LLC and other CEED contributors. // All Rights Reserved. See the top-level LICENSE and NOTICE files for details. // // SPDX-License-Identifier: BSD-2-Clause // // This file is part of CEED: http://github.com/ceed /// @file /// Advection initial condition and operator for Navier-Stokes example using PETSc #include #ifndef CEED_RUNNING_JIT_PASS #include #include #endif #include "advection_types.h" #include "newtonian_state.h" #include "newtonian_types.h" #include "stabilization_types.h" #include "utils.h" // ***************************************************************************** // This QFunction sets the initial conditions and the boundary conditions // for two test cases: ROTATION and TRANSLATION // // -- ROTATION (default) // Initial Conditions: // Mass Density: // Constant mass density of 1.0 // Momentum Density: // Rotational field in x,y // Energy Density: // Maximum of 1. x0 decreasing linearly to 0. as radial distance // increases to (1.-r/rc), then 0. everywhere else // // Boundary Conditions: // Mass Density: // 0.0 flux // Momentum Density: // 0.0 // Energy Density: // 0.0 flux // // -- TRANSLATION // Initial Conditions: // Mass Density: // Constant mass density of 1.0 // Momentum Density: // Constant rectilinear field in x,y // Energy Density: // Maximum of 1. x0 decreasing linearly to 0. as radial distance // increases to (1.-r/rc), then 0. everywhere else // // Boundary Conditions: // Mass Density: // 0.0 flux // Momentum Density: // 0.0 // Energy Density: // Inflow BCs: // E = E_wind // Outflow BCs: // E = E(boundary) // Both In/Outflow BCs for E are applied weakly in the // QFunction "Advection2d_Sur" // // ***************************************************************************** // ***************************************************************************** // This helper function provides the exact, time-dependent solution and IC formulation for 2D advection // ***************************************************************************** CEED_QFUNCTION_HELPER CeedInt Exact_AdvectionGeneric(CeedInt dim, CeedScalar time, const CeedScalar X[], CeedInt Nf, CeedScalar q[], void *ctx) { const SetupContextAdv context = (SetupContextAdv)ctx; const CeedScalar rc = context->rc; const CeedScalar lx = context->lx; const CeedScalar ly = context->ly; const CeedScalar lz = dim == 2 ? 0. : context->lz; const CeedScalar *wind = context->wind; const CeedScalar center[3] = {0.5 * lx, 0.5 * ly, 0.5 * lz}; const CeedScalar theta = dim == 2 ? M_PI / 3 : M_PI; const CeedScalar x0[3] = {center[0] + .25 * lx * cos(theta + time), center[1] + .25 * ly * sin(theta + time), 0.5 * lz}; const CeedScalar x = X[0], y = X[1], z = dim == 2 ? 0. : X[2]; CeedScalar r = 0.; switch (context->initial_condition_type) { case ADVECTIONIC_BUBBLE_SPHERE: case ADVECTIONIC_BUBBLE_CYLINDER: r = sqrt(Square(x - x0[0]) + Square(y - x0[1]) + Square(z - x0[2])); break; case ADVECTIONIC_COSINE_HILL: r = sqrt(Square(x - center[0]) + Square(y - center[1])); break; case ADVECTIONIC_SKEW: break; } switch (context->wind_type) { case WIND_ROTATION: q[0] = 1.; q[1] = -(y - center[1]); q[2] = (x - center[0]); q[3] = 0; break; case WIND_TRANSLATION: q[0] = 1.; q[1] = wind[0]; q[2] = wind[1]; q[3] = dim == 2 ? 0. : wind[2]; break; default: return 1; } switch (context->initial_condition_type) { case ADVECTIONIC_BUBBLE_SPHERE: case ADVECTIONIC_BUBBLE_CYLINDER: switch (context->bubble_continuity_type) { // original continuous, smooth shape case BUBBLE_CONTINUITY_SMOOTH: q[4] = r <= rc ? (1. - r / rc) : 0.; break; // discontinuous, sharp back half shape case BUBBLE_CONTINUITY_BACK_SHARP: q[4] = ((r <= rc) && (y < center[1])) ? (1. - r / rc) : 0.; break; // attempt to define a finite thickness that will get resolved under grid refinement case BUBBLE_CONTINUITY_THICK: q[4] = ((r <= rc) && (y < center[1])) ? (1. - r / rc) * fmin(1.0, (center[1] - y) / 1.25) : 0.; break; case BUBBLE_CONTINUITY_COSINE: q[4] = r <= rc ? .5 + .5 * cos(r * M_PI / rc) : 0; break; } break; case ADVECTIONIC_COSINE_HILL: { CeedScalar half_width = context->lx / 2; q[4] = r > half_width ? 0. : cos(2 * M_PI * r / half_width + M_PI) + 1.; } break; case ADVECTIONIC_SKEW: { CeedScalar skewed_barrier[3] = {wind[0], wind[1], 0}; CeedScalar inflow_to_point[3] = {x - context->lx / 2, y, 0}; CeedScalar cross_product[3] = {0}; const CeedScalar boundary_threshold = 20 * CEED_EPSILON; Cross3(skewed_barrier, inflow_to_point, cross_product); q[4] = cross_product[2] > boundary_threshold ? 0 : 1; if ((x < boundary_threshold && wind[0] < boundary_threshold) || // outflow at -x boundary (y < boundary_threshold && wind[1] < boundary_threshold) || // outflow at -y boundary (x > context->lx - boundary_threshold && wind[0] > boundary_threshold) || // outflow at +x boundary (y > context->ly - boundary_threshold && wind[1] > boundary_threshold) // outflow at +y boundary ) { q[4] = 0; } } break; } return 0; } // ***************************************************************************** // This QFunction sets the initial conditions for 3D advection // ***************************************************************************** CEED_QFUNCTION(ICsAdvection)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { const CeedScalar(*X)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; CeedScalar(*q0)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { const CeedScalar x[] = {X[0][i], X[1][i], X[2][i]}; CeedScalar q[5] = {0.}; Exact_AdvectionGeneric(3, 0., x, 5, q, ctx); for (CeedInt j = 0; j < 5; j++) q0[j][i] = q[j]; } return 0; } // ***************************************************************************** // This QFunction sets the initial conditions for 2D advection // ***************************************************************************** CEED_QFUNCTION(ICsAdvection2d)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { const CeedScalar(*X)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; CeedScalar(*q0)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; const SetupContextAdv context = (SetupContextAdv)ctx; CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { const CeedScalar x[] = {X[0][i], X[1][i]}; CeedScalar q[5] = {0.}; Exact_AdvectionGeneric(2, context->time, x, 5, q, ctx); for (CeedInt j = 0; j < 5; j++) q0[j][i] = q[j]; } return 0; } CEED_QFUNCTION_HELPER void QdataUnpack_ND(CeedInt N, CeedInt Q, CeedInt i, const CeedScalar *q_data, CeedScalar *wdetJ, CeedScalar *dXdx) { // Cannot directly use QdataUnpack* helper functions due to SYCL online compiler incompatabilities switch (N) { case 2: StoredValuesUnpack(Q, i, 0, 1, q_data, wdetJ); StoredValuesUnpack(Q, i, 1, 4, q_data, dXdx); break; case 3: StoredValuesUnpack(Q, i, 0, 1, q_data, wdetJ); StoredValuesUnpack(Q, i, 1, 9, q_data, dXdx); break; } } CEED_QFUNCTION_HELPER int QdataBoundaryUnpack_ND(CeedInt N, CeedInt Q, CeedInt i, const CeedScalar *q_data, CeedScalar *wdetJ, CeedScalar *dXdx, CeedScalar *normal) { // Cannot directly use QdataBoundaryUnpack* helper functions due to SYCL online compiler incompatabilities switch (N) { case 2: if (wdetJ) StoredValuesUnpack(Q, i, 0, 1, q_data, wdetJ); if (normal) StoredValuesUnpack(Q, i, 1, 2, q_data, normal); break; case 3: if (wdetJ) StoredValuesUnpack(Q, i, 0, 1, q_data, wdetJ); if (normal) StoredValuesUnpack(Q, i, 1, 3, q_data, normal); if (dXdx) StoredValuesUnpack(Q, i, 4, 6, q_data, (CeedScalar *)dXdx); break; } return CEED_ERROR_SUCCESS; } CEED_QFUNCTION_HELPER void StatePhysicalGradientFromReference_ND(CeedInt N, CeedInt Q, CeedInt i, NewtonianIdealGasContext gas, State s, StateVariable state_var, const CeedScalar *grad_q, const CeedScalar *dXdx, State *grad_s) { switch (N) { case 2: { for (CeedInt k = 0; k < 2; k++) { CeedScalar dqi[5]; for (CeedInt j = 0; j < 5; j++) { dqi[j] = grad_q[(Q * 5) * 0 + Q * j + i] * dXdx[0 * N + k] + grad_q[(Q * 5) * 1 + Q * j + i] * dXdx[1 * N + k]; } grad_s[k] = StateFromQ_fwd(gas, s, dqi, state_var); } CeedScalar U[5] = {0.}; grad_s[2] = StateFromU(gas, U); } break; case 3: // Cannot directly use StatePhysicalGradientFromReference helper functions due to SYCL online compiler incompatabilities for (CeedInt k = 0; k < 3; k++) { CeedScalar dqi[5]; for (CeedInt j = 0; j < 5; j++) { dqi[j] = grad_q[(Q * 5) * 0 + Q * j + i] * dXdx[0 * N + k] + grad_q[(Q * 5) * 1 + Q * j + i] * dXdx[1 * N + k] + grad_q[(Q * 5) * 2 + Q * j + i] * dXdx[2 * N + k]; } grad_s[k] = StateFromQ_fwd(gas, s, dqi, state_var); } break; } } // @brief Calculate the stabilization constant \tau CEED_QFUNCTION_HELPER CeedScalar Tau(AdvectionContext context, const State s, const CeedScalar *dXdx, CeedInt dim) { switch (context->stabilization_tau) { case STAB_TAU_CTAU: { CeedScalar uX[3] = {0.}; MatVecNM(dXdx, s.Y.velocity, dim, dim, CEED_NOTRANSPOSE, uX); return context->CtauS / sqrt(DotN(uX, uX, dim)); } break; case STAB_TAU_ADVDIFF_SHAKIB: { CeedScalar gijd_mat[9] = {0.}, gij_uj[3] = {0.}; MatMatN(dXdx, dXdx, dim, CEED_TRANSPOSE, CEED_NOTRANSPOSE, gijd_mat); MatVecNM(gijd_mat, s.Y.velocity, dim, dim, CEED_NOTRANSPOSE, gij_uj); return 1 / sqrt(Square(2 * context->Ctau_t / context->dt) + DotN(s.Y.velocity, gij_uj, dim) * context->Ctau_a); } break; default: return 0.; } } // ***************************************************************************** // This QFunction implements Advection for implicit time stepping method // ***************************************************************************** CEED_QFUNCTION_HELPER void IFunction_AdvectionGeneric(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out, CeedInt dim) { const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; const CeedScalar(*grad_q) = in[1]; const CeedScalar(*q_dot)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[2]; const CeedScalar(*q_data) = in[3]; CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; CeedScalar(*grad_v)[5][CEED_Q_VLA] = (CeedScalar(*)[5][CEED_Q_VLA])out[1]; CeedScalar *jac_data = out[2]; AdvectionContext context = (AdvectionContext)ctx; const CeedScalar zeros[14] = {0.}; NewtonianIdealGasContext gas; struct NewtonianIdealGasContext_ gas_struct = {0}; gas = &gas_struct; CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { const CeedScalar qi[5] = {q[0][i], q[1][i], q[2][i], q[3][i], q[4][i]}; const State s = StateFromU(gas, qi); CeedScalar wdetJ, dXdx[9]; QdataUnpack_ND(dim, Q, i, q_data, &wdetJ, dXdx); State grad_s[3]; StatePhysicalGradientFromReference_ND(dim, Q, i, gas, s, STATEVAR_CONSERVATIVE, grad_q, dXdx, grad_s); const CeedScalar Grad_E[3] = {grad_s[0].U.E_total, grad_s[1].U.E_total, grad_s[2].U.E_total}; for (CeedInt f = 0; f < 4; f++) { for (CeedInt j = 0; j < dim; j++) grad_v[j][f][i] = 0; // No Change in density or momentum v[f][i] = wdetJ * q_dot[f][i]; // K Mass/transient term } CeedScalar div_u = 0; for (CeedInt j = 0; j < dim; j++) { for (CeedInt k = 0; k < dim; k++) { div_u += grad_s[k].Y.velocity[j]; } } CeedScalar strong_conv = s.U.E_total * div_u + DotN(s.Y.velocity, Grad_E, dim); CeedScalar strong_res = q_dot[4][i] + strong_conv; v[4][i] = wdetJ * q_dot[4][i]; // transient part (ALWAYS) CeedScalar uX[3] = {0.}; MatVecNM(dXdx, s.Y.velocity, dim, dim, CEED_NOTRANSPOSE, uX); if (context->strong_form) { // Strong Galerkin convection term: v div(E u) v[4][i] += wdetJ * strong_conv; } else { // Weak Galerkin convection term: -dv \cdot (E u) for (CeedInt j = 0; j < dim; j++) grad_v[j][4][i] = -wdetJ * s.U.E_total * uX[j]; } { // Diffusion CeedScalar Fe[3], Fe_dXdx[3] = {0.}; for (CeedInt i = 0; i < dim; i++) Fe[i] = -context->diffusion_coeff * grad_s[i].U.E_total; MatVecNM(dXdx, Fe, dim, dim, CEED_NOTRANSPOSE, Fe_dXdx); for (CeedInt k = 0; k < dim; k++) grad_v[k][4][i] -= wdetJ * Fe_dXdx[k]; } const CeedScalar TauS = Tau(context, s, dXdx, dim); for (CeedInt j = 0; j < dim; j++) switch (context->stabilization) { case STAB_NONE: break; case STAB_SU: grad_v[j][4][i] += wdetJ * TauS * strong_conv * uX[j]; break; case STAB_SUPG: grad_v[j][4][i] += wdetJ * TauS * strong_res * uX[j]; break; } StoredValuesPack(Q, i, 0, 14, zeros, jac_data); } } CEED_QFUNCTION(IFunction_Advection)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { IFunction_AdvectionGeneric(ctx, Q, in, out, 3); return 0; } CEED_QFUNCTION(IFunction_Advection2d)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { IFunction_AdvectionGeneric(ctx, Q, in, out, 2); return 0; } CEED_QFUNCTION_HELPER void MassFunction_AdvectionGeneric(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out, CeedInt dim) { const CeedScalar(*q_dot)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[1]; const CeedScalar(*q_data) = in[2]; CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; CeedScalar(*grad_v)[5][CEED_Q_VLA] = (CeedScalar(*)[5][CEED_Q_VLA])out[1]; AdvectionContext context = (AdvectionContext)ctx; struct NewtonianIdealGasContext_ gas_struct = {0}; NewtonianIdealGasContext gas = &gas_struct; CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { const CeedScalar qi[5] = {q[0][i], q[1][i], q[2][i], q[3][i], q[4][i]}; const State s = StateFromU(gas, qi); CeedScalar wdetJ, dXdx[9]; QdataUnpack_ND(dim, Q, i, q_data, &wdetJ, dXdx); for (CeedInt f = 0; f < 4; f++) { for (CeedInt j = 0; j < dim; j++) grad_v[j][f][i] = 0; // No Change in density or momentum v[f][i] = wdetJ * q_dot[f][i]; // K Mass/transient term } // Unstabilized mass term v[4][i] = wdetJ * q_dot[4][i]; // Stabilized mass term CeedScalar uX[3] = {0.}; MatVecNM(dXdx, s.Y.velocity, dim, dim, CEED_NOTRANSPOSE, uX); const CeedScalar TauS = Tau(context, s, dXdx, dim); for (CeedInt j = 0; j < dim; j++) switch (context->stabilization) { case STAB_NONE: case STAB_SU: grad_v[j][4][i] = 0; break; // These should be run with the unstabilized mass matrix anyways case STAB_SUPG: grad_v[j][4][i] = wdetJ * TauS * q_dot[4][i] * uX[j]; break; } } } CEED_QFUNCTION(MassFunction_Advection)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { MassFunction_AdvectionGeneric(ctx, Q, in, out, 3); return 0; } CEED_QFUNCTION(MassFunction_Advection2D)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { MassFunction_AdvectionGeneric(ctx, Q, in, out, 2); return 0; } // ***************************************************************************** // This QFunction implements Advection for explicit time stepping method // ***************************************************************************** CEED_QFUNCTION_HELPER void RHSFunction_AdvectionGeneric(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out, CeedInt dim) { const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; const CeedScalar(*grad_q) = in[1]; const CeedScalar(*q_data) = in[2]; CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; CeedScalar(*grad_v)[5][CEED_Q_VLA] = (CeedScalar(*)[5][CEED_Q_VLA])out[1]; AdvectionContext context = (AdvectionContext)ctx; struct NewtonianIdealGasContext_ gas_struct = {0}; NewtonianIdealGasContext gas = &gas_struct; CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { const CeedScalar qi[5] = {q[0][i], q[1][i], q[2][i], q[3][i], q[4][i]}; const State s = StateFromU(gas, qi); CeedScalar wdetJ, dXdx[9]; QdataUnpack_ND(dim, Q, i, q_data, &wdetJ, dXdx); State grad_s[3]; StatePhysicalGradientFromReference_ND(dim, Q, i, gas, s, STATEVAR_CONSERVATIVE, grad_q, dXdx, grad_s); const CeedScalar Grad_E[3] = {grad_s[0].U.E_total, grad_s[1].U.E_total, grad_s[2].U.E_total}; for (CeedInt f = 0; f < 4; f++) { for (CeedInt j = 0; j < dim; j++) grad_v[j][f][i] = 0; // No Change in density or momentum v[f][i] = 0.; } CeedScalar div_u = 0; for (CeedInt j = 0; j < dim; j++) { for (CeedInt k = 0; k < dim; k++) { div_u += grad_s[k].Y.velocity[j]; } } CeedScalar strong_conv = s.U.E_total * div_u + DotN(s.Y.velocity, Grad_E, dim); CeedScalar uX[3] = {0.}; MatVecNM(dXdx, s.Y.velocity, dim, dim, CEED_NOTRANSPOSE, uX); if (context->strong_form) { // Strong Galerkin convection term: v div(E u) v[4][i] = -wdetJ * strong_conv; for (CeedInt j = 0; j < dim; j++) grad_v[j][4][i] = 0; } else { // Weak Galerkin convection term: -dv \cdot (E u) for (CeedInt j = 0; j < dim; j++) grad_v[j][4][i] = wdetJ * s.U.E_total * uX[j]; v[4][i] = 0.; } { // Diffusion CeedScalar Fe[3], Fe_dXdx[3] = {0.}; for (CeedInt i = 0; i < dim; i++) Fe[i] = -context->diffusion_coeff * grad_s[i].U.E_total; MatVecNM(dXdx, Fe, dim, dim, CEED_NOTRANSPOSE, Fe_dXdx); for (CeedInt k = 0; k < dim; k++) grad_v[k][4][i] += wdetJ * Fe_dXdx[k]; } const CeedScalar TauS = Tau(context, s, dXdx, dim); for (CeedInt j = 0; j < dim; j++) switch (context->stabilization) { case STAB_NONE: break; case STAB_SU: case STAB_SUPG: grad_v[j][4][i] -= wdetJ * TauS * strong_conv * uX[j]; break; } } } CEED_QFUNCTION(RHS_Advection)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { RHSFunction_AdvectionGeneric(ctx, Q, in, out, 3); return 0; } CEED_QFUNCTION(RHS_Advection2d)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { RHSFunction_AdvectionGeneric(ctx, Q, in, out, 2); return 0; } // ***************************************************************************** // This QFunction implements consistent outflow and inflow BCs // for advection // // Inflow and outflow faces are determined based on sign(dot(wind, normal)): // sign(dot(wind, normal)) > 0 : outflow BCs // sign(dot(wind, normal)) < 0 : inflow BCs // // Outflow BCs: // The validity of the weak form of the governing equations is extended to the outflow and the current values of E are applied. // // Inflow BCs: // A prescribed Total Energy (E_wind) is applied weakly. // ***************************************************************************** CEED_QFUNCTION(Advection_InOutFlowGeneric)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out, CeedInt dim) { const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; const CeedScalar(*q_data_sur) = in[2]; CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; AdvectionContext context = (AdvectionContext)ctx; const CeedScalar E_wind = context->E_wind; const CeedScalar strong_form = context->strong_form; const bool is_implicit = context->implicit; CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { const CeedScalar rho = q[0][i]; const CeedScalar u[3] = {q[1][i] / rho, q[2][i] / rho, q[3][i] / rho}; const CeedScalar E = q[4][i]; CeedScalar wdetJb, norm[3]; QdataBoundaryUnpack_ND(dim, Q, i, q_data_sur, &wdetJb, NULL, norm); wdetJb *= is_implicit ? -1. : 1.; const CeedScalar u_normal = DotN(norm, u, dim); // No Change in density or momentum for (CeedInt j = 0; j < 4; j++) { v[j][i] = 0; } // Implementing in/outflow BCs if (u_normal > 0) { // outflow v[4][i] = -(1 - strong_form) * wdetJb * E * u_normal; } else { // inflow v[4][i] = -(1 - strong_form) * wdetJb * E_wind * u_normal; } } return 0; } CEED_QFUNCTION(Advection_InOutFlow)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { Advection_InOutFlowGeneric(ctx, Q, in, out, 3); return 0; } CEED_QFUNCTION(Advection2d_InOutFlow)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { Advection_InOutFlowGeneric(ctx, Q, in, out, 2); return 0; }