From 268ea8e504de01a5f16f9595b5863ed4c977b710 Mon Sep 17 00:00:00 2001
From: Stephen Guzik
Date: Wed, 8 Jan 2025 11:25:06 -0500
Subject: [PATCH] Guidance complete up to/including structural nodes
---
source/standard/MLL/api/c_api.rst | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/source/standard/MLL/api/c_api.rst b/source/standard/MLL/api/c_api.rst
index 60868b8..d1f841e 100644
--- a/source/standard/MLL/api/c_api.rst
+++ b/source/standard/MLL/api/c_api.rst
@@ -139,10 +139,19 @@ ____________________________________________
.. raw:: html
Node: Zone_t
- (SIDS))
+ (SIDS)
.. File Mapping)
+.. note::
+ When a CGNS file is opened via the cg_open() MLL function, the zones are sorted alphanumerically by name (the creation order is ignored/discarded).
+ This mechanism is provided to enable ordinal zone indexing.
+ Therefore, if ordinal zone indexing is desired, it is considered good standard practice to always choose zone names to be alphabetically increasing.
+ For example, Zone0001, Zone0002, etc. is appropriate for up to 9999 zones.
+
+.. warning::
+ Because the cgnsview tool uses the low-level cgio API, it does not sort the zones by name and zone order presented may not match that of the MLL API. Generally, cgnsview presents the zones in creation order for both ADF and HDF5 formats. One exception is CGNS files that are either created or opened using the HDF5 v1.6 library (or older) will always be presented alphabetically (creation order tracking was added to HDF5 in v1.8).
+
.. doxygengroup:: CGNSZoneInformation
:content-only: