add "_name" to [region], [species] etc (!141) · Merge requests · exa / docs

docs/source_docs/user_guide/inputs/output/monitors.rst

+74 −74

File changed.

Preview size limit exceeded, changes collapsed.

docs/source_docs/user_guide/inputs/output/plotting.rst

+48 −48

Changes for docs/source_docs/user_guide/inputs/output/plotting.rst: 48 added lines, 48 removed lines.
Original line number	Diff line number	Diff line
		@@ -118,55 +118,55 @@ The following inputs must be preceded by the prefix ``mfix.solids`` and allow to
		contain only solids variables in specific regions at fixed timesteps or approximated simulation times.
		All these parameters are user-defined.

		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		+===========================+=================================================================+=============+===========+
		\| regions \| Specify regions that will be used for plotfiles \| String \| \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region] \| Specify which solids phases will be plotted \| String \| \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plot_int \| Specify timestep frequency for plotting the file \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plot_per_approx \| Specify time interval frequency for plotting the file \| Real \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_regtest \| Plot all variables (overrides all other plot flags) \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_cp_s \| Plot particle specific heat coefficient \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_drag_p \| Plot particle drag force \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_h_s_txfr \| Plot particle interphase enthalpy transfer \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_mass \| Plot particle mass \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_mass_sn_txfr \| Plot particle interphase mass transfer \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_omega_p \| Plot particle angular velocity \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_omoi \| Plot inverse of particle momentum of inertia \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_phase \| Plot particle phase \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_radius \| Plot particle radius \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_ro_p \| Plot particle density \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_state \| Plot particle state \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_statwt \| Plot particle statistical weight \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_T_p \| Plot particle temperature \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_vel_p \| Plot particle velocity \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_vel_s_txfr \| Plot particle interphase velocity transfer \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_volume \| Plot particle volume \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region].plt_X_s \| Plot particle species mass fractions \| Int \| 0 \|
		+---------------------------+-----------------------------------------------------------------+-------------+-----------+

		For each region with name [region] specified in the inputs, it will be saved a plotfile with name "partsXXXXX_[region]", where XXXXX stands for the timestep number.
		+================================+=================================================================+=============+===========+
		\| regions \| Specify regions that will be used for plotfiles \| Strings \| \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name] \| Specify which solids phases will be plotted \| String \| \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plot_int \| Specify timestep frequency for plotting the file \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plot_per_approx \| Specify time interval frequency for plotting the file \| Real \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_regtest \| Plot all variables (overrides all other plot flags) \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_cp_s \| Plot particle specific heat coefficient \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_drag_p \| Plot particle drag force \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_h_s_txfr \| Plot particle interphase enthalpy transfer \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_mass \| Plot particle mass \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_mass_sn_txfr \| Plot particle interphase mass transfer \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_omega_p \| Plot particle angular velocity \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_omoi \| Plot inverse of particle momentum of inertia \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_phase \| Plot particle phase \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_radius \| Plot particle radius \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_ro_p \| Plot particle density \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_state \| Plot particle state \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_statwt \| Plot particle statistical weight \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_T_p \| Plot particle temperature \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_vel_p \| Plot particle velocity \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_vel_s_txfr \| Plot particle interphase velocity transfer \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_volume \| Plot particle volume \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+
		\| [region_name].plt_X_s \| Plot particle species mass fractions \| Int \| 0 \|
		+--------------------------------+-----------------------------------------------------------------+-------------+-----------+

		For each region with name [region_name] specified in the inputs, it will be saved a plotfile with name "partsXXXXX_[region_name]", where XXXXX stands for the timestep number.


		Below is an example for specifying the inputs to plot solids data in a given

docs/source_docs/user_guide/inputs/output/reports.rst

+1 −1

Changes for docs/source_docs/user_guide/inputs/output/reports.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix.reports``:
		+--------------------+------------------------------------------------------+-------------+-----------+


		The following inputs are defined using the prefix ``mfix.reports.diameter.[report]``:
		The following inputs are defined using the prefix ``mfix.reports.diameter.[report_name]``:

		+--------------------+------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+6 −6

Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 6 added lines, 6 removed lines.
Original line number	Diff line number	Diff line
		@@ -27,7 +27,7 @@ The type of the boundary conditions in the BC region must be defined with the pr
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		+=====================+=======================================================================+=============+===========+
		\| [region] \| Specify boundary condition type. \| String \| None \|
		\| [region_name] \| Specify boundary condition type. \| String \| None \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		@@ -45,7 +45,7 @@ Fluid settings
		~~~~~~~~~~~~~~

		For each boundary condition region, the fluid inputs are defined
		using the prefix ``bc.[region].[fluid]``:
		using the prefix ``bc.[region_name].[fluid_name]``:


		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		@@ -68,8 +68,8 @@ using the prefix ``bc.[region].[fluid]``:
		\| massflow \| Mass flow rate [required if bc_region_type='mi' \| Real \| 0 \|
		\| \| and ``velocity`` or ``volflow`` not specified] \| \| \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| species.[species_name] \| Species 'species_name' mass fraction [required if solve_species=1 \| Real \| 0 \|
		\| \| and bc_region_type='mi' or 'pi']. \| \| \|
		\| species.[species_name] \| Species `species_name` mass fraction [required if `solve_species`=1 \| Real \| 0 \|
		\| \| and `bc_region_type`=`mi` or `pi`]. \| \| \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+

		Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified.
		@@ -135,7 +135,7 @@ tridimensional). We recall that, on the remaining part of the EBs, homogeneous
		Neumann boundary conditions are assumed by default.

		In the following table there is a list of the possible entries for EB boundary
		conditions. Each entry must be preceded by the prefix ``bc.[region]``
		conditions. Each entry must be preceded by the prefix ``bc.[region_name]``

		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		@@ -159,7 +159,7 @@ on an embedeed boundary. We recall that, on the remaining part of the EBs,
		no slip velocity conditions are assumed by default.

		In the following table is a list of the possible entries for inflow EB boundary
		conditions. Each entry must be preceded by the prefix ``bc.[region]``. Like traditional mass
		conditions. Each entry must be preceded by the prefix ``bc.[region_name]``. Like traditional mass
		inflows, the fluid temperature, pressure, and species composition must be
		provided when appropriate.

docs/source_docs/user_guide/inputs/initial_conditions.rst

+5 −5

Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 5 added lines, 5 removed lines.
Original line number	Diff line number	Diff line
		@@ -26,7 +26,7 @@ Fluid settings
		~~~~~~~~~~~~~~

		For each initial condition region, the fluid inputs are defined
		using the compound prefix ``ic.[region].[fluid]``:
		using the compound prefix ``ic.[region_name].[fluid_name]``:

		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		@@ -39,7 +39,7 @@ using the compound prefix ``ic.[region].[fluid]``:
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| velocity \| Velocity components \| Reals \| 0 0 0 \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| species.[species_name] \| Mass fraction of 'species_name' \| Real \| 0 \|
		\| species.[species_name] \| Mass fraction of `species_name` \| Real \| 0 \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+


		@@ -49,7 +49,7 @@ Solids settings
		~~~~~~~~~~~~~~~

		For each initial condition region, general solids inputs are defined
		using the compound prefix ``ic.[region]``:
		using the compound prefix ``ic.[region_name]``:

		+----------------------+------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		@@ -74,7 +74,7 @@ using the compound prefix ``ic.[region]``:
		+----------------------+------------------------------------------------------------------+-------------+-----------+

		For each initial condition region, the solid inputs are defined
		using the compound prefix ``ic.[region].[solid]``:
		using the compound prefix ``ic.[region_name].[solid_name]``:
		Note that diameter distributions must define a weighting type,
		please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistributions>`.

		@@ -85,7 +85,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| temperature \| temperature \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| species.[species_name] \| Mass fraction of 'species_name' \| Real \| 0 \|
		\| species.[species_name] \| Mass fraction of `species_name` \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| velocity \| Velocity components \| Reals \| 0 0 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+

add "_name" to [region], [species] etc

Merge request reports