Commit 11c8383a authored by Jordan Musser's avatar Jordan Musser
Browse files

Cleanup rationalize solver flags (!233)

parent 3b74d2e5

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+1 −1
Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ using the prefix ``bc.[region_name].[fluid_name]``: 
+------------------------+------------------------------------------------------------------------+-------------+-----------+

| 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      |

| species.[species_name] | Mass fraction of ``species_name`` [required if ``enable.species``      | Real        | None      |

|                        | is enabled and bc type is ``mi`` or ``pi``].  Must be a fluid species. |             |           |

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

| normal                 | Specify the flow direction for mass inflows. Providing a normal is     | Reals<3>    | None      |

docs/source_docs/user_guide/inputs/chemical_reactions.rst

+4 −3
Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 4 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -181,9 +181,8 @@ to chemical reactions. 


  mfix.constraint_type  = IdealGasOpenSystem



  mfix.advect_density   = 1

  mfix.advect_enthalpy  = 1

  mfix.solve_species    = 1

  mfix.enable.energy = true

  mfix.enable.species = true



  # Species model settings

  #----------------------------------------------------------------------
@@ -289,6 +288,8 @@ to chemical reactions. 
  #----------------------------------------------------------------------

  fluid.solve = fluid



  fluid.enable.density_advection = true



  fluid.thermodynamic_pressure = 101325.

  fluid.reference_temperature = 298.15

docs/source_docs/user_guide/inputs/fluid_model.rst

+12 −9
Changes for docs/source_docs/user_guide/inputs/fluid_model.rst: 12 added lines, 9 removed lines.
Original line number Diff line number Diff line
@@ -550,15 +550,16 @@ are not solved. 


   mfix.constraint = IncompressibleFluid



   mfix.advect_density  = 0

   mfix.advect_enthalpy = 0

   mfix.solve_species   = 0

   mfix.enable.energy = false

   mfix.enable.species = false





   # Fluid model settings

   # -----------------------------------------------------------------------

   fluid.solve = fluid0



   fluid.enable.density_advection = false



   fluid0.viscosity.molecular.model = constant

   fluid0.viscosity.molecular.constant = 1.8e-5
@@ -604,15 +605,16 @@ pressure when evaluating the equation of state. 


   mfix.constraint = IdealGasOpenSystem



   mfix.advect_density  = 1

   mfix.advect_enthalpy = 0

   mfix.solve_species   = 0

   mfix.enable.energy   = false

   mfix.enable.species = false





   # Fluid model settings

   # -----------------------------------------------------------------------

   fluid.solve = fluid0



   fluid.enable.density_advection = true



   fluid0.viscosity.molecular.model = constant

   fluid0.viscosity.molecular.constant = 1.8e-5
@@ -662,15 +664,16 @@ thermodynamic pressure for the system. 


   mfix.constraint = IdealGasOpenSystem



   mfix.advect_density  = 1

   mfix.advect_enthalpy = 1

   mfix.solve_species   = 0

   mfix.enable.energy = true

   mfix.enable.species = false





   # Fluid model settings

   # -----------------------------------------------------------------------

   fluid.solve = fluid0



   fluid.enable.density_advection = true



   fluid0.viscosity.molecular.model = constant

   fluid0.viscosity.molecular.constant = 2.0e-5

docs/source_docs/user_guide/inputs/model_options.rst

+19 −15
Changes for docs/source_docs/user_guide/inputs/model_options.rst: 19 added lines, 15 removed lines.
Original line number Diff line number Diff line
@@ -15,27 +15,33 @@ Enabling solvers 


The following input is defined using the prefix ``mfix``:



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

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

|                          | Description                                                                |   Type   | Default |

+==========================+============================================================================+==========+=====================+

+==========================+============================================================================+==========+=========+

| enable.fluid             | Enable the fluid solver.                                                   | Bool     | false   |

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

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

| enable.solids            | Enable the solids solver for DEM or PIC.                                   | Bool     | false   |

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

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

| enable.species           | Enable the MFIX species solver.                                            | Int      | false   |

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

| enable.energy            | Enable time evolution of fluid temperature and enthalpy.                   | Bool     | false   |

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

| enable.radiation         | Enable the radiation solver. This solver must be built with RTE enabled.   | Bool     | false   |

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

| solve_species            | Enable the MFIX species solver.                                            | Int      | 0                   |

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

| advect_enthalpy          | Enable time evolution of fluid temperature and enthalpy.                   | Int      | 0                   |

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

| advect_density           | Enable time evolution of fluid density.                                    | Int      | 0                   |

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



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





Fluid options

-------------



The following inputs are defined using the prefix ``fluid``:



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

|                          | Description                                                                |   Type   | Default   |

+==========================+============================================================================+==========+===========+

| enable.density_advection | Enable time evolution of fluid density.                                    | Bool     | false     |

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





The following inputs are defined using the prefix ``mfix``:



+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
@@ -117,13 +123,11 @@ The following inputs are defined using the prefix ``mfix``: 
|                                      | mac phi which contains the full pressure.                                  |             |                     |

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





.. note::

   The thermodynamic pressure is a scalar value, not a scalar field. This is a consequence of

   the low Mach number assumption.









Particle options

----------------

docs/source_docs/user_guide/inputs/species.rst

+8 −6
Changes for docs/source_docs/user_guide/inputs/species.rst: 8 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -313,9 +313,8 @@ local species concentrations do not affect the fluid. 


   mfix.constraint = IncompressibleFluid



   mfix.advect_density  = 0

   mfix.advect_enthalpy = 0

   mfix.solve_species   = 1

   mfix.enable.energy = false

   mfix.enable.species = true





   # Species model settings
@@ -330,6 +329,8 @@ local species concentrations do not affect the fluid. 
   # -----------------------------------------------------------------------

   fluid.solve = fluid



   fluid.enable.density_advection = false



   fluid.viscosity.molecular.model = constant

   fluid.viscosity.molecular.constant = 2.0e-5
@@ -386,9 +387,8 @@ outflow boundary condition pressure which is set here to 1 atmosphere. 


   mfix.constraint = IdealGasOpenSystem



   mfix.advect_density  = 1

   mfix.solve_species   = 1

   mfix.advect_enthalpy = 1

   mfix.enable.energy = false

   mfix.enable.species = true



   # Species model settings

   # -----------------------------------------------------------------------
@@ -422,6 +422,8 @@ outflow boundary condition pressure which is set here to 1 atmosphere. 
   # -----------------------------------------------------------------------

   fluid.solve = fluid



   fluid.enable.density_advection = true



   fluid.viscosity.molecular.model = constant

   fluid.viscosity.molecular.constant = 2.0e-5