Updates for MR1879

Jordan Musserrequested to merge
jmusser/exa-docs:docs-updates-for-mr1879 into main

Merge request reports

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+3 −4
Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 3 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -49,7 +49,8 @@ For each boundary condition the reference frame is defined using the prefix ``bc 
|                       |  * ``rotating``: Velocity is interpreted relative to the rotating      |          |          |

|                       |    frame appropriately transformed when applied.                       |          |          |

+-----------------------+------------------------------------------------------------------------+----------+----------+



| pressure              | Fluid pressure [required if bc type is ``po`` or ``pi``]               | Real     | None     |

+-----------------------+------------------------------------------------------------------------+----------+----------+



Fluid settings

~~~~~~~~~~~~~~
@@ -63,8 +64,6 @@ using the prefix ``bc.[region_name].[fluid_name]``: 
+========================+========================================================================+=============+===========+

| density                | Fluid density [required if bc type is ``mi`` or ``pi``]                | Real        | None      |

+------------------------+------------------------------------------------------------------------+-------------+-----------+

| pressure               | Fluid pressure [required if bc type is ``po`` or ``pi``]               | Real        | None      |

+------------------------+------------------------------------------------------------------------+-------------+-----------+

| temperature            | Fluid temperature [required if bc type is ``mi`` or ``pi``]            | Real        | None      |

+------------------------+------------------------------------------------------------------------+-------------+-----------+

| species.[species_name] | Mass fraction of ``species_name`` [required if ``solve_species``       | Real        | None      |
@@ -107,7 +106,7 @@ Below is an example for specifying boundary conditions for fluid (``fluid``). 


   bc.outflow = po



   bc.outflow.fluid.pressure =  0.0

   bc.outflow.pressure =  0.0





Below is an example for specifying a normal inflow velocity magnitude for a region `eb-flow`.

docs/source_docs/user_guide/inputs/chemical_reactions.rst

+1 −1
Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -373,4 +373,4 @@ to chemical reactions. 
  bc.inflow.fluid.species.N2    = 0.2



  bc.outflow = po

  bc.outflow.fluid.pressure =  101325.
 
  bc.outflow.pressure =  101325.

docs/source_docs/user_guide/inputs/fluid_model.rst

+3 −3
Changes for docs/source_docs/user_guide/inputs/fluid_model.rst: 3 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -584,7 +584,7 @@ are not solved. 
   bc.inlet.fluid0.velocity =  1.0e-8



   bc.outlet = po

   bc.outlet.fluid0.pressure =  0.

   bc.outlet.pressure =  0.





Simple ideal gas
@@ -642,7 +642,7 @@ pressure when evaluating the equation of state. 
   bc.inlet.fluid0.temperature = 300.0



   bc.outlet = po

   bc.outlet.fluid0.pressure =  101325.

   bc.outlet.pressure =  101325.
@@ -712,4 +712,4 @@ thermodynamic pressure for the system. 


   bc.outlet = po



   bc.outlet.fluid0.pressure =  101325.
 
   bc.outlet.pressure =  101325.

docs/source_docs/user_guide/inputs/initial_conditions.rst

+0 −2
Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 0 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -50,8 +50,6 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: 
+------------------------+------------------------------------------------------------------------+-------------+-----------+

| velocity               | Velocity components.                                                   | Reals<3>    | None      |

+------------------------+------------------------------------------------------------------------+-------------+-----------+

| pressure               | Fluid pressure.                                                        | Real        | None      |

+------------------------+------------------------------------------------------------------------+-------------+-----------+

| temperature            | Fluid temperature.                                                     | Real        | None      |

+------------------------+------------------------------------------------------------------------+-------------+-----------+

| species.[species_name] | Mass fraction of ``species_name``.  Must be a fluid species.           | Real        | None      |

docs/source_docs/user_guide/inputs/species.rst

+2 −2
Changes for docs/source_docs/user_guide/inputs/species.rst: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -360,7 +360,7 @@ local species concentrations do not affect the fluid. 
   bc.inlet.fluid.species.O2   =  0.23



   bc.outlet = po

   bc.outlet.fluid.pressure =  0.

   bc.outlet.pressure =  0.





Fluid as mixture
@@ -460,4 +460,4 @@ outflow boundary condition pressure which is set here to 1 atmosphere. 
   bc.inlet.fluid.temperature = 300.0



   bc.outlet = po

   bc.outlet.fluid.pressure =  101325.
 
   bc.outlet.pressure =  101325.