diff --git a/docs/source/inputs/InputsHypre.rst b/docs/source/inputs/InputsHypre.rst index c7269f4e0decc58ff0d81d94d3900b8908592846..0cf6365b69fa1a2032ab663657bc318804f8f9ec 100644 --- a/docs/source/inputs/InputsHypre.rst +++ b/docs/source/inputs/InputsHypre.rst @@ -4,13 +4,20 @@ Hypre Inputs ============= The following inputs control the hypre settings and are read directly -by AMReX when we use hypre as the bottom solver. +by AMReX when we use hypre as the bottom solver, i.e., when +:cpp:`nodal_proj.bottom_solver = hypre` and/or when + :cpp:`mac_proj.bottom_solver = hypre` (see :ref:`Chap:InputsMultigrid`) +These settings must be preceded by the hypre_namespace setting corresponding +to the solver (see :ref:`Chap:InputsMultigrid`). -NOTE: Default uses the same hypre namespace "hypre" for all solvers. However, -the hypre namespace can be set at the solver level and the hypre settings -can be configured for each MLMG solver. +NOTE: If either the :cpp:`nodal_proj` or :cpp:`mac_proj` bottom solvers are +set to :cpp:`hypre`, the default behavior is to set the `hypre_namespace = "hypre"`. +In that case, the settings below should be preceded by the (default) hypre namespace, +:cpp:`hypre`, and apply to either or all solvers which use hypre. However, +the hypre namespace can be set at the solver level so that the hypre settings +can be configured for each MLMG solver. In which case, the settings below should be +preceded by the solver specific :cpp:`hypre_namespace`. -These settings must be preceded by the hypre_namespace setting corresponding to the solver (see :ref:`Chap:InputsMultigrid`) +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | diff --git a/docs/source/inputs/InputsMultigrid.rst b/docs/source/inputs/InputsMultigrid.rst index d88f0926c39a36d10ccff8a2619e06eef5533283..3a1218850fb967df23e85fe905692d5e3392d63f 100644 --- a/docs/source/inputs/InputsMultigrid.rst +++ b/docs/source/inputs/InputsMultigrid.rst @@ -75,6 +75,9 @@ These control the MAC projection and must be preceded by "mac_proj": | | Options are ij, semi_structured or structured | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ +NOTE: If the :cpp:`nodal_proj` and :cpp:`mac_proj` :cpp:`hypre_namespace`'s are set, they must be distinct unless set to +:cpp:`hypre`, in which case the default behavior is recovered in which case hypre settings apply to all solvers. + These control the diffusion solver and must be preceded by "diffusion": +-------------------------+-----------------------------------------------------------------------+-------------+--------------+