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 /// Structs and helper functions regarding the state of a newtonian simulation 10 11 #ifndef newtonian_state_h 12 #define newtonian_state_h 13 14 #include <ceed.h> 15 #include <math.h> 16 17 #include "newtonian_types.h" 18 #include "utils.h" 19 20 typedef struct { 21 CeedScalar density; 22 CeedScalar momentum[3]; 23 CeedScalar E_total; 24 } StateConservative; 25 26 typedef struct { 27 StateConservative U; 28 StatePrimitive Y; 29 } State; 30 31 CEED_QFUNCTION_HELPER void UnpackState_U(StateConservative s, CeedScalar U[5]) { 32 U[0] = s.density; 33 for (int i = 0; i < 3; i++) U[i + 1] = s.momentum[i]; 34 U[4] = s.E_total; 35 } 36 37 CEED_QFUNCTION_HELPER void UnpackState_Y(StatePrimitive s, CeedScalar Y[5]) { 38 Y[0] = s.pressure; 39 for (int i = 0; i < 3; i++) Y[i + 1] = s.velocity[i]; 40 Y[4] = s.temperature; 41 } 42 43 CEED_QFUNCTION_HELPER CeedScalar HeatCapacityRatio(NewtonianIdealGasContext gas) { return gas->cp / gas->cv; } 44 45 CEED_QFUNCTION_HELPER CeedScalar GasConstant(NewtonianIdealGasContext gas) { return gas->cp - gas->cv; } 46 47 CEED_QFUNCTION_HELPER CeedScalar Prandtl(NewtonianIdealGasContext gas) { return gas->cp * gas->mu / gas->k; } 48 49 CEED_QFUNCTION_HELPER CeedScalar SoundSpeed(NewtonianIdealGasContext gas, CeedScalar T) { return sqrt(gas->cp * (HeatCapacityRatio(gas) - 1.) * T); } 50 51 CEED_QFUNCTION_HELPER CeedScalar Mach(NewtonianIdealGasContext gas, CeedScalar T, CeedScalar u) { return u / SoundSpeed(gas, T); } 52 53 CEED_QFUNCTION_HELPER CeedScalar TotalSpecificEnthalpy(NewtonianIdealGasContext gas, const State s) { 54 // Ignoring potential energy 55 CeedScalar e_internal = gas->cv * s.Y.temperature; 56 CeedScalar e_kinetic = 0.5 * Dot3(s.Y.velocity, s.Y.velocity); 57 return e_internal + e_kinetic + s.Y.pressure / s.U.density; 58 } 59 60 CEED_QFUNCTION_HELPER CeedScalar TotalSpecificEnthalpy_fwd(NewtonianIdealGasContext gas, const State s, const State ds) { 61 // Ignoring potential energy 62 CeedScalar de_kinetic = Dot3(ds.Y.velocity, s.Y.velocity); 63 CeedScalar de_internal = gas->cv * ds.Y.temperature; 64 return de_internal + de_kinetic + ds.Y.pressure / s.U.density - s.Y.pressure / Square(s.U.density) * ds.U.density; 65 } 66 67 CEED_QFUNCTION_HELPER StatePrimitive StatePrimitiveFromConservative(NewtonianIdealGasContext gas, StateConservative U, const CeedScalar x[3]) { 68 StatePrimitive Y; 69 for (CeedInt i = 0; i < 3; i++) Y.velocity[i] = U.momentum[i] / U.density; 70 CeedScalar e_kinetic = .5 * Dot3(Y.velocity, Y.velocity); 71 CeedScalar e_potential = -Dot3(gas->g, x); 72 CeedScalar e_total = U.E_total / U.density; 73 CeedScalar e_internal = e_total - e_kinetic - e_potential; 74 Y.temperature = e_internal / gas->cv; 75 Y.pressure = (HeatCapacityRatio(gas) - 1) * U.density * e_internal; 76 return Y; 77 } 78 79 CEED_QFUNCTION_HELPER StatePrimitive StatePrimitiveFromConservative_fwd(NewtonianIdealGasContext gas, State s, StateConservative dU, 80 const CeedScalar x[3], const CeedScalar dx[3]) { 81 StatePrimitive dY; 82 for (CeedInt i = 0; i < 3; i++) { 83 dY.velocity[i] = (dU.momentum[i] - s.Y.velocity[i] * dU.density) / s.U.density; 84 } 85 CeedScalar e_kinetic = .5 * Dot3(s.Y.velocity, s.Y.velocity); 86 CeedScalar de_kinetic = Dot3(dY.velocity, s.Y.velocity); 87 CeedScalar e_potential = -Dot3(gas->g, x); 88 CeedScalar de_potential = -Dot3(gas->g, dx); 89 CeedScalar e_total = s.U.E_total / s.U.density; 90 CeedScalar de_total = (dU.E_total - e_total * dU.density) / s.U.density; 91 CeedScalar e_internal = e_total - e_kinetic - e_potential; 92 CeedScalar de_internal = de_total - de_kinetic - de_potential; 93 dY.temperature = de_internal / gas->cv; 94 dY.pressure = (HeatCapacityRatio(gas) - 1) * (dU.density * e_internal + s.U.density * de_internal); 95 return dY; 96 } 97 98 CEED_QFUNCTION_HELPER StateConservative StateConservativeFromPrimitive(NewtonianIdealGasContext gas, StatePrimitive Y, const CeedScalar x[3]) { 99 StateConservative U; 100 U.density = Y.pressure / (GasConstant(gas) * Y.temperature); 101 for (int i = 0; i < 3; i++) U.momentum[i] = U.density * Y.velocity[i]; 102 CeedScalar e_internal = gas->cv * Y.temperature; 103 CeedScalar e_kinetic = .5 * Dot3(Y.velocity, Y.velocity); 104 CeedScalar e_potential = -Dot3(gas->g, x); 105 CeedScalar e_total = e_internal + e_kinetic + e_potential; 106 U.E_total = U.density * e_total; 107 return U; 108 } 109 110 CEED_QFUNCTION_HELPER StateConservative StateConservativeFromPrimitive_fwd(NewtonianIdealGasContext gas, State s, StatePrimitive dY, 111 const CeedScalar x[3], const CeedScalar dx[3]) { 112 StateConservative dU; 113 dU.density = (dY.pressure * s.Y.temperature - s.Y.pressure * dY.temperature) / (GasConstant(gas) * s.Y.temperature * s.Y.temperature); 114 for (int i = 0; i < 3; i++) { 115 dU.momentum[i] = dU.density * s.Y.velocity[i] + s.U.density * dY.velocity[i]; 116 } 117 CeedScalar e_kinetic = .5 * Dot3(s.Y.velocity, s.Y.velocity); 118 CeedScalar de_kinetic = Dot3(dY.velocity, s.Y.velocity); 119 CeedScalar e_potential = -Dot3(gas->g, x); 120 CeedScalar de_potential = -Dot3(gas->g, dx); 121 CeedScalar e_internal = gas->cv * s.Y.temperature; 122 CeedScalar de_internal = gas->cv * dY.temperature; 123 CeedScalar e_total = e_internal + e_kinetic + e_potential; 124 CeedScalar de_total = de_internal + de_kinetic + de_potential; 125 dU.E_total = dU.density * e_total + s.U.density * de_total; 126 return dU; 127 } 128 129 CEED_QFUNCTION_HELPER State StateFromPrimitive(NewtonianIdealGasContext gas, StatePrimitive Y, const CeedScalar x[3]) { 130 StateConservative U = StateConservativeFromPrimitive(gas, Y, x); 131 State s; 132 s.U = U; 133 s.Y = Y; 134 return s; 135 } 136 137 // linear combination of n states 138 CEED_QFUNCTION_HELPER StateConservative StateConservativeMult(CeedInt n, const CeedScalar a[], const StateConservative X[]) { 139 StateConservative R = {0}; 140 for (CeedInt i = 0; i < n; i++) { 141 R.density += a[i] * X[i].density; 142 for (int j = 0; j < 3; j++) R.momentum[j] += a[i] * X[i].momentum[j]; 143 R.E_total += a[i] * X[i].E_total; 144 } 145 return R; 146 } 147 148 CEED_QFUNCTION_HELPER StateConservative StateConservativeAXPBYPCZ(CeedScalar a, StateConservative X, CeedScalar b, StateConservative Y, CeedScalar c, 149 StateConservative Z) { 150 StateConservative R; 151 R.density = a * X.density + b * Y.density + c * Z.density; 152 for (int i = 0; i < 3; i++) R.momentum[i] = a * X.momentum[i] + b * Y.momentum[i] + c * Z.momentum[i]; 153 R.E_total = a * X.E_total + b * Y.E_total + c * Z.E_total; 154 return R; 155 } 156 157 // Function pointer types for generic state array -> State struct functions 158 typedef State (*StateFromQi_t)(NewtonianIdealGasContext gas, const CeedScalar qi[5], const CeedScalar x[3]); 159 // Function pointer types for State struct -> generic state array 160 typedef void (*StateToQi_t)(NewtonianIdealGasContext gas, const State input, CeedScalar qi[5]); 161 162 CEED_QFUNCTION_HELPER void StateToU(NewtonianIdealGasContext gas, const State input, CeedScalar U[5]) { UnpackState_U(input.U, U); } 163 164 CEED_QFUNCTION_HELPER void StateToY(NewtonianIdealGasContext gas, const State input, CeedScalar Y[5]) { UnpackState_Y(input.Y, Y); } 165 typedef State (*StateFromQi_fwd_t)(NewtonianIdealGasContext gas, State s, const CeedScalar dqi[5], const CeedScalar x[3], const CeedScalar dx[3]); 166 167 CEED_QFUNCTION_HELPER State StateFromU(NewtonianIdealGasContext gas, const CeedScalar U[5], const CeedScalar x[3]) { 168 State s; 169 s.U.density = U[0]; 170 s.U.momentum[0] = U[1]; 171 s.U.momentum[1] = U[2]; 172 s.U.momentum[2] = U[3]; 173 s.U.E_total = U[4]; 174 s.Y = StatePrimitiveFromConservative(gas, s.U, x); 175 return s; 176 } 177 178 CEED_QFUNCTION_HELPER State StateFromU_fwd(NewtonianIdealGasContext gas, State s, const CeedScalar dU[5], const CeedScalar x[3], 179 const CeedScalar dx[3]) { 180 State ds; 181 ds.U.density = dU[0]; 182 ds.U.momentum[0] = dU[1]; 183 ds.U.momentum[1] = dU[2]; 184 ds.U.momentum[2] = dU[3]; 185 ds.U.E_total = dU[4]; 186 ds.Y = StatePrimitiveFromConservative_fwd(gas, s, ds.U, x, dx); 187 return ds; 188 } 189 190 CEED_QFUNCTION_HELPER State StateFromY(NewtonianIdealGasContext gas, const CeedScalar Y[5], const CeedScalar x[3]) { 191 State s; 192 s.Y.pressure = Y[0]; 193 s.Y.velocity[0] = Y[1]; 194 s.Y.velocity[1] = Y[2]; 195 s.Y.velocity[2] = Y[3]; 196 s.Y.temperature = Y[4]; 197 s.U = StateConservativeFromPrimitive(gas, s.Y, x); 198 return s; 199 } 200 201 CEED_QFUNCTION_HELPER State StateFromY_fwd(NewtonianIdealGasContext gas, State s, const CeedScalar dY[5], const CeedScalar x[3], 202 const CeedScalar dx[3]) { 203 State ds; 204 ds.Y.pressure = dY[0]; 205 ds.Y.velocity[0] = dY[1]; 206 ds.Y.velocity[1] = dY[2]; 207 ds.Y.velocity[2] = dY[3]; 208 ds.Y.temperature = dY[4]; 209 ds.U = StateConservativeFromPrimitive_fwd(gas, s, ds.Y, x, dx); 210 return ds; 211 } 212 213 // Function pointer types for State struct -> generic state array 214 typedef void (*StateToQi_t)(NewtonianIdealGasContext gas, const State input, CeedScalar qi[5]); 215 216 CEED_QFUNCTION_HELPER void FluxInviscid(NewtonianIdealGasContext gas, State s, StateConservative Flux[3]) { 217 for (CeedInt i = 0; i < 3; i++) { 218 Flux[i].density = s.U.momentum[i]; 219 for (CeedInt j = 0; j < 3; j++) Flux[i].momentum[j] = s.U.momentum[i] * s.Y.velocity[j] + s.Y.pressure * (i == j); 220 Flux[i].E_total = (s.U.E_total + s.Y.pressure) * s.Y.velocity[i]; 221 } 222 } 223 224 CEED_QFUNCTION_HELPER void FluxInviscid_fwd(NewtonianIdealGasContext gas, State s, State ds, StateConservative dFlux[3]) { 225 for (CeedInt i = 0; i < 3; i++) { 226 dFlux[i].density = ds.U.momentum[i]; 227 for (CeedInt j = 0; j < 3; j++) { 228 dFlux[i].momentum[j] = ds.U.momentum[i] * s.Y.velocity[j] + s.U.momentum[i] * ds.Y.velocity[j] + ds.Y.pressure * (i == j); 229 } 230 dFlux[i].E_total = (ds.U.E_total + ds.Y.pressure) * s.Y.velocity[i] + (s.U.E_total + s.Y.pressure) * ds.Y.velocity[i]; 231 } 232 } 233 234 CEED_QFUNCTION_HELPER StateConservative FluxInviscidDotNormal(NewtonianIdealGasContext gas, State s, const CeedScalar normal[3]) { 235 StateConservative Flux[3], Flux_dot_n = {0}; 236 FluxInviscid(gas, s, Flux); 237 for (CeedInt i = 0; i < 3; i++) { 238 Flux_dot_n.density += Flux[i].density * normal[i]; 239 for (CeedInt j = 0; j < 3; j++) Flux_dot_n.momentum[j] += Flux[i].momentum[j] * normal[i]; 240 Flux_dot_n.E_total += Flux[i].E_total * normal[i]; 241 } 242 return Flux_dot_n; 243 } 244 245 CEED_QFUNCTION_HELPER StateConservative FluxInviscidDotNormal_fwd(NewtonianIdealGasContext gas, State s, State ds, const CeedScalar normal[3]) { 246 StateConservative dFlux[3], Flux_dot_n = {0}; 247 FluxInviscid_fwd(gas, s, ds, dFlux); 248 for (CeedInt i = 0; i < 3; i++) { 249 Flux_dot_n.density += dFlux[i].density * normal[i]; 250 for (CeedInt j = 0; j < 3; j++) Flux_dot_n.momentum[j] += dFlux[i].momentum[j] * normal[i]; 251 Flux_dot_n.E_total += dFlux[i].E_total * normal[i]; 252 } 253 return Flux_dot_n; 254 } 255 256 CEED_QFUNCTION_HELPER void FluxInviscidStrong(NewtonianIdealGasContext gas, State s, State ds[3], CeedScalar strong_conv[5]) { 257 for (CeedInt i = 0; i < 5; i++) strong_conv[i] = 0; 258 for (CeedInt i = 0; i < 3; i++) { 259 StateConservative dF[3]; 260 FluxInviscid_fwd(gas, s, ds[i], dF); 261 CeedScalar dF_i[5]; 262 UnpackState_U(dF[i], dF_i); 263 for (CeedInt j = 0; j < 5; j++) strong_conv[j] += dF_i[j]; 264 } 265 } 266 267 CEED_QFUNCTION_HELPER void FluxTotal(const StateConservative F_inviscid[3], CeedScalar stress[3][3], CeedScalar Fe[3], CeedScalar Flux[5][3]) { 268 for (CeedInt j = 0; j < 3; j++) { 269 Flux[0][j] = F_inviscid[j].density; 270 for (CeedInt k = 0; k < 3; k++) Flux[k + 1][j] = F_inviscid[j].momentum[k] - stress[k][j]; 271 Flux[4][j] = F_inviscid[j].E_total + Fe[j]; 272 } 273 } 274 275 CEED_QFUNCTION_HELPER void FluxTotal_Boundary(const StateConservative F_inviscid[3], const CeedScalar stress[3][3], const CeedScalar Fe[3], 276 const CeedScalar normal[3], CeedScalar Flux[5]) { 277 for (CeedInt j = 0; j < 5; j++) Flux[j] = 0.; 278 for (CeedInt j = 0; j < 3; j++) { 279 Flux[0] += F_inviscid[j].density * normal[j]; 280 for (CeedInt k = 0; k < 3; k++) { 281 Flux[k + 1] += (F_inviscid[j].momentum[k] - stress[k][j]) * normal[j]; 282 } 283 Flux[4] += (F_inviscid[j].E_total + Fe[j]) * normal[j]; 284 } 285 } 286 287 // Kelvin-Mandel notation 288 CEED_QFUNCTION_HELPER void KMStrainRate(const State grad_s[3], CeedScalar strain_rate[6]) { 289 const CeedScalar weight = 1 / sqrt(2.); 290 strain_rate[0] = grad_s[0].Y.velocity[0]; 291 strain_rate[1] = grad_s[1].Y.velocity[1]; 292 strain_rate[2] = grad_s[2].Y.velocity[2]; 293 strain_rate[3] = weight * (grad_s[2].Y.velocity[1] + grad_s[1].Y.velocity[2]); 294 strain_rate[4] = weight * (grad_s[2].Y.velocity[0] + grad_s[0].Y.velocity[2]); 295 strain_rate[5] = weight * (grad_s[1].Y.velocity[0] + grad_s[0].Y.velocity[1]); 296 } 297 298 CEED_QFUNCTION_HELPER void NewtonianStress(NewtonianIdealGasContext gas, const CeedScalar strain_rate[6], CeedScalar stress[6]) { 299 CeedScalar div_u = strain_rate[0] + strain_rate[1] + strain_rate[2]; 300 for (CeedInt i = 0; i < 6; i++) { 301 stress[i] = gas->mu * (2 * strain_rate[i] + gas->lambda * div_u * (i < 3)); 302 } 303 } 304 305 CEED_QFUNCTION_HELPER void ViscousEnergyFlux(NewtonianIdealGasContext gas, StatePrimitive Y, const State grad_s[3], const CeedScalar stress[3][3], 306 CeedScalar Fe[3]) { 307 for (CeedInt i = 0; i < 3; i++) { 308 Fe[i] = -Y.velocity[0] * stress[0][i] - Y.velocity[1] * stress[1][i] - Y.velocity[2] * stress[2][i] - gas->k * grad_s[i].Y.temperature; 309 } 310 } 311 312 CEED_QFUNCTION_HELPER void ViscousEnergyFlux_fwd(NewtonianIdealGasContext gas, StatePrimitive Y, StatePrimitive dY, const State grad_ds[3], 313 const CeedScalar stress[3][3], const CeedScalar dstress[3][3], CeedScalar dFe[3]) { 314 for (CeedInt i = 0; i < 3; i++) { 315 dFe[i] = -Y.velocity[0] * dstress[0][i] - dY.velocity[0] * stress[0][i] - Y.velocity[1] * dstress[1][i] - dY.velocity[1] * stress[1][i] - 316 Y.velocity[2] * dstress[2][i] - dY.velocity[2] * stress[2][i] - gas->k * grad_ds[i].Y.temperature; 317 } 318 } 319 320 #endif // newtonian_state_h 321