Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
glesur committed Oct 6, 2024
1 parent 1f1a76c commit a75f6ef
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
6 changes: 3 additions & 3 deletions doc/source/reference/idefix.ini.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ allows for comments, which should start with ``#``.

``Grid`` section
--------------------
The grid section defines the grid total dimension. It consists of 3 entries ``X1-grid``, ``X2-grid`` and ``X3-grid``. Each entry defines the repartition of the grid points in the corresponding direction (the grid is always rectilinear).
The grid section defines the grid total dimension. It consists of 3 entries ``X1-grid``, ``X2-grid`` (when DIMENSIONS>=2) and ``X3-grid`` (when DIMENSIONS=3). Each entry defines the repartition of the grid points in the corresponding direction (the grid is always rectilinear).
Each entry defines a series of grid blocks which are concatenated along the direction. Each block in a direction can have a different spacing rule (uniform, log or stretched). The definition of the Grid entries is as follows

+----------------------------+-------------------------+------------------------------+
Expand Down Expand Up @@ -332,8 +332,8 @@ this block is simply ignored.
------------------------

This section describes the boundary conditions used by the code. There are 6 entries
which need to be defined: ``X1-beg``, ``X2-beg``, ``X3-beg`` for the left boundaries in the direction X1, X2, X3,
and ``X1-end``, ``X2-end``, ``X3-end`` for the right boundaries. Each boundary can be assigned the following types of conditions
that need to be defined: ``X1-beg``, ``X2-beg``, ``X3-beg`` for the left boundaries in the direction X1, X2, X3,
and ``X1-end``, ``X2-end``, ``X3-end`` for the right boundaries. ``X2`` boundaries are mandatory only when DIMENSIONS>=2 and ``X3`` when DIMENSIONS=3. Each boundary can be assigned the following types of conditions

+----------------+------------------------------------------------------------------------------------------------------------------+
| Boundary type | Comment |
Expand Down
6 changes: 0 additions & 6 deletions test/HD/sod-iso/idefix-hllc-rk3.ini
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
[Grid]
X1-grid 1 0.0 500 u 1.0
X2-grid 1 0.0 1 u 1.0
X3-grid 1 0.0 1 u 1.0

[TimeIntegrator]
CFL 0.8
Expand All @@ -16,10 +14,6 @@ csiso constant 1.0
[Boundary]
X1-beg outflow
X1-end outflow
X2-beg outflow
X2-end outflow
X3-beg outflow
X3-end outflow

[Output]
vtk 0.1
Expand Down

0 comments on commit a75f6ef

Please sign in to comment.