Skip to content

Commit

Permalink
More readme updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
oparry-ukaea committed Dec 5, 2024
1 parent 4481b43 commit 5be8c43
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,9 @@ To run a solver example:
```
./scripts/run_eg.sh [solver_name] [example_name] <-n num_MPI> <-b build_dir>
```
which will look for the solver executable in the most recently modified directory or symlink in `builds`, unless an alternative location is supplied with `-b`. Output is generated in `runs/<solver_name>/<example_name>`.
which will look for the solver executable in the most recently modified build
directory (or symlink) in `builds`, unless an alternative location is supplied
with `-b`. Output is generated in `runs/<solver_name>/<example_name>`.

## Address Sanitizers

Expand All @@ -315,6 +317,16 @@ One pipeline for creating simple Nektar++ meshes is through Gmsh and NekMesh.
.msh -> .xml with NekMesh

A .geo file can be created using the Gmsh UI (each command adds a new line to the .geo file). For simple meshes it may be easier to produce the .geo file in a text editor. .geo files can also be loaded into the UI to edit.

The script at `scripts/geo_to_xml.sh` can be used to convert .geo files to
Nektar++ XML meshes. Execute the script with no arguments to see the available
options. Note that no `<EXPANSIONS>` node is generated; users need to add one
themselves, either to the mesh file itself, or to another xml file that gets
passed to Nektar++. Alternatively, an xml mesh can be generated by running Gmsh
and NekMesh separately, using the instructions below.


An example .geo file is shown below:
<details>
<summary>Expand</summary>
mesh.geo
Expand Down Expand Up @@ -360,8 +372,9 @@ Recombine Surface "*";
```
</details>
Loading the above file in the Gmsh GUI, then selecting `2D mesh` and saving will produce a .msh file.
Alternatively for simple meshes one can jump straight to the next step by writing the .msh file directly in a text editor.
Selecting 2D mesh in Gmsh and saving will produce a .msh file. The mesh should be visible in the UI to check before saving. Alternatively for simple meshes one can jump straight to this step by writing the .msh file in a text editor.
<details>
<summary>Expand</summary>
mesh.msh
Expand Down

0 comments on commit 5be8c43

Please sign in to comment.