Loading docs/source_docs/user_guide/inputs/output/checkpointing.rst +4 −4 Viewed Changes for docs/source_docs/user_guide/inputs/output/checkpointing.rst: 4 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -20,12 +20,12 @@ The following inputs must be preceded by the prefix ``mfix`` and control checkpo +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_file | Prefix to use for checkpoint output | String | chk | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_chk_write | When enabled, write the EB geometry data into geom_chk_file | Bool | false | | | and additionally, geom_levelset_chk_file, if levelset | | | | geom_chk_write | When enabled, write the EB geometry data into ``geom_chk_file`` | Bool | false | | | and additionally, ``geom_levelset_chk_file`` if levelset | | | | | refinement is enabled. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_chk_read | When true, read the EB geometry data from geom_chk_file | Bool | false | | | and additionally, geom_levelset_chk_file, if levelset | | | | geom_chk_read | When true, read the EB geometry data from ``geom_chk_file`` | Bool | false | | | and additionally, ``geom_levelset_chk_file`` if levelset | | | | | refinement is enabled. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_chk | Loading docs/source_docs/user_guide/inputs/output/monitors.rst +11 −13 Viewed Changes for docs/source_docs/user_guide/inputs/output/monitors.rst: 11 added lines, 13 removed lines. Original line number Diff line number Diff line Loading @@ -10,7 +10,7 @@ To define monitors, the following inputs must be preceded by the prefix ``mfix`` +--------------------+------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +====================+======================================================+=============+===========+ | monitors | Names of the monitors to be computed | String | None | | monitors | Names of the monitors to be computed | Strings | None | +--------------------+------------------------------------------------------+-------------+-----------+ | monitors.[monitor] | Monitor type | String | None | +--------------------+------------------------------------------------------+-------------+-----------+ Loading Loading @@ -48,7 +48,7 @@ Monitor output -------------- The monitor data will be output to a file with name given by the input "plot_file", and the extension ``.csv`` is automatically added. The monitor ``plot_file``, and the extension ``.csv`` is automatically added. The monitor output file is in Comma Separated Value (CSV) format. The first line of the file provides header information. The following inputs must be preceded by the prefix ``mfix.monitors``: Loading @@ -56,34 +56,32 @@ the prefix ``mfix.monitors``: +-------------------------------+----------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +===============================+==========================================================+=============+===========+ | [monitor].plot_file | Define the name of the plotfile where monitor output | String | None | | | will be saved | | | | [monitor].plot_file | Name of the plot file for monitor output. | String | None | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].plot_int | Define the timestep frequency for saving monitored data | Int | -1 | | | to file | | | | [monitor].plot_int | Frequency for saving monitored data to output file. | Int | -1 | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].plot_per_approx | Define the approximated simulation time at which saving | Real | 0 | | | monitored data | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.openmode | Sets the open mode for the monitor output file. | String | app | | [monitor].output.openmode | Select open mode for the monitor output file. | String | app | | | | | | | | Options: | | | | | | | | | | * ``app`` - append to the file if it already exists | | | | | * ``trunc`` - overwrite the output file if it exists | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.setw | Sets the field width to be used on output file | Int | 0 | | [monitor].output.setw | Field width for output file. | Int | 0 | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.setfill | Sets the filling character for the output file | Char | '' | | [monitor].output.setfill | Fill character for output file. | Char | '' | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.setprecision | Sets the decimal precision to be used to format | Int | 0 | | | floating-point values in the output file | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.format | Sets the format flags. Admissible values are: | String | "" | | [monitor].output.format | Sets the format flags. Options: | String | "" | | | | | | | | * "defaultfloat" | | | | | * "fixed" | | | | | * "scientific" | | | | | * ``defaultfloat`` | | | | | * ``fixed`` | | | | | * ``scientific`` | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ .. code-block:: none Loading docs/source_docs/user_guide/inputs/output/reports.rst +1 −1 Viewed 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 Loading @@ -15,7 +15,7 @@ The following inputs are defined using the prefix ``mfix.reports``: +--------------------+------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +====================+======================================================+=============+===========+ | diameter | Names of the PSD reports | String | None | | diameter | Names of the PSD reports | Strings | None | +--------------------+------------------------------------------------------+-------------+-----------+ Loading docs/source_docs/user_guide/inputs/advanced.rst +5 −5 Viewed Changes for docs/source_docs/user_guide/inputs/advanced.rst: 5 added lines, 5 removed lines. Original line number Diff line number Diff line Loading @@ -70,8 +70,8 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | | | | | | Options: | | | | | | | | | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | | | | | * ``DualGrid`` fluid and particles live on different grids | | | | load_balance | * ``SingleGrid`` - fluid and particles are co-located on the same grid| | | | | * ``DualGrid`` - fluid and particles occupy different grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.DualGrid.fluid | Regrid mesh (fluid) in addition to particles when using `DualGrid` | Int | 0 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading Loading @@ -107,11 +107,11 @@ The following inputs are defined using the prefix ``particles``: | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | max_grid_size_x | Maximum number of cells at level 0 in each grid in x-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_grid_size_y | Maximum number of cells at level 0 in each grid in y-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_grid_size_z | Maximum number of cells at level 0 in each grid in z-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true. | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ docs/source_docs/user_guide/inputs/boundary_conditions.rst +5 −5 Viewed Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 5 added lines, 5 removed lines. Original line number Diff line number Diff line Loading @@ -12,7 +12,7 @@ The following inputs are defined using the prefix ``bc``: +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. | String | None | | regions | Regions used to define boundary conditions. | Strings | None | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading Loading @@ -68,7 +68,7 @@ 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.[species0] | Species 'species0' mass fraction [required if solve_species=1 | Real | 0 | | species.[species_name] | Species 'species_name' mass fraction [required if solve_species=1 | Real | 0 | | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -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 `bc.[region0].` conditions. Each entry must be preceded by the prefix ``bc.[region]`` +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -158,8 +158,8 @@ In addition to the temperature, it is possible to set an inflow condition for fl 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 there is a list of the possible entries for inflow EB boundary conditions. Each entry must be preceded by `bc.[region0].` Like traditional mass 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 inflows, the fluid temperature, pressure, and species composition must be provided when appropriate. Loading Loading
docs/source_docs/user_guide/inputs/output/checkpointing.rst +4 −4 Viewed Changes for docs/source_docs/user_guide/inputs/output/checkpointing.rst: 4 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -20,12 +20,12 @@ The following inputs must be preceded by the prefix ``mfix`` and control checkpo +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_file | Prefix to use for checkpoint output | String | chk | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_chk_write | When enabled, write the EB geometry data into geom_chk_file | Bool | false | | | and additionally, geom_levelset_chk_file, if levelset | | | | geom_chk_write | When enabled, write the EB geometry data into ``geom_chk_file`` | Bool | false | | | and additionally, ``geom_levelset_chk_file`` if levelset | | | | | refinement is enabled. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_chk_read | When true, read the EB geometry data from geom_chk_file | Bool | false | | | and additionally, geom_levelset_chk_file, if levelset | | | | geom_chk_read | When true, read the EB geometry data from ``geom_chk_file`` | Bool | false | | | and additionally, ``geom_levelset_chk_file`` if levelset | | | | | refinement is enabled. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_chk | Loading
docs/source_docs/user_guide/inputs/output/monitors.rst +11 −13 Viewed Changes for docs/source_docs/user_guide/inputs/output/monitors.rst: 11 added lines, 13 removed lines. Original line number Diff line number Diff line Loading @@ -10,7 +10,7 @@ To define monitors, the following inputs must be preceded by the prefix ``mfix`` +--------------------+------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +====================+======================================================+=============+===========+ | monitors | Names of the monitors to be computed | String | None | | monitors | Names of the monitors to be computed | Strings | None | +--------------------+------------------------------------------------------+-------------+-----------+ | monitors.[monitor] | Monitor type | String | None | +--------------------+------------------------------------------------------+-------------+-----------+ Loading Loading @@ -48,7 +48,7 @@ Monitor output -------------- The monitor data will be output to a file with name given by the input "plot_file", and the extension ``.csv`` is automatically added. The monitor ``plot_file``, and the extension ``.csv`` is automatically added. The monitor output file is in Comma Separated Value (CSV) format. The first line of the file provides header information. The following inputs must be preceded by the prefix ``mfix.monitors``: Loading @@ -56,34 +56,32 @@ the prefix ``mfix.monitors``: +-------------------------------+----------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +===============================+==========================================================+=============+===========+ | [monitor].plot_file | Define the name of the plotfile where monitor output | String | None | | | will be saved | | | | [monitor].plot_file | Name of the plot file for monitor output. | String | None | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].plot_int | Define the timestep frequency for saving monitored data | Int | -1 | | | to file | | | | [monitor].plot_int | Frequency for saving monitored data to output file. | Int | -1 | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].plot_per_approx | Define the approximated simulation time at which saving | Real | 0 | | | monitored data | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.openmode | Sets the open mode for the monitor output file. | String | app | | [monitor].output.openmode | Select open mode for the monitor output file. | String | app | | | | | | | | Options: | | | | | | | | | | * ``app`` - append to the file if it already exists | | | | | * ``trunc`` - overwrite the output file if it exists | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.setw | Sets the field width to be used on output file | Int | 0 | | [monitor].output.setw | Field width for output file. | Int | 0 | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.setfill | Sets the filling character for the output file | Char | '' | | [monitor].output.setfill | Fill character for output file. | Char | '' | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.setprecision | Sets the decimal precision to be used to format | Int | 0 | | | floating-point values in the output file | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ | [monitor].output.format | Sets the format flags. Admissible values are: | String | "" | | [monitor].output.format | Sets the format flags. Options: | String | "" | | | | | | | | * "defaultfloat" | | | | | * "fixed" | | | | | * "scientific" | | | | | * ``defaultfloat`` | | | | | * ``fixed`` | | | | | * ``scientific`` | | | +-------------------------------+----------------------------------------------------------+-------------+-----------+ .. code-block:: none Loading
docs/source_docs/user_guide/inputs/output/reports.rst +1 −1 Viewed 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 Loading @@ -15,7 +15,7 @@ The following inputs are defined using the prefix ``mfix.reports``: +--------------------+------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +====================+======================================================+=============+===========+ | diameter | Names of the PSD reports | String | None | | diameter | Names of the PSD reports | Strings | None | +--------------------+------------------------------------------------------+-------------+-----------+ Loading
docs/source_docs/user_guide/inputs/advanced.rst +5 −5 Viewed Changes for docs/source_docs/user_guide/inputs/advanced.rst: 5 added lines, 5 removed lines. Original line number Diff line number Diff line Loading @@ -70,8 +70,8 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | | | | | | Options: | | | | | | | | | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | | | | | * ``DualGrid`` fluid and particles live on different grids | | | | load_balance | * ``SingleGrid`` - fluid and particles are co-located on the same grid| | | | | * ``DualGrid`` - fluid and particles occupy different grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.DualGrid.fluid | Regrid mesh (fluid) in addition to particles when using `DualGrid` | Int | 0 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading Loading @@ -107,11 +107,11 @@ The following inputs are defined using the prefix ``particles``: | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | max_grid_size_x | Maximum number of cells at level 0 in each grid in x-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_grid_size_y | Maximum number of cells at level 0 in each grid in y-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_grid_size_z | Maximum number of cells at level 0 in each grid in z-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true. | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+
docs/source_docs/user_guide/inputs/boundary_conditions.rst +5 −5 Viewed Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 5 added lines, 5 removed lines. Original line number Diff line number Diff line Loading @@ -12,7 +12,7 @@ The following inputs are defined using the prefix ``bc``: +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. | String | None | | regions | Regions used to define boundary conditions. | Strings | None | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading Loading @@ -68,7 +68,7 @@ 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.[species0] | Species 'species0' mass fraction [required if solve_species=1 | Real | 0 | | species.[species_name] | Species 'species_name' mass fraction [required if solve_species=1 | Real | 0 | | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -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 `bc.[region0].` conditions. Each entry must be preceded by the prefix ``bc.[region]`` +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -158,8 +158,8 @@ In addition to the temperature, it is possible to set an inflow condition for fl 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 there is a list of the possible entries for inflow EB boundary conditions. Each entry must be preceded by `bc.[region0].` Like traditional mass 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 inflows, the fluid temperature, pressure, and species composition must be provided when appropriate. Loading