Skip to content

Commit

Permalink
inputs documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mbkuhn committed Nov 11, 2024
1 parent ea984e8 commit 350b8f9
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/sphinx/user/inputs_Momentum_Sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -239,3 +239,30 @@ Section: Momentum Sources

This term turns off the sponge layer. This term is required for terrain simulations with periodic
boundary conditions. The default value is 0.


The following arguments are influential when :input_param:`GravityForcing` is used

Check failure on line 244 in docs/sphinx/user/inputs_Momentum_Sources.rst

View workflow job for this annotation

GitHub Actions / Docs

WARNING: 'input_param' reference target not found: GravityForcing [ref.input_param]

Check failure on line 244 in docs/sphinx/user/inputs_Momentum_Sources.rst

View workflow job for this annotation

GitHub Actions / Docs

WARNING: 'input_param' reference target not found: GravityForcing [ref.input_param]

.. input_param:: ICNS.use_perturb_pressure

**type:** Boolean, optional, default = false

When this option is off, the GravityForcing term is simply :math:`g`, which becomes
:math:`\rho g` when included in the momentum equation. By activating this option,
the momentum term applied by GravityForcing will become :math:`(\rho - \rho_0) g`,
where :math:`rho_0` is some constant reference density profile. The reference density field
can be created by either MultiPhase physics or anelastic ABL physics. By using the
reference density, the pressure field seen by the solver is represented as a
perturbation from a reference pressure field, enabling pressure_outflow boundary
conditions to better handle certain flows, e.g., those with equilibrium pressure gradients
parallel to the outflow plane.

.. input_param:: ICNS.reconstruct_true_pressure

**type:** Boolean, optional, default = false

This option is only valid when the perturbational pressure form is being used, i.e.,
:input_param:`ICNS.use_perturb_pressure` = true. Reconstructing the true pressure
adds back the reference pressure profile to obtain the full pressure after the
pressure solve has been performed. This makes no difference to the flow evolution,
but it changes the field available for post-processing or coupling to overset solvers.
7 changes: 7 additions & 0 deletions docs/sphinx/user/inputs_incflo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ as initial conditions and discretization options.
Specify reference density.
For the most part if :input_param:`incflo.constant_density` = true then `incflo.density` sets a constant density everywhere.
Refer to the field initializer for your chosen :input_param:`incflo.physics` for how `incflo.density` is used.

.. input_param:: incflo.gravity

**type:** List of three Real numbers, optional, default = 0 0 -9.81

Acceleration due to gravity in m/s\ :sup:`2` \. This constant vector is used by all parts
of the solver related to gravity.

.. input_param:: incflo.velocity

Expand Down

0 comments on commit 350b8f9

Please sign in to comment.