Skip to content

Commit

Permalink
add documentation for Parser (#608)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderSinn authored Oct 20, 2021
1 parent 7b8f03b commit b464b08
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/run/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://amrex-codes.github.io/amrex/docs_html/Basics.html#parser>`__.
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
------------------

Expand Down

0 comments on commit b464b08

Please sign in to comment.