From 4f6ffc87741983ab2af1f74f7b3207dbd1470ea4 Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Wed, 13 May 2026 14:38:46 -0400 Subject: [PATCH 01/14] Adding keys for radiation --- .../user_guide/inputs/boundary_conditions.rst | 65 ++++++ .../user_guide/inputs/fluid_model.rst | 196 ++++++++++++++++-- .../user_guide/inputs/model_options.rst | 2 + .../user_guide/inputs/radiation_model.rst | 172 +++++++++++++++ .../user_guide/inputs/solids_model.rst | 64 ++++++ .../source_docs/user_guide/inputs/species.rst | 81 ++++++++ .../user_guide/run-time_inputs.rst | 1 + 7 files changed, 569 insertions(+), 12 deletions(-) create mode 100644 docs/source_docs/user_guide/inputs/radiation_model.rst diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 938ac05..351b426 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -449,3 +449,68 @@ Below is an example for specifying a constant temperature boundary condition in bc.hot-walls = eb bc.hot-walls.eb.temperature = constant bc.hot-walls.eb.temperature.constant = 800 + + +Radiation +^^^^^^^^^ + +.. |gray_poly_of_T_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 T + a_2 T^2 + \ldots` +.. |gray_poly_of_invT_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 / T + a_2 / T^2 + \ldots` + +The following table lists the thermal boundary condition options that can be applied to embedded boundaries (EBs), +when the radiation solver is enabled. All EB surfaces must have radiation properties defined when the +radiation solver is enabled. + +The following inputs defined using the prefix ``bc.[region_name].eb.radiation.emissivity``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| model. | Specify which radiation emissivity coefficient model to use | String | None | +| | for the embedded boundaries. Options: | | | +| | | | | +| | * ``gray-poly`` - Emissivity is defined by a | | | +| | temperature-dependent polynomial (0-5th order). Piecewise | | | +| | polynomials are defined by specifying temperature ranges. | | | +| | | | | +| | An emissivity model is required if radiation is enabled. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| form | Specifies the polynomial form used to represent the absorption | Int | 0 | +| | coefficient as a function of temperature. Options: | | | +| | | | | +| | * ``0`` - Absorption coefficient is defined as a polynomial | | | +| | in temperature. | | | +| | | | | +| | |gray_poly_of_T_Eq| | | | +| | | | | +| | * ``1`` - Absorption coefficient is defined as a polynomial | | | +| | in the inverse of temperature. | | | +| | | | | +| | |gray_poly_of_invT_Eq| | | | +| | | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| T_range | Valid temperature range for the polynomial. If no temperature | Reals | None | +| | is provided, then the polynomial is assumed valid for all | | | +| | temperatures. Piecewise polynomials are defined by specify | | | +| | multiple ranges. For example, two piecewise polynomials can be | | | +| | specified by providing three temperatures: low, mid and high. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| polynomial_coeffs | Polynomial coefficient. Polynomials can be up to 5-th order, | Reals | None | +| | and a set of polynomial coefficients must be defined for | | | +| | each temperature range. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + +**Example: Constant valued emissivity** + +A constant value is used over the entire valid temperature range.:: + + regions = sphere ... + + regions.sphere.shape = sphere + regions.sphere.sphere.radius = 0.25 + regions.sphere.sphere.center = 0.0 0.0 0.0 + + bc.regions = sphere ... + + bc.sphere.eb.radiation.emissivity.model = "gray-poly" + bc.sphere.eb.radiation.emissivity.polynomial_coeffs = 1.0 diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 76294f7..0a5a664 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -300,7 +300,6 @@ The following inputs are defined using the prefix ``[fluid_name]``. +--------------------------+----------------------------------------------------------------+--------+----------+ - Thermal conductivity -------------------- @@ -313,7 +312,7 @@ The following inputs are defined using the prefix ``[fluid_name].thermal_conduct +-----------------------+----------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +=======================+================================================================+========+==========+ -| model | Specify which thermal conductivity model to use for | String | None | +| model | Specify which thermal conductivity model to use for the | String | None | | | fluid. Options: | | | | | | | | | | * ``constant`` - constant thermal conductivity | | | @@ -342,21 +341,194 @@ The following inputs are defined using the prefix ``[fluid_name].thermal_conduct +-----------------------+----------------------------------------------------------------+--------+----------+ +Radiation +--------- + +.. |gray_wsgg_Eq| replace:: :math:`\displaystyle a(T) = \sum_n^N \left( [1-e^{-k_i PS}] \sum_i b_{n,i} T^{i-1} \right)` + +The following inputs are defined using the prefix ``[fluid_name].radiation``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| scattering_coeff | | Real | None | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| absorption.model | Specify which radiation absorption coefficient model to use | String | None | +| | for the fluid. Options: | | | +| | | | | +| | * ``gray-poly`` - The absorption coefficient is defined by a | | | +| | temperature-dependent polynomial (0-5th order). Piecewise | | | +| | polynomials are defined by specifying temperature ranges. | | | +| | | | | +| | * ``gray-wsgg`` - Weighted sum of grey-gases model. For each | | | +| | gray gas *n*, a gas‑specific absorption coefficient | | | +| | :math:`k_n` is provided along with a set of polynomial | | | +| | coefficients, :math:`b_{n,i}` (0th-5th order). | | | +| | | | | +| | |gray_wsgg_Eq| | | | +| | | | | +| | * ``mixture`` - Mixture-based model combining species | | | +| | contributions. | | | +| | | | | +| | An absorption model is required if radiation is enabled. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + + +Gray polynomial +^^^^^^^^^^^^^^^ + +.. |gray_poly_of_T_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 T + a_2 T^2 + \ldots` +.. |gray_poly_of_invT_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 / T + a_2 / T^2 + \ldots` + + +The following inputs are defined using the prefix ``[fluid_name].radiation.absorption``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| form | Specifies the polynomial form used to represent the absorption | Int | 0 | +| | coefficient as a function of temperature. Options: | | | +| | | | | +| | * ``0`` - Absorption coefficient is defined as a polynomial | | | +| | in temperature. | | | +| | | | | +| | |gray_poly_of_T_Eq| | | | +| | | | | +| | * ``1`` - Absorption coefficient is defined as a polynomial | | | +| | in the inverse of temperature. | | | +| | | | | +| | |gray_poly_of_invT_Eq| | | | +| | | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| T_range | Valid temperature range for the polynomial. If no temperature | Reals | None | +| | is provided, then the polynomial is assumed valid for all | | | +| | temperatures. Piecewise polynomials are defined by specify | | | +| | multiple ranges. For example, two piecewise polynomials can be | | | +| | specified by providing three temperatures: low, mid and high. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| polynomial_coeffs | Polynomial coefficient. Polynomials can be up to 5-th order, | Reals | None | +| | and a set of polynomial coefficients must be defined for | | | +| | each temperature range. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + +**Example: A single temperature-dependent polynomial** + +A single polynomial is used over the entire valid temperature range. Here, the absorption coefficient is +represented by one set of polynomial coefficients (e.g., 0th–2nd order).:: + + + fluid0.radiation.absorption.model = gray-poly + fluid0.radiation.absorption.T_range = 300. 2400. + fluid0.radiation.absorption.polynomial_coeffs = 32.2454, 4.057e-3, -3.89e-6 + +**Example: Three piecewise constants** + +The absorption coefficient is defined using multiple temperature segments. Providing three temperatures +defines two piecewise regions. Because each region is specified with a single coefficient, the +absorption coefficient is constant within each segment.:: + + fluid0.radiation.absorption.model = gray-poly + fluid0.radiation.absorption.T_range = 300. 600. 1200. + fluid0.radiation.absorption.polynomial_coeffs = 1. + fluid0.radiation.absorption.polynomial_coeffs = 0.1 + fluid0.radiation.absorption.polynomial_coeffs = 0.01 + + +Gray WSGG +^^^^^^^^^ + +The following inputs are defined using the prefix ``[fluid_name].radiation.absorption``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| pressure-path_length | The pressure path length product ``PS``. This term includes | Real | None | +| | partial pressure of the absorbing gases ``P`` and the path | | | +| | length of the gas ``S``. A value is required when the species | | | +| | equations are not solved. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| path_length | The path length of the gas, ``S``. A value is required when | Real | None | +| | the species are solved. It is combed with the total partial | | | +| | pressure of the real ``gases`` based on the local composition | | | +| | to compute the pressure path length product. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| gases | List of absorbing gas species. The total partial pressure | Strings | None | +| | based on the local composition ``P`` is computed from the | | | +| | listed species. One or more species must be listed if species | | | +| | equations are solved. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| T_range | Valid temperature range for the polynomial. If no temperature | Reals | None | +| | is provided, then the polynomial is assumed valid for all | | | +| | temperatures. Piecewise polynomials are defined by specify | | | +| | multiple ranges. For example, two piecewise polynomials can be | | | +| | specified by providing three temperatures: low, mid and high. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| coeffs | Weighted sum of grey gas coefficients. | Reals | None | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| polynomial_coeffs | Polynomial coefficient. Polynomials can be up to 5-th order, | Reals | None | +| | and a set of polynomial coefficients must be defined for | | | +| | each temperature range. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + +**Example: Weighted‑sum‑of‑gray‑gases model with five gray gases** + +Example inputs defining a weighted‑sum‑of‑gray‑gases (WSGG) model. Here, five gray gases are included in the +absorption‑coefficient model. This is not a complete input file, nor does it represent a real WSGG model. +Dummy values are provided for illustration only.:: + + fluid0.radiation.absorption.model = gray-wsgg + fluid0.radiation.absorption.T_range = 600. 2400. + fluid0.radiation.absorption.pressure-path_length = 2.0 + + fluid0.radiation.absorption.coeffs = 100. 10. 1. 0.1 0.01 + fluid0.radiation.absorption.polynomial_coeffs = 0.4068 -1.83E-04 8.68E-09 + fluid0.radiation.absorption.polynomial_coeffs = 0.3390 -1.53E-04 7.24E-09 + fluid0.radiation.absorption.polynomial_coeffs = 0.2712 -1.22E-04 5.79E-09 + fluid0.radiation.absorption.polynomial_coeffs = 0.2034 -9.16E-05 4.34E-09 + fluid0.radiation.absorption.polynomial_coeffs = 0.1356 -6.11E-05 2.89E-09 + + +Each polynomial_coeffs line corresponds to one gray gas and provides the polynomial coefficients +:math:`b_{n,i}` in the temperature‑dependent term :math:`\sum_i b_{n,i}T^{i-1}`. + + +**Example: Weighted‑sum‑of‑gray‑gases model with partial‑pressure path‑length** + +Example inputs defining a weighted‑sum‑of‑gray‑gases model using three gray gases. In this case, the +pressure path‑length product ``PS`` is computed from the partial pressures of real gases ``CO2`` and +``H2O``. As before, this is not a complete input file and does not represent a real WSGG dataset.:: + + species.solve = O2 H2O CO2 coal ash + fluid.species = CO2 H2O O2 + + fluid0.radiation.absorption.T_range = 600. 2400. + fluid0.radiation.absorption.path_length = 1.0 + fluid0.radiation.absorption.gases = CO2 H2O + fluid0.radiation.absorption.coeffs = 75., 5., 1. + fluid0.radiation.absorption.polynomial_coeffs = 0.6280, -1.69E-04, -8.78E-08, 2.22E-11 + fluid0.radiation.absorption.polynomial_coeffs = 0.3768, -1.01E-04, -5.27E-08, 1.33E-11 + fluid0.radiation.absorption.polynomial_coeffs = 0.2512, -6.75E-05, -3.51E-08, 8.90E-12 + +``coeffs`` supplies the gray‑gas absorption coefficients :math:`k_n`, and each ``polynomial_coeffs`` +line provides the :math:`b_{n,i}` for the corresponding gray gas. The specified gases (``CO2``, ``H2O``) +are used to compute the local partial‑pressure path‑length ``PS``. + + Newton solver ------------- -The following inputs are defined using the prefix ``fluid`` and control the convergence criteria +The following inputs are defined using the prefix ``fluid.newton_solver`` and control the convergence criteria of the damped Newton solver used to compute temperature from enthalpy and specific heat. -+------------------------------------------+----------------------------------------------------------+--------+----------+ -| | Description | Type | Default | -+==========================================+==========================================================+========+==========+ -| newton_solver.absolute_tol | Define absolute tolerance for the Newton solver | Real | 1.e-8 | -+------------------------------------------+----------------------------------------------------------+--------+----------+ -| newton_solver.relative_tol | Define relative tolerance for the Newton solver | Real | 1.e-8 | -+------------------------------------------+----------------------------------------------------------+--------+----------+ -| newton_solver.max_iterations | Define max number of iterations for the Newton solver | Int | 500 | -+------------------------------------------+----------------------------------------------------------+--------+----------+ ++----------------------------+----------------------------------------------------------+--------+----------+ +| | Description | Type | Default | ++============================+==========================================================+========+==========+ +| absolute_tol | Define absolute tolerance for the Newton solver | Real | 1.e-8 | ++----------------------------+----------------------------------------------------------+--------+----------+ +| relative_tol | Define relative tolerance for the Newton solver | Real | 1.e-8 | ++----------------------------+----------------------------------------------------------+--------+----------+ +| max_iterations | Define max number of iterations for the Newton solver | Int | 500 | ++----------------------------+----------------------------------------------------------+--------+----------+ diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index 03210a0..b14af5a 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -28,6 +28,8 @@ The following input is defined using the prefix ``mfix``: +--------------------------+----------------------------------------------------------------------------+----------+---------------------+ | advect_density | Enable time evolution of fluid density. | Int | 0 | +--------------------------+----------------------------------------------------------------------------+----------+---------------------+ +| enable.radiation | Enable the radiation solver. This solver must be built with RTE enabled. | Bool | false | ++--------------------------+----------------------------------------------------------------------------+----------+---------------------+ Fluid options diff --git a/docs/source_docs/user_guide/inputs/radiation_model.rst b/docs/source_docs/user_guide/inputs/radiation_model.rst new file mode 100644 index 0000000..621b294 --- /dev/null +++ b/docs/source_docs/user_guide/inputs/radiation_model.rst @@ -0,0 +1,172 @@ +.. sec:InputsRadiation: + +Radiation +========= + +.. warning:: + + * MFIX-Exa must be built with ``RTE`` enabled which requires ``hypre``. + +The following inputs are defined using the prefix ``radiation``: + ++----------------------+--------------------------------------------------------------------------+----------+---------+ +| Key | Description | Type | Default | ++======================+==========================================================================+==========+=========+ +| model | Radiation model. Optoins: | String | None | +| | | | | +| | * ``P1`` - Spherical Harmonics P1 approximation. | | | +| | * ``FV`` - Finite volume discretization of Radiation Transport Equation. | | | ++----------------------+--------------------------------------------------------------------------+----------+---------+ +| enable_scaling | Enable mean beam-legnth scaling. | Bool | false | ++----------------------+--------------------------------------------------------------------------+----------+---------+ +| update_int | Solve for the radiation intensity on the interval in time steps. | Int | None | +| | This input cannot be specified with ``radiation.update_per_approx``. | | | ++----------------------+--------------------------------------------------------------------------+----------+---------+ +| update_per_approx | Solve for the radiation intensity on the approximted lapsed time. | Int | None | +| | This input cannot be specified with ``radiation.update_int``. | | | ++----------------------+--------------------------------------------------------------------------+----------+---------+ + +RTE P1 solver +------------- + +The following inputs are defined using the prefix ``rte.P1``: + ++--------------------------+-----------------------------------------------------------------------+----------+---------+ +| Key | Description | Type | Default | ++==========================+=======================================================================+==========+=========+ +| A1 | Legendre coefficient for scattering phase function. | Real | 0. | +| | | | | ++--------------------------+-----------------------------------------------------------------------+----------+---------+ +| maxConvergeIter | Maximum allowed iterations to get a converged solution. | Int | 10 | ++--------------------------+-----------------------------------------------------------------------+----------+---------+ +| L2_convergence_tol | Convergence threshold on L2 norm of incident radiation (G). | Real | 1.0e-5 | ++--------------------------+-----------------------------------------------------------------------+----------+---------+ +| NOS_correction | Non-orthogonal and skewness correction on face fluxes. | Bool | false | ++--------------------------+-----------------------------------------------------------------------+----------+---------+ +| flux_redistribution | Redistribute the flux or not during the non-orthogonal corrections. | Bool | false | ++--------------------------+-----------------------------------------------------------------------+----------+---------+ +| LeastSquare_stencil_size | Stencil size for the least square regression. | Int | 3 | ++--------------------------+-----------------------------------------------------------------------+----------+---------+ + + +RTE FV solver +------------- + +The following inputs are defined using the prefix ``rte.fv``: + ++-----------------------------+--------------------------------------------------------------------+----------+---------+ +| Key | Description | Type | Default | ++=============================+====================================================================+==========+=========+ +| quadrature_resolution_theta | Specifying number of polar discretizations in each quadrature. | Int | None | ++-----------------------------+--------------------------------------------------------------------+----------+---------+ +| quadrature_resolution_phi | Specifying number of azimuthal discretizations in each quadrature. | Int | None | ++-----------------------------+--------------------------------------------------------------------+----------+---------+ +| maxConvergeIter | Maximum allowed iterations to get a converged solution. | Int | 10 | ++-----------------------------+--------------------------------------------------------------------+----------+---------+ +| explicit_correction | Deffered correction | Bool | false | ++-----------------------------+--------------------------------------------------------------------+----------+---------+ + + +Hypre settings +-------------- + +.. warning:: + + * These inputs are all case-sensitive. + +``hypre`` settings are specified using the following inputs which are read directly by the RTE library. +The following inputs are defined using the prefix ``rte.hypre``: + ++-------------------+-----------------------------------------------------------------------+----------+---------+ +| | Description | Type | Default | ++===================+=======================================================================+==========+=========+ +| preconditioner | Type of preconditioner. | String | None | +| | | | | +| | Options: | | | +| | | | | +| | * ``BoomerAMG`` | | | ++-------------------+-----------------------------------------------------------------------+----------+---------+ +| solver | Type of hypre solver. | String | None | +| | | | | +| | Options: | | | +| | | | | +| | * ``GMRES`` | | | +| | * ``BiCGSTAB`` | | | +| | * ``BoomerAMG`` | | | ++-------------------+-----------------------------------------------------------------------+----------+---------+ +| verbose | Verbosity of hypre. | Int | 0 | ++-------------------+-----------------------------------------------------------------------+----------+---------+ +| num_krylov | Number of iterations. | Int | 50 | ++-------------------+-----------------------------------------------------------------------+----------+---------+ +| convergence_tol | Convergence tolerance. | Real | 1.0e-4 | ++-------------------+-----------------------------------------------------------------------+----------+---------+ +| max_iterations | Maximum number of iterations. | Int | 1000 | ++-------------------+-----------------------------------------------------------------------+----------+---------+ + + +The following inputs are valid when using ``BoomerAMG`` as a preconditioner or solver. +They must be defined using the prefix ``rte.hypre``: + ++------------------------+------------------------------------------------------------------+----------+---------+ +| | Description | Type | Default | ++========================+==================================================================+==========+=========+ +| bamg_agg_interp_type | See ``HYPRE_BoomerAMGSetAggInterpType``. | Int | 4 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_agg_num_levels | See ``HYPRE_BoomerAMGSetAggNumLevels``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_agg_pmax_elmts | See ``HYPRE_BoomerAMGSetAggPMaxElmts``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_coarse_relax_type | See ``HYPRE_BoomerAMGSetCycleRelaxType``. | Int | 11 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_coarsen_type | See ``HYPRE_BoomerAMGSetCoarsenType``. | Int | 6 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_cycle_type | See ``HYPRE_BoomerAMGSetCycleType``. | Int | 1 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_down_relax_type | See ``HYPRE_BoomerAMGSetCycleRelaxType``. | Int | 11 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_interp_type | See ``HYPRE_BoomerAMGSetInterpType``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_keep_transpose | See ``HYPRE_BoomerAMGSetKeepTranspose``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_logging | See ``HYPRE_BoomerAMGSetLogging``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_max_coarse_size | See ``HYPRE_BoomerAMGSetMaxCoarseSize``. | Int | 9 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_max_iterations | See ``HYPRE_BoomerAMGSetMaxIter``. | Int | 1 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_max_levels | See ``HYPRE_BoomerAMGSetMaxLevels``. | Int | 20 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_min_coarse_size | See ``HYPRE_BoomerAMGSetMinCoarseSize``. | Int | 1 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_num_coarse_sweeps | See ``HYPRE_BoomerAMGSetCycleNumSweeps``. | Int | 1 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_num_down_sweeps | See ``HYPRE_BoomerAMGSetCycleNumSweeps``. | Int | 2 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_num_sweeps | See ``HYPRE_BoomerAMGSetNumSweeps``. | Int | 2 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_num_up_sweeps | See ``HYPRE_BoomerAMGSetCycleNumSweeps``. | Int | 2 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_pmax_elmts | See ``HYPRE_BoomerAMGSetPMaxElmts``. | Int | 4 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_precond_tolerance | See ``HYPRE_BoomerAMGSetTol``. | Real | 0.0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_relax_order | See ``HYPRE_BoomerAMGSetRelaxOrder``. | Int | 1 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_relax_type | See ``HYPRE_BoomerAMGSetRelaxType``. | Int | 6 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_set_restriction | See ``HYPRE_BoomerAMGSetRestriction``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_strong_threshold | See ``HYPRE_BoomerAMGSetStrongThreshold``. | Real | 0.57 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_trunc_factor | See ``HYPRE_BoomerAMGSetTruncFactor``. | Real | 0.1 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_up_relax_type | See ``HYPRE_BoomerAMGSetCycleRelaxType``. | Int | 11 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_variant | See ``HYPRE_BoomerAMGSetVariant``. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ +| bamg_verbose | Set ``BoomerAMG`` verbosity. | Int | 0 | ++------------------------+------------------------------------------------------------------+----------+---------+ + +.. note:: + + This list is likely incomplete because the AMReX / `hypre` interface continues to evolve. diff --git a/docs/source_docs/user_guide/inputs/solids_model.rst b/docs/source_docs/user_guide/inputs/solids_model.rst index c76dda0..9e361ff 100644 --- a/docs/source_docs/user_guide/inputs/solids_model.rst +++ b/docs/source_docs/user_guide/inputs/solids_model.rst @@ -165,6 +165,70 @@ The following inputs are defined with the prefix ``solids``: +-----------------------+--------------------------------------------------------------+----------+----------+ +Radiation +^^^^^^^^^ + +The following inputs are defined using the prefix ``[solid_name].radiation``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| scattering_factor | Particle scattering factor. | Real | None | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| emissivity.model | Specify which radiation emissivity coefficient model to use | String | None | +| | for the solid. Options: | | | +| | | | | +| | * ``gray-poly`` - Emissivity is defined by a | | | +| | temperature-dependent polynomial (0-5th order). Piecewise | | | +| | polynomials are defined by specifying temperature ranges. | | | +| | | | | +| | An emissivity model is required if radiation is enabled. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + + +Gray polynomial + +.. |gray_poly_of_T_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 T + a_2 T^2 + \ldots` +.. |gray_poly_of_invT_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 / T + a_2 / T^2 + \ldots` + + +The following inputs are defined using the prefix ``[solid_name].radiation.emissivity``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| form | Specifies the polynomial form used to represent the absorption | Int | 0 | +| | coefficient as a function of temperature. Options: | | | +| | | | | +| | * ``0`` - Absorption coefficient is defined as a polynomial | | | +| | in temperature. | | | +| | | | | +| | |gray_poly_of_T_Eq| | | | +| | | | | +| | * ``1`` - Absorption coefficient is defined as a polynomial | | | +| | in the inverse of temperature. | | | +| | | | | +| | |gray_poly_of_invT_Eq| | | | +| | | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| T_range | Valid temperature range for the polynomial. If no temperature | Reals | None | +| | is provided, then the polynomial is assumed valid for all | | | +| | temperatures. Piecewise polynomials are defined by specify | | | +| | multiple ranges. For example, two piecewise polynomials can be | | | +| | specified by providing three temperatures: low, mid and high. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| polynomial_coeffs | Polynomial coefficient. Polynomials can be up to 5-th order, | Reals | None | +| | and a set of polynomial coefficients must be defined for | | | +| | each temperature range. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + +**Example: Constant valued emissivity** + +A constant value is used over the entire valid temperature range.:: + + solid0.radiation.absorption.model = gray-poly + solid0.radiation.absorption.polynomial_coeffs = 0.9 + Density ------- diff --git a/docs/source_docs/user_guide/inputs/species.rst b/docs/source_docs/user_guide/inputs/species.rst index 0089db0..e4de6b8 100644 --- a/docs/source_docs/user_guide/inputs/species.rst +++ b/docs/source_docs/user_guide/inputs/species.rst @@ -196,6 +196,87 @@ The following inputs are defined for each species using the prefix ``species.[sp +------------------------+-------------------------------------------------------------------------+----------+-----------+ +Radiation +--------- + +.. |gray_poly_of_T_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 T + a_2 T^2 + \ldots` +.. |gray_poly_of_invT_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 / T + a_2 / T^2 + \ldots` + +The following inputs are defined using the prefix ``species.radiation``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| scattering_coeff | | Real | None | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| absorption.model | Specify which radiation absorption coefficient model to use | String | None | +| | for fluid species. This setting only applies when | | | +| | ``[fluid_name].radiation.absorption.model = mixture``. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``gray-poly`` - The absorption coefficient is defined by a | | | +| | temperature-dependent polynomial (0-5th order). Piecewise | | | +| | polynomials are defined by specifying temperature ranges. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + + +The following inputs are defined using the prefix ``species.[species_name].radiation.absorption``. + ++-----------------------+----------------------------------------------------------------+---------+----------+ +| | Description | Type | Default | ++=======================+================================================================+=========+==========+ +| form | Specifies the polynomial form used to represent the absorption | Int | 0 | +| | coefficient as a function of temperature. Options: | | | +| | | | | +| | * ``0`` - Absorption coefficient is defined as a polynomial | | | +| | in temperature. | | | +| | | | | +| | |gray_poly_of_T_Eq| | | | +| | | | | +| | * ``1`` - Absorption coefficient is defined as a polynomial | | | +| | in the inverse of temperature. | | | +| | | | | +| | |gray_poly_of_invT_Eq| | | | +| | | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| T_range | Valid temperature range for the polynomial. If no temperature | Reals | None | +| | is provided, then the polynomial is assumed valid for all | | | +| | temperatures. Piecewise polynomials are defined by specify | | | +| | multiple ranges. For example, two piecewise polynomials can be | | | +| | specified by providing three temperatures: low, mid and high. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ +| polynomial_coeffs | Polynomial coefficient. Polynomials can be up to 5-th order, | Reals | None | +| | and a set of polynomial coefficients must be defined for | | | +| | each temperature range. | | | ++-----------------------+----------------------------------------------------------------+---------+----------+ + + +**Example: Define absorption coefficients for individual species using polynomial forms.** + +* CO2 uses a single polynomial over the entire temperature range. +* H2O uses piecewise polynomials, each constant within its temperature interval. +* Once species absorption models are defined, the fluid absorption model is set to mixture to combine species contributions.:: + + species.solve = O2 H2O CO2 NA1 NA2 + + species.radiation.absorption.model = gray-poly + + species.CO2.radiation.absorption.T_range = 300. 2400. + species.CO2.radiation.absorption.polynomial_coeffs = 32.2454, 4.057e-3, -3.89e-6 + + species.H2O.radiation.absorption.T_range = 300. 600. 1800. + species.H2O.radiation.absorption.polynomial_coeffs = 1. + species.H2O.radiation.absorption.polynomial_coeffs = 0.1 + species.H2O.radiation.absorption.polynomial_coeffs = 0.01 + + species.H2O.radiation.absorption.polynomial_coeffs = 0. + + fluid.species = CO2 H2O O2 + fluid0.radiation.absorption.model = mixture + + + Density ------- diff --git a/docs/source_docs/user_guide/run-time_inputs.rst b/docs/source_docs/user_guide/run-time_inputs.rst index 96209b7..aa81ec4 100644 --- a/docs/source_docs/user_guide/run-time_inputs.rst +++ b/docs/source_docs/user_guide/run-time_inputs.rst @@ -50,6 +50,7 @@ keywords such as ``mfix``, ``amr``, ``geometry``, ``nodal_proj`` etc. inputs/boundary_conditions inputs/chemical_reactions inputs/porous_media + inputs/radiation_model inputs/output inputs/initialization inputs/time_stepping -- GitLab From a54dac9fa4ede0ac6ad611f4b5ac2252575bc9ad Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Wed, 13 May 2026 14:39:29 -0400 Subject: [PATCH 02/14] Add fluid scattering coeffient --- docs/source_docs/user_guide/inputs/fluid_model.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 0a5a664..8e54ddc 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -351,7 +351,7 @@ The following inputs are defined using the prefix ``[fluid_name].radiation``. +-----------------------+----------------------------------------------------------------+---------+----------+ | | Description | Type | Default | +=======================+================================================================+=========+==========+ -| scattering_coeff | | Real | None | +| scattering_coeff | Scattering coefficient of the fluid. | Real | None | +-----------------------+----------------------------------------------------------------+---------+----------+ | absorption.model | Specify which radiation absorption coefficient model to use | String | None | | | for the fluid. Options: | | | -- GitLab From fa3ead60f602f273545191f70fcd9fa1024ecb4c Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Wed, 13 May 2026 14:45:07 -0400 Subject: [PATCH 03/14] Fix build warnings --- docs/source_docs/user_guide/inputs/boundary_conditions.rst | 2 +- docs/source_docs/user_guide/inputs/radiation_model.rst | 4 ++-- docs/source_docs/user_guide/inputs/solids_model.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 351b426..01040b6 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -452,7 +452,7 @@ Below is an example for specifying a constant temperature boundary condition in Radiation -^^^^^^^^^ +~~~~~~~~~ .. |gray_poly_of_T_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 T + a_2 T^2 + \ldots` .. |gray_poly_of_invT_Eq| replace:: :math:`\displaystyle a(T) = a_0 + a_1 / T + a_2 / T^2 + \ldots` diff --git a/docs/source_docs/user_guide/inputs/radiation_model.rst b/docs/source_docs/user_guide/inputs/radiation_model.rst index 621b294..57cc417 100644 --- a/docs/source_docs/user_guide/inputs/radiation_model.rst +++ b/docs/source_docs/user_guide/inputs/radiation_model.rst @@ -12,7 +12,7 @@ The following inputs are defined using the prefix ``radiation``: +----------------------+--------------------------------------------------------------------------+----------+---------+ | Key | Description | Type | Default | +======================+==========================================================================+==========+=========+ -| model | Radiation model. Optoins: | String | None | +| model | Radiation model. Options: | String | None | | | | | | | | * ``P1`` - Spherical Harmonics P1 approximation. | | | | | * ``FV`` - Finite volume discretization of Radiation Transport Equation. | | | @@ -63,7 +63,7 @@ The following inputs are defined using the prefix ``rte.fv``: +-----------------------------+--------------------------------------------------------------------+----------+---------+ | maxConvergeIter | Maximum allowed iterations to get a converged solution. | Int | 10 | +-----------------------------+--------------------------------------------------------------------+----------+---------+ -| explicit_correction | Deffered correction | Bool | false | +| explicit_correction | Deferred correction | Bool | false | +-----------------------------+--------------------------------------------------------------------+----------+---------+ diff --git a/docs/source_docs/user_guide/inputs/solids_model.rst b/docs/source_docs/user_guide/inputs/solids_model.rst index 9e361ff..7c40f4d 100644 --- a/docs/source_docs/user_guide/inputs/solids_model.rst +++ b/docs/source_docs/user_guide/inputs/solids_model.rst @@ -166,7 +166,7 @@ The following inputs are defined with the prefix ``solids``: Radiation -^^^^^^^^^ +--------- The following inputs are defined using the prefix ``[solid_name].radiation``. -- GitLab From fc36e44e505f97e2bd0b75fa7516a0e76ed6daf7 Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Thu, 14 May 2026 08:59:57 -0400 Subject: [PATCH 04/14] Clean up stray period --- docs/source_docs/user_guide/inputs/boundary_conditions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 01040b6..1fd210b 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -466,7 +466,7 @@ The following inputs defined using the prefix ``bc.[region_name].eb.radiation.em +-----------------------+----------------------------------------------------------------+---------+----------+ | | Description | Type | Default | +=======================+================================================================+=========+==========+ -| model. | Specify which radiation emissivity coefficient model to use | String | None | +| model | Specify which radiation emissivity coefficient model to use | String | None | | | for the embedded boundaries. Options: | | | | | | | | | | * ``gray-poly`` - Emissivity is defined by a | | | -- GitLab From 7b3eb8929bcb32ee3173e764262d50f2bbab13ba Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:04:55 -0500 Subject: [PATCH 05/14] quoting --- docs/source_docs/user_guide/inputs/boundary_conditions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 1fd210b..3ba1a33 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -63,7 +63,7 @@ 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 | +| 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 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -- GitLab From 914c681e96fa7dc96548ae1a91b43f3248f6fc16 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:05:28 -0500 Subject: [PATCH 06/14] grey->gray --- docs/source_docs/user_guide/inputs/fluid_model.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 8e54ddc..3ea40c3 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -360,10 +360,10 @@ The following inputs are defined using the prefix ``[fluid_name].radiation``. | | temperature-dependent polynomial (0-5th order). Piecewise | | | | | polynomials are defined by specifying temperature ranges. | | | | | | | | -| | * ``gray-wsgg`` - Weighted sum of grey-gases model. For each | | | +| | * ``gray-wsgg`` - Weighted sum of gray-gases model. For each | | | | | gray gas *n*, a gas‑specific absorption coefficient | | | | | :math:`k_n` is provided along with a set of polynomial | | | -| | coefficients, :math:`b_{n,i}` (0th-5th order). | | | +| | coefficients :math:`b_{n,i}` (0th-5th order). | | | | | | | | | | |gray_wsgg_Eq| | | | | | | | | -- GitLab From 4fab0e8db3822dbd02daef126306abaf8c1b4854 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:05:39 -0500 Subject: [PATCH 07/14] equation --- docs/source_docs/user_guide/inputs/fluid_model.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 3ea40c3..27e782d 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -344,7 +344,7 @@ The following inputs are defined using the prefix ``[fluid_name].thermal_conduct Radiation --------- -.. |gray_wsgg_Eq| replace:: :math:`\displaystyle a(T) = \sum_n^N \left( [1-e^{-k_i PS}] \sum_i b_{n,i} T^{i-1} \right)` +.. |gray_wsgg_Eq| replace:: :math:`\displaystyle a(T) = \sum_n \left( [1-e^{-k_i PS}] \sum_i b_{n,i} T^i \right)` The following inputs are defined using the prefix ``[fluid_name].radiation``. -- GitLab From 4c579e500f448fa0ca9c41fa092aa651a4bed391 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:05:46 -0500 Subject: [PATCH 08/14] expand WSGG --- docs/source_docs/user_guide/inputs/fluid_model.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 27e782d..5f4edbb 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -434,8 +434,8 @@ absorption coefficient is constant within each segment.:: fluid0.radiation.absorption.polynomial_coeffs = 0.01 -Gray WSGG -^^^^^^^^^ +Gray WSGG (Weighted Sum of Gray Gases) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following inputs are defined using the prefix ``[fluid_name].radiation.absorption``. -- GitLab From 08e1693ce4c2a39f9a73b86a301af1d88a58c6dd Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:06:05 -0500 Subject: [PATCH 09/14] grey->gray --- docs/source_docs/user_guide/inputs/fluid_model.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 5f4edbb..d2ec0c4 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -463,17 +463,18 @@ The following inputs are defined using the prefix ``[fluid_name].radiation.absor | | multiple ranges. For example, two piecewise polynomials can be | | | | | specified by providing three temperatures: low, mid and high. | | | +-----------------------+----------------------------------------------------------------+---------+----------+ -| coeffs | Weighted sum of grey gas coefficients. | Reals | None | +| coeffs | Weighted sum of gray gas coefficients. | Reals | None | +-----------------------+----------------------------------------------------------------+---------+----------+ | polynomial_coeffs | Polynomial coefficient. Polynomials can be up to 5-th order, | Reals | None | | | and a set of polynomial coefficients must be defined for | | | | | each temperature range. | | | +-----------------------+----------------------------------------------------------------+---------+----------+ -**Example: Weighted‑sum‑of‑gray‑gases model with five gray gases** +**Example: WSGG model with five gray gases** + +Example inputs defining a WSGG model. Here, five gray gases are included in the absorption‑coefficient model. This +is not a complete input file, nor does it represent a real WSGG model. -Example inputs defining a weighted‑sum‑of‑gray‑gases (WSGG) model. Here, five gray gases are included in the -absorption‑coefficient model. This is not a complete input file, nor does it represent a real WSGG model. Dummy values are provided for illustration only.:: fluid0.radiation.absorption.model = gray-wsgg -- GitLab From 9d053132bda0e119ca1d2455c5fd906ad2cf4450 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:06:10 -0500 Subject: [PATCH 10/14] use abbrev --- docs/source_docs/user_guide/inputs/fluid_model.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index d2ec0c4..8951d10 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -493,7 +493,7 @@ Each polynomial_coeffs line corresponds to one gray gas and provides the polynom :math:`b_{n,i}` in the temperature‑dependent term :math:`\sum_i b_{n,i}T^{i-1}`. -**Example: Weighted‑sum‑of‑gray‑gases model with partial‑pressure path‑length** +**Example: WSGG model with partial‑pressure path‑length** Example inputs defining a weighted‑sum‑of‑gray‑gases model using three gray gases. In this case, the pressure path‑length product ``PS`` is computed from the partial pressures of real gases ``CO2`` and -- GitLab From 8cc6ab19252bf9a139ffb2425cae02d0132f6b86 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:06:30 -0500 Subject: [PATCH 11/14] move enable.radiation --- docs/source_docs/user_guide/inputs/model_options.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index b14af5a..fe32454 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -22,14 +22,15 @@ The following input is defined using the prefix ``mfix``: +--------------------------+----------------------------------------------------------------------------+----------+---------------------+ | enable.solids | Enable the solids solver for DEM or PIC. | 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 | +--------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| enable.radiation | Enable the radiation solver. This solver must be built with RTE enabled. | Bool | false | -+--------------------------+----------------------------------------------------------------------------+----------+---------------------+ + Fluid options -- GitLab From 88240967b92831387eba3cbe31dc12a3c3f48c95 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:06:53 -0500 Subject: [PATCH 12/14] spelling --- docs/source_docs/user_guide/inputs/radiation_model.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/radiation_model.rst b/docs/source_docs/user_guide/inputs/radiation_model.rst index 57cc417..b1f8e0f 100644 --- a/docs/source_docs/user_guide/inputs/radiation_model.rst +++ b/docs/source_docs/user_guide/inputs/radiation_model.rst @@ -14,10 +14,11 @@ The following inputs are defined using the prefix ``radiation``: +======================+==========================================================================+==========+=========+ | model | Radiation model. Options: | String | None | | | | | | -| | * ``P1`` - Spherical Harmonics P1 approximation. | | | -| | * ``FV`` - Finite volume discretization of Radiation Transport Equation. | | | +| | * ``P1`` - :math:`\mathrm{P}_1` spherical-harmonics approximation. | | | +| | * ``FV`` - Finite-volume discretization of the radiation transport | | | +| | equation. | | | +----------------------+--------------------------------------------------------------------------+----------+---------+ -| enable_scaling | Enable mean beam-legnth scaling. | Bool | false | +| enable_scaling | Enable mean beam-length scaling. | Bool | false | +----------------------+--------------------------------------------------------------------------+----------+---------+ | update_int | Solve for the radiation intensity on the interval in time steps. | Int | None | | | This input cannot be specified with ``radiation.update_per_approx``. | | | -- GitLab From 0b6e9bf3ddbe3c8d6ead5fba08588d5ce8cfe27a Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:07:05 -0500 Subject: [PATCH 13/14] format subscript --- docs/source_docs/user_guide/inputs/radiation_model.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/radiation_model.rst b/docs/source_docs/user_guide/inputs/radiation_model.rst index b1f8e0f..7449ca0 100644 --- a/docs/source_docs/user_guide/inputs/radiation_model.rst +++ b/docs/source_docs/user_guide/inputs/radiation_model.rst @@ -27,8 +27,8 @@ The following inputs are defined using the prefix ``radiation``: | | This input cannot be specified with ``radiation.update_int``. | | | +----------------------+--------------------------------------------------------------------------+----------+---------+ -RTE P1 solver -------------- +RTE P\ :sub:`1` solver +---------------------- The following inputs are defined using the prefix ``rte.P1``: -- GitLab From 778b66cd3503c44c7d404f3e1c71a6fe16bb0fc4 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 3 Jun 2026 10:07:11 -0500 Subject: [PATCH 14/14] remove "specifying" --- docs/source_docs/user_guide/inputs/radiation_model.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/radiation_model.rst b/docs/source_docs/user_guide/inputs/radiation_model.rst index 7449ca0..92d051b 100644 --- a/docs/source_docs/user_guide/inputs/radiation_model.rst +++ b/docs/source_docs/user_guide/inputs/radiation_model.rst @@ -58,9 +58,9 @@ The following inputs are defined using the prefix ``rte.fv``: +-----------------------------+--------------------------------------------------------------------+----------+---------+ | Key | Description | Type | Default | +=============================+====================================================================+==========+=========+ -| quadrature_resolution_theta | Specifying number of polar discretizations in each quadrature. | Int | None | +| quadrature_resolution_theta | Number of polar discretizations in each quadrature. | Int | None | +-----------------------------+--------------------------------------------------------------------+----------+---------+ -| quadrature_resolution_phi | Specifying number of azimuthal discretizations in each quadrature. | Int | None | +| quadrature_resolution_phi | Number of azimuthal discretizations in each quadrature. | Int | None | +-----------------------------+--------------------------------------------------------------------+----------+---------+ | maxConvergeIter | Maximum allowed iterations to get a converged solution. | Int | 10 | +-----------------------------+--------------------------------------------------------------------+----------+---------+ -- GitLab