plaid.utils.cgns_helper
=======================

.. py:module:: plaid.utils.cgns_helper

.. autoapi-nested-parse::

   Utility functions for working with CGNS trees and nodes.



Functions
---------

.. autoapisummary::

   plaid.utils.cgns_helper.get_base_names
   plaid.utils.cgns_helper.get_time_values
   plaid.utils.cgns_helper.show_cgns_tree
   plaid.utils.cgns_helper.summarize_cgns_tree


Module Contents
---------------

.. py:function:: get_base_names(tree: plaid.types.CGNSTree, full_path: bool = False, unique: bool = False) -> list[str]

   Get a list of base names from a CGNSTree.

   :param tree: The CGNSTree containing the CGNSBase_t nodes.
   :type tree: CGNSTree
   :param full_path: If True, return full base paths including '/' separators. Defaults to False.
   :type full_path: bool, optional
   :param unique: If True, return unique base names. Defaults to False.
   :type unique: bool, optional

   :returns: A list of base names.
   :rtype: list[str]


.. py:function:: get_time_values(tree: plaid.types.CGNSTree) -> numpy.ndarray

   Get consistent time values from CGNSBase_t nodes in a CGNSTree.

   :param tree: The CGNSTree containing CGNSBase_t nodes.
   :type tree: CGNSTree

   :returns: An array of consistent time values.
   :rtype: np.ndarray

   :raises AssertionError: If the time values across bases are not consistent.


.. py:function:: show_cgns_tree(pyTree: list, pre: str = '')

   Pretty print for CGNS Tree.

   :param pyTree: CGNS tree to print
   :type pyTree: list
   :param pre: indentation of print. Defaults to ''.
   :type pre: str, optional


.. py:function:: summarize_cgns_tree(pyTree: list, verbose=True) -> str

   Provide a summary of a CGNS tree's contents.

   :param pyTree: The CGNS tree to summarize.
   :type pyTree: list
   :param verbose: If True, include detailed field information. Defaults to True.
   :type verbose: bool, optional

   .. rubric:: Example

   >>> summarize_cgns_tree(pyTree)
   Number of Bases: 2
   Number of Zones: 5
   Number of Nodes: 20
   Number of Elements: 10
   Number of Fields: 8

   Fields:
     'Base1/Zone1/Solution1/Field1'
     'Base1/Zone1/Solution1/Field2'
     'Base2/Zone2/Solution2/Field1'
     ...