From c4f60179b936e742d2ed1fba505473b4ff5dc786 Mon Sep 17 00:00:00 2001 From: David Kopriva Date: Thu, 20 Aug 2026 09:49:42 -0700 Subject: [PATCH] Update documentation Update the documentation to explain that the examples are designed to run from the main directory, and how that can be changed. --- Documentation/docs/examples.md | 2 +- README.md | 13 ++++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Documentation/docs/examples.md b/Documentation/docs/examples.md index a2174a5e..939d95ec 100644 --- a/Documentation/docs/examples.md +++ b/Documentation/docs/examples.md @@ -1,6 +1,6 @@ # Examples -HOHQMesh comes with 19 example control, mesh, and plot files for two-dimensional meshes found in the *Examples/2D* directory. These examples illustrate the use of the the control and model features, and the resulting meshes and plot files. +HOHQMesh comes with 19 example control, mesh, and plot files for two-dimensional meshes found in the *Examples/2D* directory. These examples illustrate the use of the the control and model features, and the resulting meshes and plot files. They are set up to be run out-of-the-box from the main HOHQMesh directory. To use them in other directories, simply change the file paths for the output files in the control file, as described in the [documentation](Documentation/docs/the-control-input.md) for the control file. Also included in the Examples directory is a control template: ControlTemplate.control, that can (like any of the examples) be modified at will. diff --git a/README.md b/README.md index 69e27f88..1ace94a6 100644 --- a/README.md +++ b/README.md @@ -183,20 +183,27 @@ To mesh a control file, type where `-f` allows you to provide the path to the control file for which you want to create your mesh. -For example, if you are inside the HOHQMesh root directory, you can run +## Examples + +About thirty examples can be found in the `Examples` directory. These examples are set up to run out-of-the-box from the main HOHQMesh directory. + +For example, from inside the HOHQMesh root directory, you can run ```shell ./HOHQMESH -f Examples/2D/GingerbreadMan/GingerbreadMan.control ``` -to generate a mesh for a gingerbread man geometry. This will produce three files, +to generate a mesh for a gingerbread man geometry. This will produce four files, ``` Examples/2D/GingerbreadMan/GingerbreadManMesh.mesh Examples/2D/GingerbreadMan/GingerbreadManPlot.tec Examples/2D/GingerbreadMan/GingerbreadManStats.txt +Examples/2D/GingerbreadMan/GingerbreadManStats_ErrorNorms.txt ``` where the `.mesh` file stores the actual mesh, the `.tec` file is a Tecplot-compatible -visualization file, and the `.txt` file contains statistical information on the mesh +visualization file, and the two `.txt` file contain statistical and error norm information on the mesh quality. +You can, however, work from any directory you like by changing the file paths in the control files, see the [documentation](Documentation/docs/the-control-input.md). + The Tecplot file can be visualized, e.g., using the open-source software [ParaView](https://www.paraview.org), which has a built-in Tecplot reader. In the case of the gingerbread man, the resulting mesh should look like the example found in the