Skip to content

Commit 1a252f2

Browse files
authored
Add in details of File_prefix which appears to have been omitted (#139)
1 parent 568a18f commit 1a252f2

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

documentation/source/how_to_use_it/meshes/mesh_configuration_namelists.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,23 @@ depending on generator.
4545
at z=0, as a result, features are located with only 2-coordinates,
4646
``(x,y)`` in metres.
4747

48+
* ``file_prefix``: **'<string>'**
49+
File prefix used to construct output filename(s). Depending on the logical,
50+
:ref:`partition_mesh<partition_mesh>`, the output filename(s) are constructed as:
51+
52+
**<file_prefix>.nc**
53+
Single file output for non-partitioned mesh topologies. Requested meshes
54+
encompass an entire model domain.
55+
56+
**<file_prefix>_<partition_id>_<n_partitions>.nc**
57+
Multiple files output for pre-partitioned mesh topologies. Each file
58+
contains the cells of the requested meshes on a given partition of
59+
the model domain. Pre-partitioned meshes allow a simple load operation
60+
to populate an application's local mesh objects on a mpi rank.
61+
62+
**Note:** Pre-partitioned meshes are only suitable for applications
63+
running with mpi ranks equal to the number of partitions.
64+
4865
* ``geometry``: **'<string>'**
4966
Geometrical shape of the surface domain. Valid options:
5067

0 commit comments

Comments
 (0)