1 // SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors. 2 // SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause 3 // 4 /// @file 5 /// Implementation of differential filtering 6 #include <ceed/types.h> 7 8 #include "differential_filter_enums.h" 9 #include "newtonian_state.h" 10 #include "newtonian_types.h" 11 #include "utils.h" 12 13 enum DifferentialFilterDampingFunction { DIFF_FILTER_DAMP_NONE, DIFF_FILTER_DAMP_VAN_DRIEST, DIFF_FILTER_DAMP_MMS }; 14 #ifndef CEED_RUNNING_JIT_PASS 15 static const char *const DifferentialFilterDampingFunctions[] = { 16 "NONE", "VAN_DRIEST", "MMS", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL}; 17 #endif 18 19 typedef struct DifferentialFilterContext_ *DifferentialFilterContext; 20 struct DifferentialFilterContext_ { 21 bool grid_based_width; 22 CeedScalar width_scaling[3]; 23 CeedScalar kernel_scaling; 24 CeedScalar friction_length; 25 enum DifferentialFilterDampingFunction damping_function; 26 CeedScalar damping_constant; 27 struct NewtonianIdealGasContext_ gas; 28 }; 29 30 CEED_QFUNCTION_HELPER int DifferentialFilter_RHS(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out, StateVariable state_var) { 31 const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; 32 const CeedScalar(*q_data)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[1]; 33 CeedScalar(*v0)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; 34 CeedScalar(*v1)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[1]; 35 36 DifferentialFilterContext context = (DifferentialFilterContext)ctx; 37 NewtonianIdealGasContext gas = &context->gas; 38 39 CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { 40 const CeedScalar qi[5] = {q[0][i], q[1][i], q[2][i], q[3][i], q[4][i]}; 41 const CeedScalar wdetJ = q_data[0][i]; 42 const State s = StateFromQ(gas, qi, state_var); 43 44 v0[DIFF_FILTER_PRESSURE][i] = wdetJ * s.Y.pressure; 45 v0[DIFF_FILTER_VELOCITY_X][i] = wdetJ * s.Y.velocity[0]; 46 v0[DIFF_FILTER_VELOCITY_Y][i] = wdetJ * s.Y.velocity[1]; 47 v0[DIFF_FILTER_VELOCITY_Z][i] = wdetJ * s.Y.velocity[2]; 48 v0[DIFF_FILTER_TEMPERATURE][i] = wdetJ * s.Y.temperature; 49 v1[DIFF_FILTER_VELOCITY_SQUARED_XX][i] = wdetJ * s.Y.velocity[0] * s.Y.velocity[0]; 50 v1[DIFF_FILTER_VELOCITY_SQUARED_YY][i] = wdetJ * s.Y.velocity[1] * s.Y.velocity[1]; 51 v1[DIFF_FILTER_VELOCITY_SQUARED_ZZ][i] = wdetJ * s.Y.velocity[2] * s.Y.velocity[2]; 52 v1[DIFF_FILTER_VELOCITY_SQUARED_YZ][i] = wdetJ * s.Y.velocity[1] * s.Y.velocity[2]; 53 v1[DIFF_FILTER_VELOCITY_SQUARED_XZ][i] = wdetJ * s.Y.velocity[0] * s.Y.velocity[2]; 54 v1[DIFF_FILTER_VELOCITY_SQUARED_XY][i] = wdetJ * s.Y.velocity[0] * s.Y.velocity[1]; 55 } 56 return 0; 57 } 58 59 CEED_QFUNCTION(DifferentialFilter_RHS_Conserv)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 60 return DifferentialFilter_RHS(ctx, Q, in, out, STATEVAR_CONSERVATIVE); 61 } 62 63 CEED_QFUNCTION(DifferentialFilter_RHS_Prim)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 64 return DifferentialFilter_RHS(ctx, Q, in, out, STATEVAR_PRIMITIVE); 65 } 66 67 CEED_QFUNCTION(DifferentialFilter_RHS_Entropy)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 68 return DifferentialFilter_RHS(ctx, Q, in, out, STATEVAR_ENTROPY); 69 } 70 71 CEED_QFUNCTION_HELPER CeedScalar VanDriestWallDamping(const CeedScalar wall_dist_plus, const CeedScalar A_plus) { 72 return -expm1(-wall_dist_plus / A_plus); 73 } 74 75 CEED_QFUNCTION_HELPER int DifferentialFilter_LHS_N(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out, const CeedInt N) { 76 const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; 77 const CeedScalar(*Grad_q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[1]; 78 const CeedScalar(*A_ij_delta)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[2]; 79 const CeedScalar(*x)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[3]; 80 const CeedScalar(*q_data) = in[4]; 81 CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; 82 CeedScalar(*Grad_v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[1]; 83 84 DifferentialFilterContext context = (DifferentialFilterContext)ctx; 85 86 CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { 87 CeedPragmaSIMD for (CeedInt j = 0; j < N; j++) { 88 const CeedScalar x_i[3] = {x[0][i], x[1][i], x[2][i]}; 89 CeedScalar wdetJ, dXdx[3][3]; 90 QdataUnpack_3D(Q, i, q_data, &wdetJ, dXdx); 91 92 CeedScalar Delta_ij[3][3] = {{0.}}; 93 if (context->grid_based_width) { 94 CeedScalar km_A_ij[6] = {A_ij_delta[0][i], A_ij_delta[1][i], A_ij_delta[2][i], A_ij_delta[3][i], A_ij_delta[4][i], A_ij_delta[5][i]}; 95 const CeedScalar delta = A_ij_delta[6][i]; 96 ScaleN(km_A_ij, delta, 6); // Dimensionalize the normalized anisotropy tensor 97 KMUnpack(km_A_ij, Delta_ij); 98 } else { 99 Delta_ij[0][0] = Delta_ij[1][1] = Delta_ij[2][2] = 1; 100 } 101 102 CeedScalar scaling_matrix[3][3] = {{0}}; 103 if (context->damping_function == DIFF_FILTER_DAMP_VAN_DRIEST) { 104 const CeedScalar damping_coeff = VanDriestWallDamping(x_i[1] / context->friction_length, context->damping_constant); 105 scaling_matrix[0][0] = Max(1, damping_coeff * context->width_scaling[0]); 106 scaling_matrix[1][1] = damping_coeff * context->width_scaling[1]; 107 scaling_matrix[2][2] = Max(1, damping_coeff * context->width_scaling[2]); 108 } else if (context->damping_function == DIFF_FILTER_DAMP_NONE) { 109 scaling_matrix[0][0] = context->width_scaling[0]; 110 scaling_matrix[1][1] = context->width_scaling[1]; 111 scaling_matrix[2][2] = context->width_scaling[2]; 112 } else if (context->damping_function == DIFF_FILTER_DAMP_MMS) { 113 const CeedScalar damping_coeff = tanh(60 * x_i[1]); 114 scaling_matrix[0][0] = 1; 115 scaling_matrix[1][1] = damping_coeff; 116 scaling_matrix[2][2] = 1; 117 } 118 119 CeedScalar scaled_Delta_ij[3][3] = {{0.}}; 120 MatMat3(scaling_matrix, Delta_ij, CEED_NOTRANSPOSE, CEED_NOTRANSPOSE, scaled_Delta_ij); 121 CopyMat3(scaled_Delta_ij, Delta_ij); 122 123 CeedScalar alpha_ij[3][3] = {{0.}}; 124 MatMat3(Delta_ij, Delta_ij, CEED_NOTRANSPOSE, CEED_NOTRANSPOSE, alpha_ij); 125 ScaleN((CeedScalar *)alpha_ij, context->kernel_scaling, 9); 126 127 v[j][i] = wdetJ * q[j][i]; 128 CeedScalar dq[3], dq_dXdx[3] = {0.}, dq_dXdx_a[3] = {0.}; 129 for (int k = 0; k < 3; k++) { 130 dq[k] = Grad_q[0 * N + j][i] * dXdx[0][k] + Grad_q[1 * N + j][i] * dXdx[1][k] + Grad_q[2 * N + j][i] * dXdx[2][k]; 131 } 132 MatVec3(dXdx, dq, CEED_NOTRANSPOSE, dq_dXdx); 133 MatVec3(alpha_ij, dq_dXdx, CEED_NOTRANSPOSE, dq_dXdx_a); 134 for (int k = 0; k < 3; k++) { 135 Grad_v[k * N + j][i] = wdetJ * dq_dXdx_a[k]; 136 } 137 } 138 } 139 return 0; 140 } 141 142 CEED_QFUNCTION(DifferentialFilter_LHS_1)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 143 return DifferentialFilter_LHS_N(ctx, Q, in, out, 1); 144 } 145 146 CEED_QFUNCTION(DifferentialFilter_LHS_5)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 147 return DifferentialFilter_LHS_N(ctx, Q, in, out, 5); 148 } 149 150 CEED_QFUNCTION(DifferentialFilter_LHS_6)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 151 return DifferentialFilter_LHS_N(ctx, Q, in, out, 6); 152 } 153 154 CEED_QFUNCTION(DifferentialFilter_LHS_11)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 155 return DifferentialFilter_LHS_N(ctx, Q, in, out, 11); 156 } 157 158 CEED_QFUNCTION_HELPER CeedScalar MMS_Solution(const CeedScalar x_i[3], const CeedScalar omega) { 159 return sin(6 * omega * x_i[0]) + sin(6 * omega * x_i[1]); 160 } 161 162 CEED_QFUNCTION(DifferentialFilter_MMS_RHS)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 163 const CeedScalar(*q)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; 164 const CeedScalar(*q_data)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[1]; 165 CeedScalar(*v)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; 166 167 CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { 168 const CeedScalar wdetJ = q_data[0][i]; 169 v[0][i] = wdetJ * q[0][i]; 170 } 171 return 0; 172 } 173 174 // @brief Generate initial condition such that the solution of the differential filtering is given by MMS_Solution() above 175 // 176 // This requires a *very* specific grid, as the anisotropic filtering is grid dependent. 177 // It's for a 75x75x1 grid on a [0,0.5]x3 domain. 178 // The grid is evenly distributed in x, but distributed based on the analytical mesh distribution \Delta_y = .001 + .01*tanh(6*y). 179 // The MMS test can optionally include a wall damping function (must also be enabled for the differential filtering itself). 180 // It can be run via: 181 // ./navierstokes -options_file tests-output/blasius_test.yaml -diff_filter_monitor -diff_filter_view cgns:filtered_solution.cgns -ts_max_steps 0 182 // -diff_filter_mms -diff_filter_kernel_scaling 1 -diff_filter_wall_damping_function mms -dm_plex_box_upper 0.5,0.5,0.5 -dm_plex_box_faces 75,75,1 183 // -mesh_transform platemesh -platemesh_y_node_locs_path tests-output/diff_filter_mms_y_spacing.dat -platemesh_top_angle 0 184 // -diff_filter_grid_based_width 185 CEED_QFUNCTION(DifferentialFilter_MMS_IC)(void *ctx, CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out) { 186 const CeedScalar(*x)[CEED_Q_VLA] = (const CeedScalar(*)[CEED_Q_VLA])in[0]; 187 CeedScalar(*q0)[CEED_Q_VLA] = (CeedScalar(*)[CEED_Q_VLA])out[0]; 188 189 CeedPragmaSIMD for (CeedInt i = 0; i < Q; i++) { 190 const CeedScalar x_i[3] = {x[0][i], x[1][i], x[2][i]}; 191 192 const CeedScalar aniso_scale_factor = 1; // Must match the one passed in by -diff_filter_aniso_scale 193 const CeedScalar omega = 2 * M_PI; 194 const CeedScalar omega6 = 6 * omega; 195 const CeedScalar phi_bar = MMS_Solution(x_i, omega); 196 const CeedScalar dx = 0.5 / 75; 197 const CeedScalar dy_analytic = .001 + .01 * tanh(6 * x_i[1]); 198 const CeedScalar dy = dy_analytic; 199 const CeedScalar d_dy_dy = 0.06 * Square(1 / cosh(6 * x_i[1])); // Change of \Delta_y w.r.t. y 200 CeedScalar alpha[2] = {Square(dx) * aniso_scale_factor, Square(dy) * aniso_scale_factor}; 201 bool damping = true; 202 CeedScalar dalpha1dy; 203 if (damping) { 204 CeedScalar damping_coeff = tanh(60 * x_i[1]); 205 CeedScalar d_damping_coeff = 60 / Square(cosh(60 * x_i[1])); 206 dalpha1dy = aniso_scale_factor * 2 * (damping_coeff * dy) * (dy * d_damping_coeff + damping_coeff * d_dy_dy); 207 alpha[1] *= Square(damping_coeff); 208 } else { 209 dalpha1dy = aniso_scale_factor * 2 * dy * d_dy_dy; 210 } 211 212 CeedScalar phi = phi_bar + alpha[0] * Square(omega6) * sin(6 * omega * x_i[0]) + alpha[1] * Square(omega6) * sin(omega6 * x_i[1]); 213 phi -= dalpha1dy * omega6 * cos(omega6 * x_i[1]); 214 215 for (CeedInt j = 0; j < 5; j++) q0[j][i] = phi; 216 } 217 return 0; 218 } 219