Parameters ========== Node types ---------- | DEC - Declaration | DEF - Definition | DCM - Declaration / Modification | DFM - Definition / Modification | MOD - Modification | INJ - Injection | IMP - Import Parameter list -------------- .. csv-table:: :widths: 50 5 5 5 5 5 5 5 :header-rows: 1 "Property name", "DEC", "DEF", "DCM", "DFM", "MOD", "INJ", "IMP" ":ref:`box.geometry`", "", "1", "", "", "", "1", "" ":ref:`box.size.vy`", "", "1", "", "", "", "", "" ":ref:`box.size.x`", "1", "", "", "", "1", "", "1" ":ref:`box.size.y`", "1", "1", "", "1", "", "", "1" ":ref:`box.size.z`", "", "1", "", "", "", "", "" ":ref:`cells.densities`", "", "1", "", "", "", "", "1" ":ref:`cells.sizes`", "", "1", "", "", "", "", "1" ":ref:`cells.temperatures`", "", "1", "", "", "", "", "1" ":ref:`cfl_factor`", "", "1", "", "", "", "", "" ":ref:`max_vare`", "", "1", "", "", "", "", "" ":ref:`max_vari`", "", "1", "", "", "", "", "" ":ref:`modules.heating`", "1", "", "", "", "1", "", "1" ":ref:`modules.hydrodynamics`", "", "1", "", "", "", "", "" ":ref:`modules.radiation`", "1", "", "", "", "1", "", "1" ":ref:`runtime.t_max`", "1", "", "", "", "1", "", "1" ":ref:`runtime.timestep`", "1", "", "", "", "1", "", "1" ":ref:`simulation.directory`", "1", "", "", "", "", "1", "" ":ref:`simulation.name`", "", "1", "", "", "", "", "" ":ref:`simulation.precision`", "", "1", "", "", "", "", "" Parameter nodes --------------- .. _PARAM_box_geometry: box.geometry ~~~~~~~~~~~~ .. _NODE_box_geometry_PDF_FILE1_20: +------------------+--------------------------------------------------------------------------------------------+--------+ | DEF | :ref:`PDF_FILE1:20` | :ref:`injection` | uint16 | +==================+============================================================================================+========+ | **Value:** | ``3`` | +------------------+--------------------------------------------------------------------------------------------+--------+ | **Options:** | 1, 2, 3 | +------------------+--------------------------------------------------------------------------------------------+--------+ | **Description:** | Type of grid geometry | +------------------+--------------------------------------------------------------------------------------------+--------+ .. _PARAM_box_size_vy: box.size.vy ~~~~~~~~~~~ .. _NODE_box_size_CASE2_vy_PDF_FILE1_38: +------------+---------------------------------------+---------+ | DEF | :ref:`PDF_FILE1:38` | float64 | +============+=======================================+=========+ | **Value:** | ``23.000`` | +------------+---------------------------------------+---------+ | **Unit:** | ``km/s`` | +------------+---------------------------------------+---------+ .. _PARAM_box_size_x: box.size.x ~~~~~~~~~~ .. _NODE_box_size_x_PDF_FILE1_27: +------------------+---------------------------------------+----------+ | DEC | :ref:`PDF_FILE1:27` | float128 | +==================+=======================================+==========+ | **Unit:** | ``cm`` | +------------------+---------------------------------------+----------+ | **Condition:** | ``{?} > 0`` | +------------------+---------------------------------------+----------+ | **Description:** | Box size in X direction | +------------------+---------------------------------------+----------+ .. _NODE_box_size_x_settings_8: +------------+-------------------------------------------------------------------------+-----+ | MOD | :ref:`settings:8` | :ref:`import` | mod | +============+=========================================================================+=====+ | **Value:** | ``10`` | +------------+-------------------------------------------------------------------------+-----+ | **Unit:** | ``nm`` | +------------+-------------------------------------------------------------------------+-----+ .. _PARAM_box_size_y: box.size.y ~~~~~~~~~~ .. _NODE_box_size_CASE1_y_PDF_FILE1_32: +------------------+---------------------------------------+---------+ | DEC | :ref:`PDF_FILE1:32` | float64 | +==================+=======================================+=========+ | **Unit:** | ``cm`` | +------------------+---------------------------------------+---------+ | **Options:** | 3.0 cm, 4.0 cm | +------------------+---------------------------------------+---------+ | **Description:** | Box size in Y direction | +------------------+---------------------------------------+---------+ .. _NODE_box_size_CASE2_y_PDF_FILE1_37: +------------+---------------------------------------+---------+ | DEF | :ref:`PDF_FILE1:37` | float64 | +============+=======================================+=========+ | **Value:** | ``34.000`` | +------------+---------------------------------------+---------+ | **Unit:** | ``au`` | +------------+---------------------------------------+---------+ .. _NODE_box_size_y_settings_9: +------------+-------------------------------------------------------------------------+-----+ | DFM | :ref:`settings:9` | :ref:`import` | mod | +============+=========================================================================+=====+ | **Value:** | ``3e7`` | +------------+-------------------------------------------------------------------------+-----+ | **Unit:** | ``nm`` | +------------+-------------------------------------------------------------------------+-----+ .. _PARAM_box_size_z: box.size.z ~~~~~~~~~~ .. _NODE_box_size_CASE4_z_PDF_FILE1_43: +------------------+---------------------------------------+------------------+ | DEF | :ref:`PDF_FILE1:43` | constant float64 | +==================+=======================================+==================+ | **Value:** | ``23.000`` | +------------------+---------------------------------------+------------------+ | **Unit:** | ``cm`` | +------------------+---------------------------------------+------------------+ | **Options:** | 10.0 m, 20.0 cm, 23.0 cm, 26.0 cm | +------------------+---------------------------------------+------------------+ | **Description:** | Box size in Z direction | +------------------+---------------------------------------+------------------+ .. _PARAM_cells_densities: cells.densities ~~~~~~~~~~~~~~~ .. _NODE_cells_densities_cells_1: +------------+-------------------------------------------------------------------+---------+ | DEF | :ref:`cells:1` | :ref:`import` | float64 | +============+===================================================================+=========+ | **Value:** | ``[0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0]`` | +------------+-------------------------------------------------------------------+---------+ | **Unit:** | ``km/s`` | +------------+-------------------------------------------------------------------+---------+ .. _PARAM_cells_sizes: cells.sizes ~~~~~~~~~~~ .. _NODE_cells_sizes_cells_2: +------------+-------------------------------------------------------------------+-------+ | DEF | :ref:`cells:2` | :ref:`import` | int32 | +============+===================================================================+=======+ | **Value:** | ``[10, 11, 12, 13, 14, 15, 16, 17, 18, 19]`` | +------------+-------------------------------------------------------------------+-------+ | **Unit:** | ``cm`` | +------------+-------------------------------------------------------------------+-------+ .. _PARAM_cells_temperatures: cells.temperatures ~~~~~~~~~~~~~~~~~~ .. _NODE_cells_temperatures_cells_3: +------------+-------------------------------------------------------------------+---------+ | DEF | :ref:`cells:3` | :ref:`import` | float64 | +============+===================================================================+=========+ | **Value:** | ``[20.0, 21.0, 22.0, 23.0, 24.0, 25.0, 26.0, 27.0, 28.0, 29.0]`` | +------------+-------------------------------------------------------------------+---------+ | **Unit:** | ``K`` | +------------+-------------------------------------------------------------------+---------+ .. _PARAM_cfl_factor: cfl_factor ~~~~~~~~~~ .. _NODE_cfl_factor_PDF_STRING1_4: +------------+------------------------------------------+---------+ | DEF | :ref:`PDF_STRING1:4` | float64 | +============+==========================================+=========+ | **Value:** | ``0.700`` | +------------+------------------------------------------+---------+ .. _PARAM_max_vare: max_vare ~~~~~~~~ .. _NODE_max_vare_PDF_STRING1_5: +------------+------------------------------------------+---------+ | DEF | :ref:`PDF_STRING1:5` | float64 | +============+==========================================+=========+ | **Value:** | ``0.200`` | +------------+------------------------------------------+---------+ .. _PARAM_max_vari: max_vari ~~~~~~~~ .. _NODE_max_vari_PDF_STRING1_6: +------------+------------------------------------------+---------+ | DEF | :ref:`PDF_STRING1:6` | float64 | +============+==========================================+=========+ | **Value:** | ``0.200`` | +------------+------------------------------------------+---------+ .. _PARAM_modules_heating: modules.heating ~~~~~~~~~~~~~~~ .. _NODE_modules_heating_PDF_FILE1_57: +------------------+---------------------------------------+------+ | DEC | :ref:`PDF_FILE1:57` | bool | +==================+=======================================+======+ | **Tags:** | preprocessor | +------------------+---------------------------------------+------+ | **Description:** | Switch on heating module | +------------------+---------------------------------------+------+ .. _NODE_modules_heating_settings_12: +------------+--------------------------------------------------------------------------+-----+ | MOD | :ref:`settings:12` | :ref:`import` | mod | +============+==========================================================================+=====+ | **Value:** | ``false`` | +------------+--------------------------------------------------------------------------+-----+ .. _PARAM_modules_hydrodynamics: modules.hydrodynamics ~~~~~~~~~~~~~~~~~~~~~ .. _NODE_modules_hydrodynamics_PDF_FILE1_54: +------------------+---------------------------------------+------+ | DEF | :ref:`PDF_FILE1:54` | bool | +==================+=======================================+======+ | **Value:** | ``true`` | +------------------+---------------------------------------+------+ | **Tags:** | preprocessor | +------------------+---------------------------------------+------+ | **Description:** | Switch on hydrodynamics module | +------------------+---------------------------------------+------+ .. _PARAM_modules_radiation: modules.radiation ~~~~~~~~~~~~~~~~~ .. _NODE_modules_radiation_PDF_FILE1_60: +------------------+---------------------------------------+------+ | DEC | :ref:`PDF_FILE1:60` | bool | +==================+=======================================+======+ | **Tags:** | preprocessor | +------------------+---------------------------------------+------+ | **Description:** | Switch on radiation module | +------------------+---------------------------------------+------+ .. _NODE_modules_radiation_settings_13: +------------+--------------------------------------------------------------------------+-----+ | MOD | :ref:`settings:13` | :ref:`import` | mod | +============+==========================================================================+=====+ | **Value:** | ``true`` | +------------+--------------------------------------------------------------------------+-----+ .. _PARAM_runtime_t_max: runtime.t_max ~~~~~~~~~~~~~ .. _NODE_runtime_t_max_PDF_FILE1_11: +------------------+---------------------------------------+---------+ | DEC | :ref:`PDF_FILE1:11` | float64 | +==================+=======================================+=========+ | **Unit:** | ``s`` | +------------------+---------------------------------------+---------+ | **Condition:** | ``{?} > 0`` | +------------------+---------------------------------------+---------+ | **Description:** | Maximum simulation time | +------------------+---------------------------------------+---------+ .. _NODE_runtime_t_max_settings_2: +------------+-------------------------------------------------------------------------+-----+ | MOD | :ref:`settings:2` | :ref:`import` | mod | +============+=========================================================================+=====+ | **Value:** | ``10`` | +------------+-------------------------------------------------------------------------+-----+ | **Unit:** | ``ns`` | +------------+-------------------------------------------------------------------------+-----+ .. _PARAM_runtime_timestep: runtime.timestep ~~~~~~~~~~~~~~~~ .. _NODE_runtime_timestep_PDF_FILE1_14: +------------------+---------------------------------------+---------+ | DEC | :ref:`PDF_FILE1:14` | float64 | +==================+=======================================+=========+ | **Unit:** | ``s`` | +------------------+---------------------------------------+---------+ | **Condition:** | ``{?} < {?runtime.t_max} && {?} > 0`` | +------------------+---------------------------------------+---------+ | **Description:** | Simulation time step | +------------------+---------------------------------------+---------+ .. _NODE_runtime_timestep_settings_3: +------------+-------------------------------------------------------------------------+-----+ | MOD | :ref:`settings:3` | :ref:`import` | mod | +============+=========================================================================+=====+ | **Value:** | ``0.01`` | +------------+-------------------------------------------------------------------------+-----+ | **Unit:** | ``ns`` | +------------+-------------------------------------------------------------------------+-----+ .. _PARAM_simulation_directory: simulation.directory ~~~~~~~~~~~~~~~~~~~~ .. _NODE_simulation_directory_PDF_FILE1_8: +-----+--------------------------------------------------------------------------------------------------+-----+ | DEC | :ref:`PDF_FILE1:8` | :ref:`injection` | mod | +-----+--------------------------------------------------------------------------------------------------+-----+ .. _PARAM_simulation_name: simulation.name ~~~~~~~~~~~~~~~ .. _NODE_simulation_name_PDF_FILE1_4: +-------------+--------------------------------------+-----+ | DEF | :ref:`PDF_FILE1:4` | str | +=============+======================================+=====+ | **Value:** | ``simulation`` | +-------------+--------------------------------------+-----+ | **Format:** | ``[a-zA-Z_-]+`` | +-------------+--------------------------------------+-----+ .. _PARAM_simulation_precision: simulation.precision ~~~~~~~~~~~~~~~~~~~~ .. _NODE_simulation_precision_PDF_FILE1_6: +--------------+--------------------------------------+-----+ | DEF | :ref:`PDF_FILE1:6` | str | +==============+======================================+=====+ | **Value:** | ``double`` | +--------------+--------------------------------------+-----+ | **Options:** | double, float | +--------------+--------------------------------------+-----+