Skip to content

Commit 066082b

Browse files
Refactor fluid_3d_c to fluid_unified_c and improve documentation
Co-authored-by: abrown97 <[email protected]>
1 parent 809e569 commit 066082b

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

Code/Source/solver/fluid.cpp

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -886,8 +886,28 @@ void fluid_3d_c(ComMod& com_mod, const int vmsFlag, const int eNoNw, const int e
886886
fluid_unified_c(com_mod, vmsFlag, eNoNw, eNoNq, w, Kxi, Nw, Nq, Nwx, Nqx, Nwxx, al, yl, bfl, lR, lK, K_inverse_darcy_permeability, DDir);
887887
}
888888

889-
/// @brief Legacy wrapper for 3D momentum.
889+
/// @brief Assemble momentum residual and tangent contributions for a Gauss integration point.
890890
///
891+
/// Args:
892+
/// com_mod - ComMod object
893+
/// vmsFlag - Flag to indicate if VMS is enabled
894+
/// eNoNw - Number of nodes in element for velocity
895+
/// eNoNq - Number of nodes in element for pressure
896+
/// w - Weight of the quadrature point
897+
/// Kxi - Summed gradients of parametric coordinates with respect to physical coordinates.
898+
/// G tensor in https://www.sciencedirect.com/science/article/pii/S0045782507003027#sec4 Eq. 65. Size: (nsd,nsd)
899+
/// Nw - Shape function for velocity. Size: (eNoNw)
900+
/// Nq - Shape function for pressure. Size: (eNoNq)
901+
/// Nwx - Gradient of shape functions for velocity. Size: (nsd,eNoNw)
902+
/// Nqx - Gradient of shape functions for pressure. Size: (nsd,eNoNq)
903+
/// Nwxx - Second order gradient of shape functions for velocity. Size: (nsd,nsd,eNoNw)
904+
/// al - Acceleration array (for current element)
905+
/// yl - Velocity array (for current element)
906+
/// bfl - Body force array (for current element)
907+
/// K_inverse_darcy_permeability - Inverse of the Darcy permeability
908+
/// DDir - Dirac Delta function for URIS surface
909+
/// lR - Local residual array (for current element)
910+
/// lK - Local stiffness matrix (for current element)
891911
/// Modifies:
892912
/// lR(dof,eNoN) - Residual
893913
/// lK(dof*dof,eNoN,eNoN) - Stiffness matrix

0 commit comments

Comments
 (0)