Loading docs/source_docs/tools/pic2dem.rst +2 −2 Original line number Diff line number Diff line Loading @@ -50,10 +50,10 @@ The following inputs must be preceded by "pic2dem.": | | geometry for the DEM refined case will be read or | | | | | written | | | +------------------------+---------------------------------------------------+--------+---------+ | geom_chk_write | Flag to turn on/off writing the EB geometry | bool | false | | geom_chk_write | Enable writing the EB geometry | bool | false | | | checkpoint file for the DEM refined case | | | +------------------------+---------------------------------------------------+--------+---------+ | geom_chk_read | Flag to turn on/off reading the EB geometry | bool | false | | geom_chk_read | Enable reading the EB geometry | bool | false | | | checkpoint file for the DEM refined case | | | +------------------------+---------------------------------------------------+--------+---------+ | geometry_filename | CSG filename that will be used for generating the | string | "" | Loading docs/source_docs/user_guide/inputs/advanced.rst +27 −14 Original line number Diff line number Diff line Loading @@ -6,21 +6,21 @@ Advanced Testing / debugging ------------------- The following inputs must be preceded by "mfix." The following inputs must be preceded by the prefix ``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 | | ooo_debug | If true, print the name of the current routine. | Bool | false | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ | only_print_grid_report | Do not time-march the simulation. Simply generate the grid report | Bool | False | | only_print_grid_report | Do not time-march the simulation. Simply generate the grid report | Bool | false | | | and exit. | | | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ The following inputs must be preceded by "amrex." The following inputs must be preceded by the prefix ``amrex``: +------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | Loading Loading @@ -63,23 +63,36 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | | Description | Type | Default | +==================================+=======================================================================+=============+===================+ | regrid_int | How often to regrid (in number of steps at level 0) | int | 0 | | | if regrid_int <= 0 then no regridding will occur | | | | regrid_int | How often to regrid (in number of steps at level 0). | Int | 0 | | | If regrid_int <= 0 then no regridding will occur. | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | string | SingleGrid | | | Grid type. | String | SingleGrid | | | | | | | | Options: | | | | | | | | | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | | | | | * ``DualGrid`` fluid and particles live on different grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.DualGrid.fluid | Regrid mesh (fluid) in addition to particles when using `DualGrid` | int | 0 | | load_balance.DualGrid.fluid | Regrid mesh (fluid) in addition to particles when using `DualGrid` | Int | 0 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.strategy | What strategy to use for load balancing | string | KnapSack | | | Options are ``KnapSack`` and ``SFC`` | | | | load_balance.strategy | Strategy to use for dynamic load balancing. | String | KnapSack | | | | | | | | Options (case-insensitive): | | | | | | | | | | * ``KnapSack`` - FIXME | | | | | * ``SFC`` - FIXME | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.weighting | What weighting function to use if using Knapsack load balancing | string | ParticleRunTime | | | Options are ``ParticleRunTime``, ``ParticleCount`` and ``CellCount`` | | | | load_balance.weighting | Weighting function to use if using ``KnapSack`` load balancing | String | ParticleRunTime | | | | | | | | Options: | | | | | | | | | | * ``ParticleRunTime`` - FIXME | | | | | * ``ParticleCount`` | | | | | * ``CellCount`` | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | knapsack_nmax | Maximum number of grids per MPI process if using knapsack algorithm | int | 128 | | knapsack_nmax | Maximum number of grids per MPI process if using knapsack algorithm | Int | 128 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | grid_pruning | Remove all covered grids from the base mesh; this may result in | bool | False | | grid_pruning | Remove all covered grids from the base mesh; this may result in | Bool | false | | | disjoined grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading docs/source_docs/user_guide/inputs/boundary_conditions.rst +31 −26 Original line number Diff line number Diff line .. _InputsBoundaryConditions: Boundary Conditions Boundary conditions =================== Loading @@ -9,29 +9,38 @@ General boundary conditions The following inputs are defined using the prefix ``bc``: +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. | String | None | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp | Pressure drop (Pa) | Real | 0 | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | po_no_par_out | Force particles to bounce back rather than exiting at pressure outflows. | Int | 0 | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ The type of the boundary conditions in the BC region must be defined. The type of the boundary conditions in the BC region must be defined with the prefix ``bc``: +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | [region] | Used to define boundary condition type. Available options include: | String | None | | [region] | Specify boundary condition type. | String | None | | | | | | | | * 'pi' for pressure inflow BC type | | | | | * 'po' for pressure outflow BC type | | | | | * 'mi' for mass inflow BC type | | | | | * 'nsw' for no-slip wall BC type | | | | | * 'eb' for inhomogeneous Dirichlet BCs of temperature or fluid | | | | | velocity (mass inflow) on the contained EBs | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | po_no_par_out | Let particles exit (default) or bounce-back at pressure outflows | Int | 0 | | | Options: | | | | | | | | | | * ``pi`` - pressure inflow | | | | | * ``po`` - pressure outflow | | | | | * ``mi`` - mass inflow | | | | | * ``nsw`` - no-slip wall | | | | | * ``eb`` - embedded boundary - for inhomogeneous Dirichlet BCs | | | | | of temperature or fluid velocity (mass inflow) on the | | | | | contained EBs | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Fluid settings ~~~~~~~~~~~~~~ Loading Loading @@ -59,11 +68,6 @@ using the prefix ``bc.[region].[fluid]``: | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp | Pressure drop (Pa) | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species0] | Species 'species0' mass fraction [required if solve_species=1 | Real | 0 | | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -162,28 +166,29 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | fluid.velocity | (Required if not `volflow` or `massflow`) | | | | fluid.velocity | [Required if not `volflow` or `massflow`] | | | | | Inflow fluid velocity on EB faces | Reals | 0 0 0 | | | contained in the (tridimensional) region. | | | | | Note that if only one value is specified, that is assumed to | | | | | be the magnitude in the direction of the EB face's normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volflow | (Required if not `velocity` or `massflow`) | | | | fluid.volflow | [Required if not `velocity` or `massflow`] | | | | | Inflow BC for fluid volumetric flow | Real | 0 | | | rate in the (tridimensional) region. The flow is assumed to be | | | | | normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.massflow | (Required if not `velocity` or `volflow`) | | | | fluid.massflow | [Required if not `velocity` or `volflow`] | | | | | Inflow BC for fluid mass flow rate in the (tridimensional) region. | Real | 0 | | | The flow is assumed to be normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volfrac | (Required) Volume fraction. | Real | 0 | | fluid.volfrac | [Required] Volume fraction. | Real | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | (Optional) When specified, only cells with EB face normal that is | Reals | 0 0 0 | | eb.normal | [Optional] When specified, only cells with EB face normal that is | Reals | 0 0 0 | | | parallel and opposite in direction to the specified values | | | | | are imposed with the inflow velocity. | | | | | are imposed with the inflow velocity. FIXME what does OPTIONAL mean | | | | | with a default value of 0? | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal_tol | (Optional) Used in conjunction with `eb.normal`. It determines the | Real | 0 | | eb.normal_tol | [Optional] Used in conjunction with `eb.normal`. It determines the | Real | 0 | | | tolerance (in degrees) for choosing cells with a specific normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading docs/source_docs/user_guide/inputs/chemical_reactions.rst +43 −38 File changed.Preview size limit exceeded, changes collapsed. Show changes docs/source_docs/user_guide/inputs/domain.rst +1 −1 Original line number Diff line number Diff line Loading @@ -16,7 +16,7 @@ The following inputs are defined using the prefix ``geometry``: | coord_sys | Coordinate system used in simulation. Only Cartesian coordinates | Int | 0 | | | (``coord_sys = 0``) are supported. | | | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Int | 0 0 0 | | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | prob_lo | Low corner of physical domain (physical not index space) | Reals | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ Loading Loading
docs/source_docs/tools/pic2dem.rst +2 −2 Original line number Diff line number Diff line Loading @@ -50,10 +50,10 @@ The following inputs must be preceded by "pic2dem.": | | geometry for the DEM refined case will be read or | | | | | written | | | +------------------------+---------------------------------------------------+--------+---------+ | geom_chk_write | Flag to turn on/off writing the EB geometry | bool | false | | geom_chk_write | Enable writing the EB geometry | bool | false | | | checkpoint file for the DEM refined case | | | +------------------------+---------------------------------------------------+--------+---------+ | geom_chk_read | Flag to turn on/off reading the EB geometry | bool | false | | geom_chk_read | Enable reading the EB geometry | bool | false | | | checkpoint file for the DEM refined case | | | +------------------------+---------------------------------------------------+--------+---------+ | geometry_filename | CSG filename that will be used for generating the | string | "" | Loading
docs/source_docs/user_guide/inputs/advanced.rst +27 −14 Original line number Diff line number Diff line Loading @@ -6,21 +6,21 @@ Advanced Testing / debugging ------------------- The following inputs must be preceded by "mfix." The following inputs must be preceded by the prefix ``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 | | ooo_debug | If true, print the name of the current routine. | Bool | false | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ | only_print_grid_report | Do not time-march the simulation. Simply generate the grid report | Bool | False | | only_print_grid_report | Do not time-march the simulation. Simply generate the grid report | Bool | false | | | and exit. | | | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ The following inputs must be preceded by "amrex." The following inputs must be preceded by the prefix ``amrex``: +------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | Loading Loading @@ -63,23 +63,36 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | | Description | Type | Default | +==================================+=======================================================================+=============+===================+ | regrid_int | How often to regrid (in number of steps at level 0) | int | 0 | | | if regrid_int <= 0 then no regridding will occur | | | | regrid_int | How often to regrid (in number of steps at level 0). | Int | 0 | | | If regrid_int <= 0 then no regridding will occur. | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | string | SingleGrid | | | Grid type. | String | SingleGrid | | | | | | | | Options: | | | | | | | | | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | | | | | * ``DualGrid`` fluid and particles live on different grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.DualGrid.fluid | Regrid mesh (fluid) in addition to particles when using `DualGrid` | int | 0 | | load_balance.DualGrid.fluid | Regrid mesh (fluid) in addition to particles when using `DualGrid` | Int | 0 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.strategy | What strategy to use for load balancing | string | KnapSack | | | Options are ``KnapSack`` and ``SFC`` | | | | load_balance.strategy | Strategy to use for dynamic load balancing. | String | KnapSack | | | | | | | | Options (case-insensitive): | | | | | | | | | | * ``KnapSack`` - FIXME | | | | | * ``SFC`` - FIXME | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.weighting | What weighting function to use if using Knapsack load balancing | string | ParticleRunTime | | | Options are ``ParticleRunTime``, ``ParticleCount`` and ``CellCount`` | | | | load_balance.weighting | Weighting function to use if using ``KnapSack`` load balancing | String | ParticleRunTime | | | | | | | | Options: | | | | | | | | | | * ``ParticleRunTime`` - FIXME | | | | | * ``ParticleCount`` | | | | | * ``CellCount`` | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | knapsack_nmax | Maximum number of grids per MPI process if using knapsack algorithm | int | 128 | | knapsack_nmax | Maximum number of grids per MPI process if using knapsack algorithm | Int | 128 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | grid_pruning | Remove all covered grids from the base mesh; this may result in | bool | False | | grid_pruning | Remove all covered grids from the base mesh; this may result in | Bool | false | | | disjoined grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading
docs/source_docs/user_guide/inputs/boundary_conditions.rst +31 −26 Original line number Diff line number Diff line .. _InputsBoundaryConditions: Boundary Conditions Boundary conditions =================== Loading @@ -9,29 +9,38 @@ General boundary conditions The following inputs are defined using the prefix ``bc``: +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. | String | None | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp | Pressure drop (Pa) | Real | 0 | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | po_no_par_out | Force particles to bounce back rather than exiting at pressure outflows. | Int | 0 | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ The type of the boundary conditions in the BC region must be defined. The type of the boundary conditions in the BC region must be defined with the prefix ``bc``: +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | [region] | Used to define boundary condition type. Available options include: | String | None | | [region] | Specify boundary condition type. | String | None | | | | | | | | * 'pi' for pressure inflow BC type | | | | | * 'po' for pressure outflow BC type | | | | | * 'mi' for mass inflow BC type | | | | | * 'nsw' for no-slip wall BC type | | | | | * 'eb' for inhomogeneous Dirichlet BCs of temperature or fluid | | | | | velocity (mass inflow) on the contained EBs | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | po_no_par_out | Let particles exit (default) or bounce-back at pressure outflows | Int | 0 | | | Options: | | | | | | | | | | * ``pi`` - pressure inflow | | | | | * ``po`` - pressure outflow | | | | | * ``mi`` - mass inflow | | | | | * ``nsw`` - no-slip wall | | | | | * ``eb`` - embedded boundary - for inhomogeneous Dirichlet BCs | | | | | of temperature or fluid velocity (mass inflow) on the | | | | | contained EBs | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Fluid settings ~~~~~~~~~~~~~~ Loading Loading @@ -59,11 +68,6 @@ using the prefix ``bc.[region].[fluid]``: | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp | Pressure drop (Pa) | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species0] | Species 'species0' mass fraction [required if solve_species=1 | Real | 0 | | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -162,28 +166,29 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | fluid.velocity | (Required if not `volflow` or `massflow`) | | | | fluid.velocity | [Required if not `volflow` or `massflow`] | | | | | Inflow fluid velocity on EB faces | Reals | 0 0 0 | | | contained in the (tridimensional) region. | | | | | Note that if only one value is specified, that is assumed to | | | | | be the magnitude in the direction of the EB face's normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volflow | (Required if not `velocity` or `massflow`) | | | | fluid.volflow | [Required if not `velocity` or `massflow`] | | | | | Inflow BC for fluid volumetric flow | Real | 0 | | | rate in the (tridimensional) region. The flow is assumed to be | | | | | normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.massflow | (Required if not `velocity` or `volflow`) | | | | fluid.massflow | [Required if not `velocity` or `volflow`] | | | | | Inflow BC for fluid mass flow rate in the (tridimensional) region. | Real | 0 | | | The flow is assumed to be normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volfrac | (Required) Volume fraction. | Real | 0 | | fluid.volfrac | [Required] Volume fraction. | Real | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | (Optional) When specified, only cells with EB face normal that is | Reals | 0 0 0 | | eb.normal | [Optional] When specified, only cells with EB face normal that is | Reals | 0 0 0 | | | parallel and opposite in direction to the specified values | | | | | are imposed with the inflow velocity. | | | | | are imposed with the inflow velocity. FIXME what does OPTIONAL mean | | | | | with a default value of 0? | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal_tol | (Optional) Used in conjunction with `eb.normal`. It determines the | Real | 0 | | eb.normal_tol | [Optional] Used in conjunction with `eb.normal`. It determines the | Real | 0 | | | tolerance (in degrees) for choosing cells with a specific normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading
docs/source_docs/user_guide/inputs/chemical_reactions.rst +43 −38 File changed.Preview size limit exceeded, changes collapsed. Show changes
docs/source_docs/user_guide/inputs/domain.rst +1 −1 Original line number Diff line number Diff line Loading @@ -16,7 +16,7 @@ The following inputs are defined using the prefix ``geometry``: | coord_sys | Coordinate system used in simulation. Only Cartesian coordinates | Int | 0 | | | (``coord_sys = 0``) are supported. | | | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Int | 0 0 0 | | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | prob_lo | Low corner of physical domain (physical not index space) | Reals | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ Loading
