Update note to explain what domain is referred by pyhyp index

[DavidAnderegg]

Purpose

Documentation update as there is a better way than 'trial and error' to figure out what index a domain in Pointwise is referred to in pyHyp.

Expected time until merged

When you have time.

Type of change

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (non-backwards-compatible fix or feature)
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Documentation update
• Maintenance update
• Other (please describe)

Testing

none

Checklist

• I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
• I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
• I have run unit and regression tests which pass locally with my changes
• I have added new tests that prove my fix is effective or that my feature works
• I have added necessary documentation

[anilyil]

Hi @DavidAnderegg , thanks for the change. Unfortunately, it's more complicated than that. I think Pointwise has a separate sorting that you can prescribe. However, from my understanding, it is the CGNS format that sorts things using the "lexicographical" order. So whatever output order you pick in Pointwise is overwritten in CGNS. We sort in Pointwise by name because that is the closest thing. Maybe update the docs to represent this?

[DavidAnderegg]

Hi @anilyil, thats basically what i write in the changes...?

Maybe you ask me to make it more explicit?