xref: /honee/qfunctions/stabilization.h (revision 475f0cac5d40259768f4556cf888e8f2448554cb)

// SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors.
// SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause

/// @file
/// Helper functions for computing stabilization terms of a newtonian simulation
#include <ceed/types.h>

#include "newtonian_state.h"

// *****************************************************************************
// Helper function for computing the variation in primitive variables, given Tau_d
// *****************************************************************************
CEED_QFUNCTION_HELPER void dYFromTau(const CeedScalar Y[5], const CeedScalar Tau_d[3], CeedScalar dY[5]) {
  dY[0] = Tau_d[0] * Y[0];
  dY[1] = Tau_d[1] * Y[1];
  dY[2] = Tau_d[1] * Y[2];
  dY[3] = Tau_d[1] * Y[3];
  dY[4] = Tau_d[2] * Y[4];
}

// *****************************************************************************
// Helper functions for computing the stabilization terms
// *****************************************************************************
CEED_QFUNCTION_HELPER void StabilizationMatrix(const NewtonianIGProperties gas, const State s, const CeedScalar Tau_d[3],
                                               const CeedScalar strong_residual[5], CeedScalar stab[5][3]) {
  CeedScalar        dY[5];
  StateConservative dF[3];
  // Zero stab so all future terms can safely sum into it
  SetValueN((CeedScalar *)stab, 0, 15);
  dYFromTau(strong_residual, Tau_d, dY);
  State ds = StateFromY_fwd(gas, s, dY);
  FluxInviscid_fwd(gas, s, ds, dF);
  for (CeedInt i = 0; i < 3; i++) {
    CeedScalar dF_i[5];
    UnpackState_U(dF[i], dF_i);
    for (CeedInt j = 0; j < 5; j++) stab[j][i] += dF_i[j];
  }
}

CEED_QFUNCTION_HELPER void Stabilization(StabilizationType stab_type, const NewtonianIGProperties gas, const State s, const CeedScalar Tau_d[3],
                                         const State ds[3], const CeedScalar U_dot[5], const CeedScalar body_force[5], const CeedScalar divFdiff[5],
                                         CeedScalar stab[5][3]) {
  // -- Stabilization method: none (Galerkin), SU, or SUPG
  CeedScalar strong_residual[5] = {0};
  switch (stab_type) {
    case STAB_NONE:
      break;
    case STAB_SU:
      FluxInviscidStrong(gas, s, ds, strong_residual);
      break;
    case STAB_SUPG:
      FluxInviscidStrong(gas, s, ds, strong_residual);
      for (CeedInt j = 0; j < 5; j++) strong_residual[j] += U_dot[j] - body_force[j] + divFdiff[j];
      break;
  }
  StabilizationMatrix(gas, s, Tau_d, strong_residual, stab);
}

// *****************************************************************************
// Helper function for computing Tau elements (stabilization constant)
//   Model from:
//     PHASTA
//
//   Tau[i] = itau=0 which is diagonal-Shakib (3 values still but not spatial)
// *****************************************************************************
CEED_QFUNCTION_HELPER void Tau_diagPrim(TauDiagCoefficients tau_coeffs, NewtonianIGProperties gas, State s, const CeedScalar dXdx[3][3],
                                        const CeedScalar dt, CeedScalar Tau_d[3]) {
  // Context
  const CeedScalar Ctau_t = tau_coeffs.Ctau_t;
  const CeedScalar Ctau_v = tau_coeffs.Ctau_v;
  const CeedScalar Ctau_C = tau_coeffs.Ctau_C;
  const CeedScalar Ctau_M = tau_coeffs.Ctau_M;
  const CeedScalar Ctau_E = tau_coeffs.Ctau_E;
  const CeedScalar cv     = gas.cv;
  const CeedScalar mu     = gas.mu;
  const CeedScalar rho    = s.U.density;

  CeedScalar tau;
  CeedScalar dts;
  CeedScalar fact;

  CeedScalar gijd_mat[3][3] = {{0.}}, velocity_term;
  MatMat3(dXdx, dXdx, CEED_TRANSPOSE, CEED_NOTRANSPOSE, gijd_mat);

  dts = Ctau_t / dt;

  {  // u_i g_ij u_j
    CeedScalar gij_uj[3] = {0.};
    MatVec3(gijd_mat, s.Y.velocity, CEED_NOTRANSPOSE, gij_uj);
    velocity_term = Dot3(s.Y.velocity, gij_uj);
  }

  tau = Square(rho) * (4. * Square(dts) + velocity_term) + Ctau_v * Square(mu) * DotN((CeedScalar *)gijd_mat, (CeedScalar *)gijd_mat, 9);

  fact = sqrt(tau);

  Tau_d[0] = Ctau_C * fact / (rho * (gijd_mat[0][0] + gijd_mat[1][1] + gijd_mat[2][2])) * 0.125;
  Tau_d[1] = Ctau_M / fact;
  Tau_d[2] = Ctau_E / (fact * cv);

  // consider putting back the way I initially had it
  // Ctau_E * Tau_d[1] /cv to avoid a division if the compiler is smart enough to see that cv IS a constant that it could invert once for all elements
  // but in that case energy tau is scaled by the product of Ctau_E * Ctau_M
  // OR we could absorb cv into Ctau_E but this puts more burden on user to know how to change constants with a change of fluid or units.  Same for
  // Ctau_v * mu * mu IF AND ONLY IF we don't add viscosity law =f(T)
}