From 7a3d4b03c93c1151bd8da828cfed9f88766002d1 Mon Sep 17 00:00:00 2001 From: "M. Scot Breitenfeld" Date: Wed, 17 Dec 2025 13:48:29 -0600 Subject: [PATCH 1/2] fixed errors and warnings --- .gitignore | 4 ++++ source/current.rst | 1 + source/governance/meetings.rst | 2 +- source/standard/SIDS/boundary.rst | 9 +++++---- source/standard/SIDS/grid.rst | 30 +++++++++++++++++------------- source/standard/SIDS/misc.rst | 14 ++++++++------ source/standard/SIDS/multizone.rst | 7 ++++--- source/standard/SIDS/particles.rst | 7 ++++--- source/standard/SIDS/time.rst | 7 ++++--- 9 files changed, 48 insertions(+), 33 deletions(-) diff --git a/.gitignore b/.gitignore index 7fd2aa31..8fd2deb6 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,7 @@ build/ __pycache__/ */__pycache__/ _build + + +#Ignore vscode AI rules +.github/instructions/codacy.instructions.md diff --git a/source/current.rst b/source/current.rst index ffb5ba61..0f7ecab0 100644 --- a/source/current.rst +++ b/source/current.rst @@ -10,6 +10,7 @@ Resources current/news current/CPEX current/download + current/building current/examples current/softwarelist doc diff --git a/source/governance/meetings.rst b/source/governance/meetings.rst index 57021e27..515b491c 100644 --- a/source/governance/meetings.rst +++ b/source/governance/meetings.rst @@ -16,7 +16,7 @@ Minutes **2025** -------- - The detailed minutes from our 2025 meetings are now available on the `CGNS GitHub Wiki page `_ . **2024** -------- diff --git a/source/standard/SIDS/boundary.rst b/source/standard/SIDS/boundary.rst index 09e6d4fa..e5ab0114 100644 --- a/source/standard/SIDS/boundary.rst +++ b/source/standard/SIDS/boundary.rst @@ -333,13 +333,14 @@ If present, these three entities take precedence over all corresponding entities The :sidsref:`UserDefinedData_t` data structure allows arbitrary user-defined data to be stored in :sidskey:`Descriptor_t` and :sidskey:`DataArray_t` children without the restrictions or implicit meanings imposed on these node types at other node locations. -.. c:function:: FUNCTION ListLength() +**FUNCTION ListLength()** - :return value: ``int`` - :dependencies: :sidskey:`PointRange`, :sidskey:`PointList` + *Return value:* ``int`` + + *Dependencies:* :sidskey:`PointRange`, :sidskey:`PointList` :sidskey:`BCDataSet_t` requires the structure function :sidskey:`ListLength`, which is used to specify the length of locally defined Dirichlet and Neumann data arrays when the grid location of these quantities differs from that of the BC patch definition. If :sidskey:`PointRange` is specified, then :sidskey:`ListLength` is obtained from the number of points (inclusive) between the beginning and ending indices of :sidskey:`PointRange`. If :sidskey:`PointList` is specified, then :sidskey:`ListLength` is the number of indices in the list of points. In this situation, :sidskey:`ListLength` becomes a user input along with the indices of the list :sidskey:`PointList`. By user we mean the application code that is generating the CGNS database. - + If neither :sidskey:`PointRange` or :sidskey:`PointList` is specified in a particular :sidskey:`BCDataSet_t` substructure, :sidskey:`ListLength` must be passed into it to determine the length of BC data arrays. diff --git a/source/standard/SIDS/grid.rst b/source/standard/SIDS/grid.rst index 2eda34ff..6f5c858f 100644 --- a/source/standard/SIDS/grid.rst +++ b/source/standard/SIDS/grid.rst @@ -450,14 +450,16 @@ The third and fourth examples are for an unstructured zone with 15 tetrahedral a Example - TETRA_4 Element Types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This example uses the simple three-element tetrahedral grid shown below. +This example uses a simple three-element tetrahedral grid. -.. figure:: ../../../images/sids/figs/ex_tetra.gif - :width: 400px - :align: center - :alt: Unstructured grid consisting of three tetrahedra - - *Example Tetrahedral Grid* +.. .. figure:: ../../../images/sids/figs/ex_tetra.gif +.. :width: 400px +.. :align: center +.. :alt: Unstructured grid consisting of three tetrahedra +.. +.. *Example Tetrahedral Grid* +.. +.. (Figure pending - ex_tetra.gif not found) The element type is :sidskey:`TETRA_4`, and the connectivity is defined in :sidskey:`ElementConnectivity` by specifying the four nodes comprising each element, with the order consistent with the :ref:`numbering conventions for tetrahedral elements `. The data in :sidskey:`ElementConnectivity` is grouped by element; note that the parentheses are added here for presentation purposes only. @@ -748,17 +750,19 @@ Although intended for edge or face-based solution data for unstructured grids, t The :sidsref:`UserDefinedData_t` data structure allows arbitrary user-defined data to be stored in :sidskey:`Descriptor_t` and :sidskey:`DataArray_t` children without the restrictions or implicit meanings imposed on these node types at other node locations. -.. c:function:: FUNCTION ListLength() +**FUNCTION ListLength()** + + *Return value:* ``int`` - :return value: ``int`` - :dependencies: :sidskey:`PointRange`, :sidskey:`PointList` + *Dependencies:* :sidskey:`PointRange`, :sidskey:`PointList` :sidskey:`FlowSolution_t` requires the structure function :sidskey:`ListLength`, which is used to specify the number of entities (e.g. vertices) corresponding to a given :sidskey:`PointRange` or :sidskey:`PointList`. If :sidskey:`PointRange` is specified, then :sidskey:`ListLength` is obtained from the number of points (inclusive) between the beginning and ending indices of :sidskey:`PointRange`. If :sidskey:`PointList` is specified, then :sidskey:`ListLength` is the number of indices in the list of points. In this situation, :sidskey:`ListLength` becomes a user input along with the indices of the list :sidskey:`PointList`. By user we mean the application code that is generating the CGNS database. -.. c:function:: FUNCTION DataSize() +**FUNCTION DataSize()** - :return value: one-dimensional ``int`` array of length :sidskey:`IndexDimension` - :dependencies: :sidskey:`IndexDimension`, :sidskey:`VertexSize[]`, :sidskey:`CellSize[]`, :sidskey:`GridLocation`, :sidskey:`Rind`, :sidskey:`ListLength[]` + *Return value:* one-dimensional ``int`` array of length :sidskey:`IndexDimension` + + *Dependencies:* :sidskey:`IndexDimension`, :sidskey:`VertexSize[]`, :sidskey:`CellSize[]`, :sidskey:`GridLocation`, :sidskey:`Rind`, :sidskey:`ListLength[]` The function :sidskey:`DataSize[]` is the size of flow solution data arrays. If :sidskey:`Rind` is absent then :sidskey:`DataSize` represents only the core points; it will be the same as :sidskey:`VertexSize` or :sidskey:`CellSize` depending on :sidskey:`GridLocation`. The definition of the function :sidskey:`DataSize[]` is as follows: diff --git a/source/standard/SIDS/misc.rst b/source/standard/SIDS/misc.rst index 041c926b..9a4152f3 100644 --- a/source/standard/SIDS/misc.rst +++ b/source/standard/SIDS/misc.rst @@ -264,19 +264,21 @@ If present, these two entities take precedence over all corresponding entities a The :sidskey:`UserDefinedData_t` data structure allows arbitrary user-defined data to be stored in :sidskey:`Descriptor_t` and :sidskey:`DataArray_t` children without the restrictions or implicit meanings imposed on these node types at other node locations. -.. c:function:: FUNCTION ListLength() +**FUNCTION ListLength()** - :return value: ``int`` - :dependencies: :sidskey:`PointList`, :sidskey:`PointRange[]` + *Return value:* ``int`` + + *Dependencies:* :sidskey:`PointList`, :sidskey:`PointRange[]` :sidskey:`DiscreteData_t` requires the structure function :sidskey:`ListLength`, which is used to specify the number of entities (e.g. vertices) corresponding to a given :sidskey:`PointRange` or :sidskey:`PointList`. If :sidskey:`PointRange` is specified, then :sidskey:`ListLength` is obtained from the number of points (inclusive) between the beginning and ending indices of :sidskey:`PointRange`. If :sidskey:`PointList` is specified, then :sidskey:`ListLength` is the number of indices in the list of points. In this situation, :sidskey:`ListLength` becomes a user input along with the indices of the list :sidskey:`PointList`. By user we mean the application code that is generating the CGNS database. -.. c:function:: FUNCTION DataSize() +**FUNCTION DataSize()** + + *Return value:* one-dimensional ``int`` array of length :sidskey:`IndexDimension` - :return value: one-dimensional ``int`` array of length :sidskey:`IndexDimension` - :dependencies: :sidskey:`IndexDimension`, :sidskey:`VertexSize[]`, :sidskey:`CellSize[]`, :sidskey:`GridLocation`, :sidskey:`Rind`, :sidskey:`ListLength[]` + *Dependencies:* :sidskey:`IndexDimension`, :sidskey:`VertexSize[]`, :sidskey:`CellSize[]`, :sidskey:`GridLocation`, :sidskey:`Rind`, :sidskey:`ListLength[]` The function :sidskey:`DataSize[]` is the size of discrete-data arrays. It is identical to the function :sidskey:`DataSize[]` defined for :sidskey:`FlowSolution_t`. diff --git a/source/standard/SIDS/multizone.rst b/source/standard/SIDS/multizone.rst index 5079c8eb..78387847 100644 --- a/source/standard/SIDS/multizone.rst +++ b/source/standard/SIDS/multizone.rst @@ -757,10 +757,11 @@ The grid points making up a hole within a zone may be specified by :sidskey:`Poi The :sidsref:`UserDefinedData_t` data structure allows arbitrary user-defined data to be stored in :sidskey:`Descriptor_t` and :sidskey:`DataArray_t` children without the restrictions or implicit meanings imposed on these node types at other node locations. -.. c:function:: FUNCTION PointListSize() +**FUNCTION PointListSize()** - :return value: ``int`` - :dependencies: :sidskey:`PointList` + *Return value:* ``int`` + + *Dependencies:* :sidskey:`PointList` :sidskey:`OversetHoles_t` requires one structure function, :sidskey:`PointListSize`, to identify the length of the :sidskey:`PointList` array. :sidskey:`PointListSize` is a user input. (See the discussion on function :ref:`PointListSize `.) diff --git a/source/standard/SIDS/particles.rst b/source/standard/SIDS/particles.rst index ddb51156..599cf563 100644 --- a/source/standard/SIDS/particles.rst +++ b/source/standard/SIDS/particles.rst @@ -206,10 +206,11 @@ The :sidsref:`UserDefinedData_t` data structure allows arbitrary user-defined da .. _DataSizeParticle: -.. c:function:: FUNCTION DataSize() +**FUNCTION DataSize()** - :return value: ``int`` - :dependencies: :sidskey:`PointRange`, :sidskey:`PointList` + *Return value:* ``int`` + + *Dependencies:* :sidskey:`PointRange`, :sidskey:`PointList` :sidskey:`ParticleSolution_t` requires the structure function :sidskey:`DataSize`, which is used to specify the number of entities corresponding to a given :sidskey:`PointRange` or :sidskey:`PointList`. This will therefore be the size of the :sidskey:`ParticleSolution` data arrays. If :sidskey:`PointRange` is specified, then :sidskey:`DataSize` is obtained from the number of points (inclusive) between the beginning and ending indices of :sidskey:`PointRange`. If :sidskey:`PointList` is specified, then :sidskey:`DataSize` is the number of indices in the list of points. In this situation, :sidskey:`DataSize` becomes a user input along with the indices of the list :sidskey:`PointList`. By "user", we mean the application code that is generating the CGNS database. diff --git a/source/standard/SIDS/time.rst b/source/standard/SIDS/time.rst index 726da4e5..e30b9f75 100644 --- a/source/standard/SIDS/time.rst +++ b/source/standard/SIDS/time.rst @@ -329,10 +329,11 @@ Point-by-point grid velocity may also lead to relative motion of grid zones, or However, no attempt is made here to require that the :sidsref:`ZoneGridConnectivity_t` information be updated to be consistent with the new grid locations. Whether the :sidskey:`ZoneGridConnectivity_t` information refers to the original connectivity (of :sidsref:`GridCoordinates`) or the latest connectivity (of the moved or deformed grid) is currently left up to the user. -.. c:function:: FUNCTION DataSize() +**FUNCTION DataSize()** - :return value: one-dimensional ``int`` array of length :sidskey:`IndexDimension` - :dependencies: :sidskey:`IndexDimension`, :sidskey:`VertexSize[]`, :sidskey:`CellSize[]`, :sidskey:`GridLocation`, :sidskey:`Rind` + *Return value:* one-dimensional ``int`` array of length :sidskey:`IndexDimension` + + *Dependencies:* :sidskey:`IndexDimension`, :sidskey:`VertexSize[]`, :sidskey:`CellSize[]`, :sidskey:`GridLocation`, :sidskey:`Rind` The function :sidskey:`DataSize[]` is the size of the DataArrays containing the grid velocity components. It is identical to the function :sidskey:`DataSize[]` defined for :sidsref:`FlowSolution_t`. From 99bc78bb89815ca92d20d66bb47e3b3931cf7fab Mon Sep 17 00:00:00 2001 From: Scot Breitenfeld Date: Mon, 5 Jan 2026 10:25:38 -0600 Subject: [PATCH 2/2] reverted commented out ex_tetra_4 figure --- CGNS | 2 +- source/standard/SIDS/grid.rst | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/CGNS b/CGNS index a8440dc8..c568dcbb 160000 --- a/CGNS +++ b/CGNS @@ -1 +1 @@ -Subproject commit a8440dc892a9a8d6a27c0716e7a1c201d5b22cb0 +Subproject commit c568dcbbe1a68579d5ccad34267c916e51f47ac9 diff --git a/source/standard/SIDS/grid.rst b/source/standard/SIDS/grid.rst index 6f5c858f..5767c70b 100644 --- a/source/standard/SIDS/grid.rst +++ b/source/standard/SIDS/grid.rst @@ -452,14 +452,12 @@ Example - TETRA_4 Element Types This example uses a simple three-element tetrahedral grid. -.. .. figure:: ../../../images/sids/figs/ex_tetra.gif -.. :width: 400px -.. :align: center -.. :alt: Unstructured grid consisting of three tetrahedra -.. -.. *Example Tetrahedral Grid* -.. -.. (Figure pending - ex_tetra.gif not found) +.. figure:: ../../../images/sids/figs/ex_tetra.gif + :width: 400px + :align: center + :alt: Unstructured grid consisting of three tetrahedra + + *Example Tetrahedral Grid* The element type is :sidskey:`TETRA_4`, and the connectivity is defined in :sidskey:`ElementConnectivity` by specifying the four nodes comprising each element, with the order consistent with the :ref:`numbering conventions for tetrahedral elements `. The data in :sidskey:`ElementConnectivity` is grouped by element; note that the parentheses are added here for presentation purposes only.