diff --git a/docs/source/InputsMultigrid.rst b/docs/source/InputsMultigrid.rst index a43a9a91a7e247d606c4b97158754a97598d1efd..5e741a4a776ff405552c975384c58eface992374 100644 --- a/docs/source/InputsMultigrid.rst +++ b/docs/source/InputsMultigrid.rst @@ -9,78 +9,77 @@ different solvers called by MFiX-Exa. NOTE: the nodal solver settings are read in directly by AMReX, the MAC and diffusion settings by MFiX. -These control the nodal projection and must be preceded by "projection": +These control the nodal projection and must be preceded by "nodal_proj": +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_verbose | Verbosity of multigrid solver in nodal projection | Int | 0 | +| verbose | Verbosity of multigrid solver in nodal projection | Int | 0 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_cg_verbose | Verbosity of BiCGStab solver in nodal projection | Int | 0 | +| bottom_verbose | Verbosity of BiCGStab solver in nodal projection | Int | 0 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_rtol | Relative tolerance in nodal projection | Real | 1.e-11 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_atol | Absolute tolerance in nodal projection | Real | 1.e-14 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_maxiter | Maximum number of iterations in the nodal projection | Int | 100 | +| maxiter | Maximum number of iterations in the nodal projection | Int | 100 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_cg_maxiter | Maximum number of iterations in the nodal projection | Int | 100 | +| bottom_maxiter | Maximum number of iterations in the nodal projection | Int | 100 | | | bottom solver if using bicg, cg, bicgcg or cgbicg | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_max_coarsening_level | Maximum number of coarser levels to allowin the nodal projection | Int | 100 | | | If set to 0, the bottom solver will be called at the current level | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| bottom_solver_type | Which bottom solver to use in the nodal projection | String | bicgcg | +| bottom_solver | Which bottom solver to use in the nodal projection | String | bicgcg | | | Options are bicgcg, bicgstab, cg, cgbicg, smoother or hypre | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -These control the MAC projection and must be preceded by "mac": +These control the MAC projection and must be preceded by "mac_proj": +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +=========================+=======================================================================+=============+==============+ -| mg_verbose | Verbosity of multigrid solver in MAC projection | Int | 0 | +| verbose | Verbosity of multigrid solver in MAC projection | Int | 0 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_cg_verbose | Verbosity of BiCGStab solver in MAC projection | Int | 0 | +| bottom_verbose | Verbosity of BiCGStab solver in MAC projection | Int | 0 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_rtol | Relative tolerance in MAC projection | Real | 1.e-11 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_atol | Absolute tolerance in MAC projection | Real | 1.e-14 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_maxiter | Maximum number of iterations in the MAC projection | Int | 200 | +| maxiter | Maximum number of iterations in the MAC projection | Int | 200 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_cg_maxiter | Maximum number of iterations in the MAC projection | Int | 200 | +| bottom_maxiter | Maximum number of iterations in the MAC projection | Int | 200 | | | bottom solver if using bicg, cg, bicgcg or cgbicg | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_max_coarsening_level | Maximum number of coarser levels to allow in the MAC projection | Int | 100 | | | If set to 0, the bottom solver will be called at the current level | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| bottom_solver_type | Which bottom solver to use in the MAC projection | String | bicgcg | +| bottom_solver | Which bottom solver to use in the MAC projection | String | bicgcg | | | Options are bicgcg, bicgstab, cg, cgbicg, smoother or hypre | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -These control the diffusion solver and must be preceded by "diff": -The following inputs must be preceded by "diff" +These control the diffusion solver and must be preceded by "diffusion": +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +=========================+=======================================================================+=============+==============+ -| mg_verbose | Verbosity of linear solver for diffusion solve | Int | 0 | +| verbose | Verbosity of linear solver for diffusion solve | Int | 0 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_cg_verbose | Verbosity of BiCGStab solver in diffusion solve | Int | 0 | +| bottom_verbose | Verbosity of BiCGStab solver in diffusion solve | Int | 0 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_rtol | Relative tolerance in diffusion solve | Real | 1.e-11 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_atol | Absolute tolerance in diffusion solve | Real | 1.e-14 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_maxiter | Maximum number of iterations in diffusion solve | Int | 100 | +| maxiter | Maximum number of iterations in diffusion solve | Int | 100 | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| mg_cg_maxiter | Maximum number of iterations in diffusion solve | Int | 100 | +| bottom_maxiter | Maximum number of iterations in diffusion solve | Int | 100 | | | bottom solver if using bicg, cg, bicgcg or cgbicg | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | mg_max_coarsening_level | Maximum number of coarser levels to allow in diffusion solve | Int | 100 | | | If set to 0, the bottom solver will be called at the current level | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| bottom_solver_type | Which bottom solver to use in the diffusion solve | String | bicgcg | +| bottom_solver | Which bottom solver to use in the diffusion solve | String | bicgcg | | | Options are bicgcg, bicgstab, cg, cgbicg, smoother or hypre | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+