[Doc] Move input files doc to a table and add link to download them

parent 458a637b
......@@ -167,4 +167,9 @@ create_default_config(
"config.ini;parameters.html;parameters.rst"
${PROJECT_SOURCE_DIR}/dune/dorie
${CMAKE_CURRENT_SOURCE_DIR}/parameters.css
)
\ No newline at end of file
)
# Copy Dorie config in source for reference in the cookbook
configure_file(${CMAKE_CURRENT_BINARY_DIR}/config.ini
${CMAKE_CURRENT_SOURCE_DIR}/config.ini
COPYONLY)
......@@ -18,26 +18,31 @@ Input Files
Templates for the required files can conveniently be generated with the
:doc:`CLI </manual/cli>`.
* :doc:`Configuration File </manual/config-file>` (``.ini``):
The main input file for the solver. Template: ``config.ini``
* :ref:`Parameterization Data File <man-parameter_file>` (``.yml``):
Specifies the soil parameterization type(s) and parameters.
Template: ``param.yml``
* :doc:`Boundary Condition Data File </manual/bcfile>` (``.bcdat``):
Specifies the boundary segmentation and the boundary conditions.
Templates: ``2d_infiltr.bcdat``, ``3d_infiltr.bcdat``
* :ref:`GMSH Mesh File <man-grid_gmsh>` (optional): Mesh with possibly
complicated geometry to build an unstructured grid from.
* :ref:`Grid Mapping H5 File <man-grid_mapping-dataset>` (optional):
Used to generate heterogeneous soil architectures and boundary segmentations
for rectangular grids.
* :ref:`Scaling Field H5 Files <man-parameter_scaling>` (optional):
Datasets for interpolating local heterogeneities in the parameterization.
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
| Type | Format | Description | Templates |
+========================================+================+==========================================+======================================================================+
| :doc:`Configuration File | :file:`.ini` | The main input file for the solver. | :download:`config.ini </default_files/config.ini>` |
| </manual/config-file>` | | | |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
| :ref:`Parameterization Data File | :file:`.yml` | Specifies the soil and solute | :download:`richards_param.yml </default_files/richards_param.yml>`, |
| <man-parameter_file>` | | parameterization type(s) and parameters. | :download:`transport_param.yml </default_files/transport_param.yml>` |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
| :doc:`Boundary Condition Data File | :file:`.bcdat` | Specifies the boundary segmentation and | :download:`2d_infiltr.bcdat </default_files/2d_infiltr.bcdat>`, |
| </manual/bcfile>` | | the boundary conditions. | :download:`3d_infiltr.bcdat </default_files/3d_infiltr.bcdat>`, |
| | | | :download:`2d_solute.bcdat </default_files/2d_solute.bcdat>`, |
| | | | :download:`3d_solute.bcdat </default_files/3d_solute.bcdat>` |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
| :ref:`GMSH Mesh File | :file:`.gmsh` | Mesh with possibly complicated geometry | --- |
| <man-grid_gmsh>` (optional) | | to build an unstructured grid from. | |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
| :ref:`Grid Mapping H5 File | :file:`.h5` | Used to generate heterogeneous soil | --- |
| <man-grid_mapping-dataset>` (optional) | | architectures and boundary segmentations | |
| | | for rectangular grids. | |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
| :ref:`Scaling Field H5 Files | :file:`.h5` | Datasets for interpolating local | --- |
| <man-parameter_scaling>` (optional) | | heterogeneities in the parameterization. | |
| | | | |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
Output Files
============
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment