Skip to content

Commit 56d19d0

Browse files
authored
Add links to amrex documentation (#1682)
1 parent 69224b8 commit 56d19d0

File tree

3 files changed

+40
-14
lines changed

3 files changed

+40
-14
lines changed

docs/sphinx/user/inputs.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,21 @@ executable.
1414
$ ./amr_wind inputs.abl time.max_step=20
1515
1616
17-
The input file is a simple text file containing ``key = value`` entries for the
18-
input parameters. The text file can include comments, any text beginning with
19-
``#`` till the end of line (EOF) is interpreted as comments and ignored by the
20-
parser. Input file processing is handled by `AMReX ParmParse library
17+
The input file is a simple text file containing ``key = value``
18+
entries for the input parameters. The text file can include comments,
19+
any text beginning with ``#`` till the end of line (EOF) is
20+
interpreted as comments and ignored by the parser. Input file
21+
processing is handled by `AMReX ParmParse library
2122
<https://amrex-codes.github.io/amrex/docs_html/Basics.html#parmparse>`_. This
22-
section documents the various input file parameters and their default values (if
23-
available). In :program:`amr_wind`, the input file is broken into *sections*
24-
indicated by a namespace prefix. For example, all inputs related to the problem
25-
domain are prefixed with ``geometry.`` and so on. A sample input file is shown below
23+
section documents the common input file parameters and their default
24+
values (if available). The focus is on AMR-Wind specific input options
25+
and some common AMReX options (these are fully documented in `AMReX
26+
<https://amrex-codes.github.io/amrex/docs_html/RuntimeParameters.html>`_).
27+
28+
In :program:`amr_wind`, the input file
29+
is broken into *sections* indicated by a namespace prefix. For
30+
example, all inputs related to the problem domain are prefixed with
31+
``geometry.`` and so on. A sample input file is shown below
2632

2733
.. literalinclude:: ./amr_wind_inputs.txt
2834
:linenos:

docs/sphinx/user/inputs_MLMG.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
Section: MLMG options
44
~~~~~~~~~~~~~~~~~~~~~
55

6+
.. tip::
7+
8+
For further information the user is directed to the `AMReX linear
9+
solver documentation
10+
<ttps://amrex-codes.github.io/amrex/docs_html/LinearSolvers_Chapter.html>`_
11+
and other `AMReX runtime parameters
12+
<https://amrex-codes.github.io/amrex/docs_html/RuntimeParameters.html>_`
13+
14+
615
This section specifies the Multi-Level Multi-Grid (MLMG) options for each type
716
of linear solve. There are three types of linear solves performed in AMR-Wind
817
"diffusion" which is a cell based Helmholtz like solve to advance the momentum
@@ -13,6 +22,7 @@ described but the same options apply to "nodal_proj" and "mac_proj". It is also
1322
possible to specify diffusion solver options for specific equations such as
1423
temperature, to do that use "temperature_diffusion" as your prefix.
1524

25+
1626
**Linear operator options**
1727

1828
.. input_param:: diffusion.max_coarsening_level

docs/sphinx/user/inputs_amr.rst

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
.. _inputs_amr:
22

3-
Section: amr
4-
~~~~~~~~~~~~
3+
Section: AMReX and AMR
4+
~~~~~~~~~~~~~~~~~~~~~~
55

6-
This section contains input parameters used by the core AMReX mesh data
7-
structure ``AmrCore`` to determine the base mesh and adaptive mesh refinement
8-
strategies. The refinement criteria is specified through :ref:`inputs_tagging`
6+
.. tip::
7+
8+
The user is encouraged to refer to the full list of `AMReX runtime
9+
parameters
10+
<https://amrex-codes.github.io/amrex/docs_html/RuntimeParameters.html>_`
11+
for more advanced usage. Another section of particular interest is
12+
the `description of AMReX grid creation
13+
<https://amrex-codes.github.io/amrex/docs_html/GridCreation.html#sec-grid-creation>_`.
14+
15+
This section contains some of the common input parameters used by the
16+
core AMReX mesh data structure ``AmrCore`` to determine the base mesh
17+
and adaptive mesh refinement strategies. The refinement criteria is
18+
specified through :ref:`inputs_tagging`.
919

1020
.. input_param:: amr.n_cell
1121

@@ -23,7 +33,7 @@ strategies. The refinement criteria is specified through :ref:`inputs_tagging`
2333

2434
.. input_param:: amr.max_grid_size
2535

26-
**type:** Integer, optional, default: 32
36+
**type:** Integer, optional, default: [build dependent]
2737

2838
Maximum number of cells at level 0 in each grid.
2939
There are also options to specify this value in each direction,

0 commit comments

Comments
 (0)