diff --git a/docs/source_docs/references/eb/EBWalls.rst b/docs/source_docs/references/eb/EBWalls.rst index 9e840c3a944bf7e657950c81e989cb5318c16023..99dcee29781331e43304f02d20cc09137673436e 100644 --- a/docs/source_docs/references/eb/EBWalls.rst +++ b/docs/source_docs/references/eb/EBWalls.rst @@ -30,7 +30,7 @@ the level-set creation: | | has two levels (one additional level with | | | higher refinement). | +-------------------------------+------------------------------------------------+ -| ``mfix.levelset__refinement`` | If ``amr.max_level > 1`` this parameter is | +| ``mfix.levelset_refinement`` | If ``amr.max_level > 1`` this parameter is | | | ignored. Otherwise it sets the maximum | | | refinement of the level-set | +-------------------------------+------------------------------------------------+ diff --git a/docs/source_docs/references/size_distributions.rst b/docs/source_docs/references/size_distributions.rst index 514020eb09ba3b148a0bbd881f99619ee90e5648..058a04985292091a4f0d45bf813ffc3489958819 100644 --- a/docs/source_docs/references/size_distributions.rst +++ b/docs/source_docs/references/size_distributions.rst @@ -707,7 +707,7 @@ A user-defined ``custom`` distribution can be specified by providing discrete pr +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ -| custom | File name of user-defined distribution | string | N/A | +| custom | File name of user-defined distribution | String | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | min | Minimum particle diameter. Drawn samples below ``min`` are discarded | Real | N/A | | | and a new sample is drawn. | | | @@ -715,7 +715,7 @@ A user-defined ``custom`` distribution can be specified by providing discrete pr | max | Maximum particle diameter. Drawn samples above ``max`` are discarded | Real | N/A | | | and a new sample is drawn. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| interpolate | Enable linear interpolation between discrete bins. This option is | bool | false | +| interpolate | Enable linear interpolation between discrete bins. This option is | Bool | false | | | only available when the initial distribution probability is zero. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/advanced.rst b/docs/source_docs/user_guide/inputs/advanced.rst index 39aeedfa68a29b875fe8680b983e838c331b9e6a..d243a99e9a7c53d3914bf9a1b3d6e6e1e9e7ba5b 100644 --- a/docs/source_docs/user_guide/inputs/advanced.rst +++ b/docs/source_docs/user_guide/inputs/advanced.rst @@ -18,8 +18,8 @@ The following inputs must be preceded by the prefix ``mfix``: | only_print_grid_report | Do not time-march the simulation. Simply generate the grid report | Bool | false | | | and exit. | | | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ -| stop_for_unused_inputs | Do not time-march the simulation if any keyword in the inputs file | Bool | false | -| | has not been used. This is useful in catching input errors. | | | +| stop_for_unused_inputs | Do not start the simulation if any keywords in the inputs file | Bool | false | +| | have not been used. This is useful for catching input errors. | | | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ To assist in verifying the breakdown of fluid grids created before running a full simulation, an input option @@ -55,6 +55,14 @@ The following inputs must be preceded by the prefix ``amrex``: | abort_on_out_of_gpu_memory | Abort if free device memory is less than the amount an arena is | Int | 0 | | | asked to allocate. | | | +----------------------------+-----------------------------------------------------------------------+-------------+---------------+ +| use_gpu_aware_mpi | For GPU runs,controls the memory type used for AMReX's communication | Bool | false | +| | buffers. When ``true``, AMReX uses GPU device memory for communication| | | +| | data in MPI function calls. When ``false``, the data is placed in | | | +| | pinned memory. Note that this flag does not enable GPU-aware MPI by | | | +| | itself. Enabling GPU-aware MPI is system dependent. Users should | | | +| | consult their system's documentation for instructions on setting up | | | +| | the environment and linking to GPU-aware MPI libraries. | | | ++----------------------------+-----------------------------------------------------------------------+-------------+---------------+ Load balancing diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 6c7177500b0c97c97e2341db60ce974d5e69fbe5..c4c3a7d2544aab0a95c38997ac9ce351790bd7c8 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -195,7 +195,6 @@ please refer to :ref:`ReferenceParticleDistributions 0``. | grid_eff | Threshold value to ensure grids do not contain too large a fraction | Real | 0.7 | | | of untagged cells. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| n_error_buf | Controls the number of tagged cells before grids are defined. Used | Ints | 0 | -| | to ensure coarse/fine boundaries are not too close to tagged cells. | | | +| n_error_buf | Controls how many extra cells will be tagged around every tagged cell.| Ints | 1 | +| | For example, if set to ``2`` then tagging cell ``(i,j,k)`` will tag | | | +| | cells from ``(i-2,j-2,k-2(`` to ``(i+2,j+2,k+2)``. | | | +| | Used to ensure coarse-fine boundaries are not too close to tagged | | | +| | cells. Can be specified per-level. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| n_error_buf_x | Controls how many extra cells will be tagged around every tagged cell | Ints | 1 | +| | along the x axis. For example, if set to ``2`` then tagging cell | | | +| | ``(i,j,k)`` will tag cells from ``i-2`` to ``i+2``. Used to ensure | | | +| | coarse-fine boundaries are not too close to tagged cells. Can be | | | +| | specified per-level. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| n_error_buf_y | Controls how many extra cells will be tagged around every tagged cell | Ints | 1 | +| | along the y axis. For example, if set to ``2`` then tagging cell | | | +| | ``(i,j,k)`` will tag cells from ``j-2`` to ``j+2``. Used to ensure | | | +| | coarse-fine boundaries are not too close to tagged cells. Can be | | | +| | specified per-level. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| n_error_buf_z | Controls how many extra cells will be tagged around every tagged cell | Ints | 1 | +| | along the z axis. For example, if set to ``2`` then tagging cell | | | +| | ``(i,j,k)`` will tag cells from ``k-2`` to ``k+2``. Used to ensure | | | +| | coarse-fine boundaries are not too close to tagged cells. Can be | | | +| | specified per-level. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| ref_ratio_vect | If specified, sets thee refinement ratios between AMR levels. It's an | Ints | | +| | error if the size of the integer array, if presetn, is less than | | | +| | ``max_level*3``. The first three numbers specify the refinement ratios| | | +| | in three dimensions between levels 0 and 1, the next three numbers | | | +| | specify the ratios for levels 1 and 2, etc. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| ref_ratio | If ``ref_ratio_vect`` is not specified, this parameter will be used to| Ints | 2 | +| | set the refinement ratios between AMR levels. If there are more AMR | | | +| | levels than the size of the integer parameter array, the last integer | | | +| | will be used as the refinement ratio for the unspecified levels. For | | | +| | example, if ``max_level`` is 4 and the provided ``amr.ref_ratio`` | | | +| | is ``2 4``, the refinement ratios are 2, 4, 4 and 4, for levels 0/1, | | | +| | 1/2, 2/3, and 3/4, respectively. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index d46a3f85b2124cfd542b99ad09223c1fd13cc6cf..a28137db1be5380a5593990e9bd23122f442a0c5 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -139,6 +139,10 @@ please refer to :ref:`ReferenceParticleDistributions cmake -DCMAKE_CXX_COMPILER= [options] .. When building on a platform that uses the ``module`` utility, use either -the above command (with full path to the compilers) or the following: +the above command (with full path to the compiler) or the following: .. code:: shell - > cmake -DCMAKE_CXX_COMPILER=CC [options] .. + > cmake -DCMAKE_CXX_COMPILER=$CXX [options] .. MFIX-Exa uses the same compiler flags used to build AMReX, unless ``CMAKE_CXX_FLAGS`` is explicitly provided, or diff --git a/nonexistent-keys.txt b/nonexistent-keys.txt index de176ccbc687df26639bfd02c3f77e1931b2961c..1f3d3bcdbf468244511c3971248a7011308be215 100644 --- a/nonexistent-keys.txt +++ b/nonexistent-keys.txt @@ -1,43 +1,8 @@ -bc.[region_name].[solid_name].bins -bc.[region_name].[solid_name].density.custom -bc.[region_name].[solid_name].density.max -bc.[region_name].[solid_name].density.mean -bc.[region_name].[solid_name].density.min -bc.[region_name].[solid_name].density.std -bc.[region_name].[solid_name].diameter -bc.[region_name].[solid_name].diameter.constant -bc.[region_name].[solid_name].diameter.custom -bc.[region_name].[solid_name].diameter.max -bc.[region_name].[solid_name].diameter.mean -bc.[region_name].[solid_name].diameter.min -bc.[region_name].[solid_name].diameter.std bc.[region_name].[solid_name].massflow -bc.[region_name].[solid_name].type -ic.[region_name].[solid_name].bins -ic.[region_name].[solid_name].type - -mac_proj.bottom_maxiter -mac_proj.bottom_verbose -mac_proj.maxiter -mac_proj.verbose -mfix.deposition_diffusion_coeff -mfix.plt_T_p -mfix.plt_drag_p -mfix.plt_omega_p -mfix.plt_phase -mfix.plt_radius -mfix.plt_ro_p -mfix.plt_statwt -mfix.plt_vel_p mfix.solids.[region_name].plt_cp_s mfix.solids.[region_name].plt_h_s_txfr mfix.solids.[region_name].plt_mass mfix.solids.[region_name].plt_mass_sn_txfr mfix.solids.[region_name].plt_omoi mfix.solids.[region_name].plt_vel_s_txfr -mfix.solids.[region_name].plt_volume -mfix.use_drag_coeff_in_proj_gp -nodal_proj.bottom_maxiter -nodal_proj.bottom_verbose -nodal_proj.maxiter -nodal_proj.verbose +mfix.solids.[region_name].plt_volume \ No newline at end of file diff --git a/undocumented-keys.txt b/undocumented-keys.txt index 0b4dd2cf91fa4649b7467de19049d506f91c0f4f..daaab1c3373863714f0ca72a2d5f8a79ba46bce0 100644 --- a/undocumented-keys.txt +++ b/undocumented-keys.txt @@ -1,11 +1,9 @@ [fluid_name].trac0 -amrex.use_gpu_aware_mpi catalyst.catalyst_on_restart catalyst.enabled catalyst.implementation catalyst.library_path catalyst.script -chemistry.solids.density dem.PolyNeighSearch dem.PolyNumTypes dem.PolyRefRatios @@ -19,16 +17,12 @@ diffusion.mg_max_fmg_iter diffusion.rtol diffusion.verbose_solver eb2.extend_domain_face -eb2.small_volfrac fab.format hopper.center hopper.direction hopper.funnel_height hopper.funnel_radius hopper.orifice_radius -ic.[region_name].[solid_name].[property_name].bins -ic.[region_name].[solid_name].[property_name].interpolate -ic.[region_name].[solid_name].[property_name].type ic.[region_name].granular_temperature mfix.advect_momentum mfix.advect_tracer @@ -36,18 +30,11 @@ mfix.agg_grid_size mfix.ascent_on_restart mfix.checkpoint_files_output mfix.constraint.include_depdt -mfix.deposition.filter -mfix.deposition.filter.constant -mfix.deposition.filter.variable -mfix.deposition.filter.variable.min_eps mfix.geom_chk_ccse_regtest +mfix.grid_pruning mfix.monitors.[monitor_name].count mfix.overstep_end_time mfix.particle_sorting_bin -mfix.particles.enthalpy_source -mfix.particles.update_enthalpy -mfix.particles.update_mass -mfix.particles.update_momentum mfix.plt_D_g mfix.plt_MW_g mfix.plt_X_g @@ -72,11 +59,11 @@ mfix.solids.[region_name].plt_pft_neighbor_flags mfix.solids.[region_name].plt_ptype mfix.solids.[region_name].plt_vm_coeff mfix.sort_particle_int -mfix.stop_for_unused_inputs mfix.test_tracer_conservation mfix.use_new_depdt_algo particles.reduceGhostParticles pic2dem.convert +species.thermal_conductivity.model stl.internal_flow tracer tracer.diff_coeff \ No newline at end of file