diff --git a/docs/source/run/parameters.rst b/docs/source/run/parameters.rst index d12a2b9af3..bc72103d45 100644 --- a/docs/source/run/parameters.rst +++ b/docs/source/run/parameters.rst @@ -3,6 +3,24 @@ Input parameters ================ +Parser +------ + +In HiPACE++ all input parameters are obtained through `amrex::Parser`, making it possible to +specify input parameters with expressions and not just numbers. User constants can be defined +in the input script with `my_constants`. Some Physical constants are already provided. + +.. code-block:: bash + + my_constants.ne = 1.25e24 + my_constants.kp_inv = "clight / sqrt(ne * q_e^2 / (epsilon0 * m_e))" + beam.radius = "kp_inv / 2" + +For a list of supported functions see the +`AMReX documentation `__. +Sometimes it is necessary to use double-quotes around expressions, especially when providing them +as command line parameters. Multi-line expressions are allowed if surrounded by double-quotes. + General parameters ------------------