From fcb01cad2b11e7687d605750003cf581940a3e16 Mon Sep 17 00:00:00 2001 From: Ann Almgren Date: Thu, 18 Oct 2018 19:15:32 -0700 Subject: [PATCH] Add inputs file --- docs/source/GettingStarted.rst | 1 + docs/source/Inputs.rst | 56 ++++++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + 3 files changed, 58 insertions(+) create mode 100644 docs/source/Inputs.rst diff --git a/docs/source/GettingStarted.rst b/docs/source/GettingStarted.rst index d84b219..cb438cd 100644 --- a/docs/source/GettingStarted.rst +++ b/docs/source/GettingStarted.rst @@ -11,4 +11,5 @@ Getting Started BuildingGMake RunningTestSuite RegressionTesting + Inputs diff --git a/docs/source/Inputs.rst b/docs/source/Inputs.rst new file mode 100644 index 0000000..db8b605 --- /dev/null +++ b/docs/source/Inputs.rst @@ -0,0 +1,56 @@ +.. _Chap:Inputs: + +Run-time Inputs +================== + +The following inputs must be preceded by "amr." ++-----------------+-----------------------------------------------------------------------+-------------+ +| File | Description | Default | ++=================+=======================================================================+=============+ +| max_step | Maximum number of time steps to take | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| stop_time | Maximum time to reach | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| max_level | Maximum level of refinement allowed (0 when single-level) | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| n_cell | Number of cells at level 0 in each coordinate direction | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| plot_int | Frequency of plotfile output | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| plot_file | Prefix to use for plotfile output | plt | ++-----------------+-----------------------------------------------------------------------+-------------+ +| check_int | Frequency of checkpoint output | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| chk_file | Prefix to use for checkpoint output | chk | ++-----------------+-----------------------------------------------------------------------+-------------+ +| restart | Name of file from which to restart the run | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| max_grid_size_x | Maximum number of cells at level 0 in each grid in x-direction | 32 | ++-----------------+-----------------------------------------------------------------------+-------------+ +| max_grid_size_y | Maximum number of cells at level 0 in each grid in y-direction | 32 | ++-----------------+-----------------------------------------------------------------------+-------------+ +| max_grid_size_z | Maximum number of cells at level 0 in each grid in z-direction | 32 | ++-----------------+-----------------------------------------------------------------------+-------------+ + + +The following inputs must be preceded by "geometry." + ++-----------------+-----------------------------------------------------------------------+-------------+ +| File | Description | Default | ++=================+=========================================================================+=============+ +| coord_sys | 0 for Cartesian | 0 | ++-----------------+-----------------------------------------------------------------------+-------------+ +| is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | 0 | ++-----------------+-----------------------------------------------------------------------+-------------+ + + +The following inputs must be preceded by "mfix." ++-----------------+-----------------------------------------------------------------------+-------------+ +| File | Description | Default | ++=================+=======================================================================+=============+ +| fixed_dt | Should we use a fixed timestep? | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| dt_max | Maximum value of dt if calculating with cfl | None | ++-----------------+-----------------------------------------------------------------------+-------------+ +| cfl | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1 | None | ++-----------------+-----------------------------------------------------------------------+-------------+ diff --git a/docs/source/index.rst b/docs/source/index.rst index 245c0ad..69abf9d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,6 +22,7 @@ the master branch at the beginning of each month. Introduction GettingStarted + Inputs Fluids Particles -- GitLab