Loading docs/source_docs/RegressionTesting.rst +8 −14 Changes for docs/source_docs/RegressionTesting.rst: 8 added lines, 14 removed lines. Original line number Original line Diff line number Diff line Loading @@ -65,17 +65,11 @@ testing prior to committing code the GitLab repository. +------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------------------------------------+ | For the Joule environment, load the gnu module and set environment variables first. If not on Joule, skip this step. | | For the Joule environment, load the gnu module and set environment variables first. If not on Joule, skip this step. | +------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------------------------------------+ | \`\`\`shell | +------------------------------------------------------------------------------------------------------------------------+ .. code:: shell | > module load gnu/6.1.0 | +------------------------------------------------------------------------------------------------------------------------+ module load gnu/6.1.0 | > export CC=/nfs/apps/Compilers/GNU/6.1.0/bin/gcc | export CC=/nfs/apps/Compilers/GNU/6.1.0/bin/gcc +------------------------------------------------------------------------------------------------------------------------+ export CXX=/nfs/apps/Compilers/GNU/6.1.0/bin/g++ | > export CXX=/nfs/apps/Compilers/GNU/6.1.0/bin/g++ | export F77=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran +------------------------------------------------------------------------------------------------------------------------+ export FC=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran | > export F77=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran | +------------------------------------------------------------------------------------------------------------------------+ | > export FC=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran | +------------------------------------------------------------------------------------------------------------------------+ | \`\`\` | +------------------------------------------------------------------------------------------------------------------------+ docs/source_docs/eb/EBWalls.rst +2 −2 Changes for docs/source_docs/eb/EBWalls.rst: 2 added lines, 2 removed lines. Original line number Original line Diff line number Diff line Loading @@ -289,12 +289,12 @@ The level-set is used in two places: Special Cases Involving Level-Sets Special Cases Involving Level-Sets ---------------------------------- ---------------------------------- The level-set function is filled by the `mfix::fill_eb_levelsets()` function. The level-set function is filled by the :cpp:`mfix::fill_eb_levelsets()` function. There are two special cases involving level-sets: There are two special cases involving level-sets: 1. Mass-Inflow boundary conditions are not given EB walls. However, we don't 1. Mass-Inflow boundary conditions are not given EB walls. However, we don't want particles to fall out of a MI either, so at the very end of the want particles to fall out of a MI either, so at the very end of the `mfix::fill_eb_levelsets()` function we call `mfix::intersect_ls_walls()`. :cpp:`mfix::fill_eb_levelsets()` function we call :cpp:`mfix::intersect_ls_walls()`. This performs an intersection operation with the level-set representing a This performs an intersection operation with the level-set representing a wall at each MI. wall at each MI. Loading docs/source_docs/inputs/InputsTimeStepping.rst +6 −6 Changes for docs/source_docs/inputs/InputsTimeStepping.rst: 6 added lines, 6 removed lines. Original line number Original line Diff line number Diff line Loading @@ -58,7 +58,7 @@ Setting the Time Step There are several ways that the inputs are used to determine what time step There are several ways that the inputs are used to determine what time step is used in the evolution of the fluid-particle system in MFIX-Exa. is used in the evolution of the fluid-particle system in MFIX-Exa. 1) In a pure particle case, the :cpp:`mfix.fixed_dt`, if specified, is only used to determine the frequency 1. In a pure particle case, the :cpp:`mfix.fixed_dt`, if specified, is only used to determine the frequency of outputs, it has no effect on the "dtsolid" used in the particle evaluation. If you do not specify a positive of outputs, it has no effect on the "dtsolid" used in the particle evaluation. If you do not specify a positive value of :cpp:`mfix.fixed_dt` then the code will abort. value of :cpp:`mfix.fixed_dt` then the code will abort. Loading @@ -71,17 +71,17 @@ value of :cpp:`mfix.fixed_dt` then the code will abort. The particle time step "dtsolid" is determined by computing the collision time "tcoll" from particle properties, The particle time step "dtsolid" is determined by computing the collision time "tcoll" from particle properties, then setting "dtsolid" to be "tcoll / 50". then setting "dtsolid" to be "tcoll / 50". 2) In a pure fluid case, there are two options: 2. In a pure fluid case, there are two options: * If you want to fix the dt, simply set :cpp:`mfix.fixed_dt = XXX` and the fluid time * If you want to fix the dt, simply set :cpp:`mfix.fixed_dt = XXX` and the fluid time step will always be that number. step will always be that number. * If you want to let the code determine the appropriate time step using the advective CFL * If you want to let the code determine the appropriate time step using the advective CFL condition, then set :cpp:`mfix.cfl = 0.7` for example, and the fluid time step will condition, then set :cpp:`mfix.cfl = 0.7` for example, and the fluid time step will be computed to be dt = 0.5 * dx / max(vel). be computed to be dt = 0.7 * dx / max(vel). * If dt as computed in the compute_dt routine is smaller than the user-specified * If dt as computed in the compute_dt routine is smaller than the user-specified ```mfix.dt_min``` then the code will abort: :cpp:`mfix.dt_min` then the code will abort: .. highlight:: c++ .. highlight:: c++ Loading @@ -90,7 +90,7 @@ then setting "dtsolid" to be "tcoll / 50". amrex::Abort::0::"Current dt is smaller than dt_min !!! amrex::Abort::0::"Current dt is smaller than dt_min !!! * If dt as computed in the compute_dt routine is larger than the user-specified * If dt as computed in the compute_dt routine is larger than the user-specified ```mfix.dt_max``` then dt will be set to the minimum of its computed value and dt_max :cpp:`mfix.dt_max` then dt will be set to the minimum of its computed value and dt_max * Note that the cfl defaults to 0.5 so it does not have to be set in the inputs file. If neither * Note that the cfl defaults to 0.5 so it does not have to be set in the inputs file. If neither :cpp:`mfix.cfl` nor :cpp:`fixed_dt` is set, then default value of cfl will be used. :cpp:`mfix.cfl` nor :cpp:`fixed_dt` is set, then default value of cfl will be used. Loading @@ -99,6 +99,6 @@ then setting "dtsolid" to be "tcoll / 50". These options apply to steady state calculations as well as unsteady runs. These options apply to steady state calculations as well as unsteady runs. 3) In a coupled particle-fluid case, dt is determined as in the pure-fluid case. In this case 3. In a coupled particle-fluid case, dt is determined as in the pure-fluid case. In this case the particle time step "subdt" is first computed as in the particle-only case ("dtsolid"), the particle time step "subdt" is first computed as in the particle-only case ("dtsolid"), then is adjusted so that an integral number of particle steps fit into a single fluid time step. then is adjusted so that an integral number of particle steps fit into a single fluid time step. Loading
docs/source_docs/RegressionTesting.rst +8 −14 Changes for docs/source_docs/RegressionTesting.rst: 8 added lines, 14 removed lines. Original line number Original line Diff line number Diff line Loading @@ -65,17 +65,11 @@ testing prior to committing code the GitLab repository. +------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------------------------------------+ | For the Joule environment, load the gnu module and set environment variables first. If not on Joule, skip this step. | | For the Joule environment, load the gnu module and set environment variables first. If not on Joule, skip this step. | +------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------------------------------------+ | \`\`\`shell | +------------------------------------------------------------------------------------------------------------------------+ .. code:: shell | > module load gnu/6.1.0 | +------------------------------------------------------------------------------------------------------------------------+ module load gnu/6.1.0 | > export CC=/nfs/apps/Compilers/GNU/6.1.0/bin/gcc | export CC=/nfs/apps/Compilers/GNU/6.1.0/bin/gcc +------------------------------------------------------------------------------------------------------------------------+ export CXX=/nfs/apps/Compilers/GNU/6.1.0/bin/g++ | > export CXX=/nfs/apps/Compilers/GNU/6.1.0/bin/g++ | export F77=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran +------------------------------------------------------------------------------------------------------------------------+ export FC=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran | > export F77=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran | +------------------------------------------------------------------------------------------------------------------------+ | > export FC=/nfs/apps/Compilers/GNU/6.1.0/bin/gfortran | +------------------------------------------------------------------------------------------------------------------------+ | \`\`\` | +------------------------------------------------------------------------------------------------------------------------+
docs/source_docs/eb/EBWalls.rst +2 −2 Changes for docs/source_docs/eb/EBWalls.rst: 2 added lines, 2 removed lines. Original line number Original line Diff line number Diff line Loading @@ -289,12 +289,12 @@ The level-set is used in two places: Special Cases Involving Level-Sets Special Cases Involving Level-Sets ---------------------------------- ---------------------------------- The level-set function is filled by the `mfix::fill_eb_levelsets()` function. The level-set function is filled by the :cpp:`mfix::fill_eb_levelsets()` function. There are two special cases involving level-sets: There are two special cases involving level-sets: 1. Mass-Inflow boundary conditions are not given EB walls. However, we don't 1. Mass-Inflow boundary conditions are not given EB walls. However, we don't want particles to fall out of a MI either, so at the very end of the want particles to fall out of a MI either, so at the very end of the `mfix::fill_eb_levelsets()` function we call `mfix::intersect_ls_walls()`. :cpp:`mfix::fill_eb_levelsets()` function we call :cpp:`mfix::intersect_ls_walls()`. This performs an intersection operation with the level-set representing a This performs an intersection operation with the level-set representing a wall at each MI. wall at each MI. Loading
docs/source_docs/inputs/InputsTimeStepping.rst +6 −6 Changes for docs/source_docs/inputs/InputsTimeStepping.rst: 6 added lines, 6 removed lines. Original line number Original line Diff line number Diff line Loading @@ -58,7 +58,7 @@ Setting the Time Step There are several ways that the inputs are used to determine what time step There are several ways that the inputs are used to determine what time step is used in the evolution of the fluid-particle system in MFIX-Exa. is used in the evolution of the fluid-particle system in MFIX-Exa. 1) In a pure particle case, the :cpp:`mfix.fixed_dt`, if specified, is only used to determine the frequency 1. In a pure particle case, the :cpp:`mfix.fixed_dt`, if specified, is only used to determine the frequency of outputs, it has no effect on the "dtsolid" used in the particle evaluation. If you do not specify a positive of outputs, it has no effect on the "dtsolid" used in the particle evaluation. If you do not specify a positive value of :cpp:`mfix.fixed_dt` then the code will abort. value of :cpp:`mfix.fixed_dt` then the code will abort. Loading @@ -71,17 +71,17 @@ value of :cpp:`mfix.fixed_dt` then the code will abort. The particle time step "dtsolid" is determined by computing the collision time "tcoll" from particle properties, The particle time step "dtsolid" is determined by computing the collision time "tcoll" from particle properties, then setting "dtsolid" to be "tcoll / 50". then setting "dtsolid" to be "tcoll / 50". 2) In a pure fluid case, there are two options: 2. In a pure fluid case, there are two options: * If you want to fix the dt, simply set :cpp:`mfix.fixed_dt = XXX` and the fluid time * If you want to fix the dt, simply set :cpp:`mfix.fixed_dt = XXX` and the fluid time step will always be that number. step will always be that number. * If you want to let the code determine the appropriate time step using the advective CFL * If you want to let the code determine the appropriate time step using the advective CFL condition, then set :cpp:`mfix.cfl = 0.7` for example, and the fluid time step will condition, then set :cpp:`mfix.cfl = 0.7` for example, and the fluid time step will be computed to be dt = 0.5 * dx / max(vel). be computed to be dt = 0.7 * dx / max(vel). * If dt as computed in the compute_dt routine is smaller than the user-specified * If dt as computed in the compute_dt routine is smaller than the user-specified ```mfix.dt_min``` then the code will abort: :cpp:`mfix.dt_min` then the code will abort: .. highlight:: c++ .. highlight:: c++ Loading @@ -90,7 +90,7 @@ then setting "dtsolid" to be "tcoll / 50". amrex::Abort::0::"Current dt is smaller than dt_min !!! amrex::Abort::0::"Current dt is smaller than dt_min !!! * If dt as computed in the compute_dt routine is larger than the user-specified * If dt as computed in the compute_dt routine is larger than the user-specified ```mfix.dt_max``` then dt will be set to the minimum of its computed value and dt_max :cpp:`mfix.dt_max` then dt will be set to the minimum of its computed value and dt_max * Note that the cfl defaults to 0.5 so it does not have to be set in the inputs file. If neither * Note that the cfl defaults to 0.5 so it does not have to be set in the inputs file. If neither :cpp:`mfix.cfl` nor :cpp:`fixed_dt` is set, then default value of cfl will be used. :cpp:`mfix.cfl` nor :cpp:`fixed_dt` is set, then default value of cfl will be used. Loading @@ -99,6 +99,6 @@ then setting "dtsolid" to be "tcoll / 50". These options apply to steady state calculations as well as unsteady runs. These options apply to steady state calculations as well as unsteady runs. 3) In a coupled particle-fluid case, dt is determined as in the pure-fluid case. In this case 3. In a coupled particle-fluid case, dt is determined as in the pure-fluid case. In this case the particle time step "subdt" is first computed as in the particle-only case ("dtsolid"), the particle time step "subdt" is first computed as in the particle-only case ("dtsolid"), then is adjusted so that an integral number of particle steps fit into a single fluid time step. then is adjusted so that an integral number of particle steps fit into a single fluid time step.
