Major reorg (!58) · Merge requests · exa / docs

docs/source_docs/fluids/FluidTimeDiscretization.rst

+1 −1

Changes for docs/source_docs/fluids/FluidTimeDiscretization.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -4,7 +4,7 @@ Time Discretization


		.. toctree::
		:maxdepth: 1
		:maxdepth: 0

		FluidTimeStep
		Slopes

docs/source_docs/inputs/InputsDiscretization.rst

deleted100644 → 0

+0 −42

Changes for docs/source_docs/inputs/InputsDiscretization.rst: 0 added lines, 42 removed lines.
Original line number	Diff line number	Diff line
		.. sec:InputsDiscretization:

		Discretization
		==============

		The following inputs must be preceded by "mfix."

		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| Key \| Description \| Type \| Default \|
		+=================================+=======================================================================+=============+==============+
		\| advection_type \| Predictor-Corrector Method of Lines ("mol") or Godunov ("godunov") \| String \| Godunov \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| redistribution_type \| Use flux ("FluxRedist"), state ("StateRedist") or no ("NoRedist") \| \| \|
		\| \| redistribution \| String \| StateRedist \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| redistribute_before_nodal_proj \| Redistribute the velocity field before the nodal projection \| Bool \| True \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| redistribute_nodal_proj \| Redistribute the velocity field after the nodal projection \| Bool \| False \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| use_drag_coeff_in_proj_gp \| Algebraically consistent p coeff in proj or (default) simplified form \| Bool \| False \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| use_drag_in_godunov \| Include a drag term in the Godunov flux or (default) not \| Bool \| False \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| correction_small_volfrac \| Threshold volume fraction for correcting small cell velocity \| \| \|
		\| \| at the end of the predictor and corrector \| Real \| 1.e-4 \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| deposition_redist_type \| Redistribute excess solids using max packing ("MaxPack") or state \| \| \|
		\| \| ("StateRedist") algorithms. \| String \| MaxPack \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| deposition_redist_vfrac \| The threshold cell volume fraction when using "StateRedist" \| \| \|
		\| \| for deposition redistribution. \| Real \| 0.1 \|
		+---------------------------------+-----------------------------------------------------------------------+-------------+--------------+

		Notes: The code was originally developed with MOL and FluxRedist. Preliminary
		tests show that the new single-step Godunov method is roughly twice as fast as
		the predictor-corrector MOL at the same time step (e.g., CFL limited to 0.5).
		Further, the Godunov method allows for roughly twice the time step, CFL should
		be limited to 0.9 for stability. Finally, it is recommended that the Godunov
		method be used in conjunction with StateRedist. While not fully vetted, early
		tests also show increased stability in complex geometries for a StateRedist-
		Godunov scheme compared to the previous FluxRedist-MOL scheme.

docs/source_docs/inputs/InputsHypre.rst

deleted100644 → 0

+0 −83

Changes for docs/source_docs/inputs/InputsHypre.rst: 0 added lines, 83 removed lines.
Original line number	Diff line number	Diff line
		.. _Chap:InputsHypre:

		Hypre Inputs
		=============

		The following inputs control the hypre settings and are read directly
		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: By default, the MAC and nodal projections use the same settings
		specified with the namespace :cpp:`hypre`, however the solvers can be configured
		separately by specifying :cpp:`mac_proj.hypre_namespace` and :cpp:`nodal_proj.hypre_namespace`.

		When not using the default namespace :cpp:`hypre`, additional restrictions apply:

		#. Both :cpp:`mac_proj.hypre_namespace` and :cpp:`nodal_proj.hypre_namespace` must be set.

		#. :cpp:`mac_proj.hypre_namespace` and :cpp:`nodal_proj.hypre_namespace` must be unique.


		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| \| Description \| Type \| Default \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| verbose \| Verbosity of hypre \| Int \| 0 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| adjust_singular_matrix \| Should be true if the problem to be solved has singular matrix \| Bool \| false \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| hypre_solver \| Type of hypre solver \| String \| BoomerAMG \|
		\| \| \| \| \|
		\| \| Options are BoomerAMG, GMRES, COGMRES, LGMRES, FlexGMRES, BiCGSTAB, \| \| \|
		\| \| PCG or Hybrid \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| hypre_preconditioner \| Type of preconditioner \| String \| none \|
		\| \| \| \| \|
		\| \| Options are BoomerAMG or euclid \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| recompute_preconditioner \| Recompute preconditioner during runs \| Bool \| true \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| write_matrix_files \| Write out matrix into text files \| Bool \| false \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| overwrite_existing_matrix_files \| Over-write existing matrix files \| Bool \| false \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_verbose \| Verbosity of BoomerAMG preconditioner \| Int \| 0 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_logging \| When using BoomerAMG preconditioner \| Int \| 0 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetLogging \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_coarsen_type \| When using BoomerAMG preconditioner \| Int \| 6 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetCoarsenType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_cycle_type \| When using BoomerAMG preconditioner \| Int \| 1 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetCycleType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_relax_type \| When using BoomerAMG preconditioner \| Int \| 6 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetRelaxType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_relax_order \| When using BoomerAMG preconditioner \| Int \| 1 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetRelaxOrder \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_sweeps \| When using BoomerAMG preconditioner \| Int \| 2 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetNumSweeps \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_max_levels \| When using BoomerAMG preconditioner \| Int \| 20 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetMaxLevels \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_strong_threshold \| When using BoomerAMG preconditioner \| Real \| 0.57 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetStrongThreshold \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_interp_type \| When using BoomerAMG preconditioner \| Int \| 0 \|
		\| \| \| \| \|
		\| \| HYPRE_BoomerAMGSetInterpType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+

docs/source_docs/inputs/InputsVerbosity.rst

deleted100644 → 0

+0 −15

Changes for docs/source_docs/inputs/InputsVerbosity.rst: 0 added lines, 15 removed lines.
Original line number	Diff line number	Diff line
		.. _Chap:InputsVerbosity:

		Verbosity
		=========

		The following inputs must be preceded by "mfix."

		+----------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| \| Description \| Type \| Default \|
		+======================+=======================================================================+=============+==============+
		\| verbose \| Verbosity in MFIX-Exa routines \| Int \| 0 \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| ooo_debug \| If true then print the name of the routine we are in \| Bool \| False \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+

docs/source_docs/qb/index.rst

+1 −1

Changes for docs/source_docs/qb/index.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -17,7 +17,7 @@ can be seen in the


		.. toctree::
		:maxdepth: 1
		:maxdepth: 0

		hcs
		granRT

Original line number	Diff line number	Diff line
		.. _Chap:InputsHypre:

		Hypre Inputs
		=============

		The following inputs control the hypre settings and are read directly
		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: By default, the MAC and nodal projections use the same settings
		specified with the namespace :cpp:`hypre`, however the solvers can be configured
		separately by specifying :cpp:`mac_proj.hypre_namespace` and :cpp:`nodal_proj.hypre_namespace`.

		When not using the default namespace :cpp:`hypre`, additional restrictions apply:

		#. Both :cpp:`mac_proj.hypre_namespace` and :cpp:`nodal_proj.hypre_namespace` must be set.

		#. :cpp:`mac_proj.hypre_namespace` and :cpp:`nodal_proj.hypre_namespace` must be unique.


		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| \| Description \| Type \| Default \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| verbose \| Verbosity of hypre \| Int \| 0 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| adjust_singular_matrix \| Should be true if the problem to be solved has singular matrix \| Bool \| false \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| hypre_solver \| Type of hypre solver \| String \| BoomerAMG \|
		\| \| \| \| \|
		\| \| Options are BoomerAMG, GMRES, COGMRES, LGMRES, FlexGMRES, BiCGSTAB, \| \| \|
		\| \| PCG or Hybrid \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| hypre_preconditioner \| Type of preconditioner \| String \| none \|
		\| \| \| \| \|
		\| \| Options are BoomerAMG or euclid \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| recompute_preconditioner \| Recompute preconditioner during runs \| Bool \| true \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| write_matrix_files \| Write out matrix into text files \| Bool \| false \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| overwrite_existing_matrix_files \| Over-write existing matrix files \| Bool \| false \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_verbose \| Verbosity of BoomerAMG preconditioner \| Int \| 0 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_logging \| When using BoomerAMG preconditioner \| Int \| 0 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetLogging \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_coarsen_type \| When using BoomerAMG preconditioner \| Int \| 6 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetCoarsenType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_cycle_type \| When using BoomerAMG preconditioner \| Int \| 1 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetCycleType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_relax_type \| When using BoomerAMG preconditioner \| Int \| 6 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetRelaxType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_relax_order \| When using BoomerAMG preconditioner \| Int \| 1 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetRelaxOrder \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_sweeps \| When using BoomerAMG preconditioner \| Int \| 2 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetNumSweeps \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_max_levels \| When using BoomerAMG preconditioner \| Int \| 20 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetMaxLevels \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_strong_threshold \| When using BoomerAMG preconditioner \| Real \| 0.57 \|
		\| \| \| \| \|
		\| \| See HYPRE_BoomerAMGSetStrongThreshold \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_interp_type \| When using BoomerAMG preconditioner \| Int \| 0 \|
		\| \| \| \| \|
		\| \| HYPRE_BoomerAMGSetInterpType \| \| \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+

Major reorg

Merge request reports