Merge remote-tracking branch 'origin/dev-0.3-main' into dev-0.3/code-…

…cleanup
mberto79 · Aug 30, 2024 · f564d2d · f564d2d
2 parents 3302922 + ff002a7
commit f564d2d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/Solvers/Solvers_1_SIMPLE_comp.jl b/src/Solvers/Solvers_1_SIMPLE_comp.jl
@@ -1,5 +1,11 @@
 export simple_comp!
 
+"""
+ simple_comp!(model_in, config; resume=true, pref=nothing)
+
+Compressible variant of the SIMPLE algorithm with a sensible enthalpy transport equation for 
+the energy. 
+"""
 simple_comp!(model_in, config; resume=true, pref=nothing) = begin
  R_ux, R_uy, R_uz, R_p, R_e, model = setup_compressible_solvers(
  CSIMPLE, model_in, config;