.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXcg_polyhedron_set.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXcg_polyhedron_set (base class)
    ! cg_polyhedron_set (base class)
    see: cg_polyhedron_set (base class); NXcg_polyhedron_set

.. _NXcg_polyhedron_set:

===================
NXcg_polyhedron_set
===================

**Status**:

  base class, extends :ref:`NXcg_primitive_set`

**Description**:

  .. collapse:: Computational geometry description of a set of polyhedra in Euclidean space. ...

      Computational geometry description of a set of polyhedra in Euclidean space.

      Polyhedra or so-called cells (especially in the convex of tessellations) are
      constructed from polygon meshes. Polyhedra may make contact to allow a usage
      of this base class for a description of tessellations.

      For the description of more complicated manifolds and especially for polyhedra
      with holes, users are advised to check if their particular needs are described
      by creating customized instances of an :ref:`NXcg_polygon_set`.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays.

  **c**: The cardinality of the set, i.e. the number of polyhedra.

  **n_e_total**: The total number of edges for all polyhedra.

  **n_f_total**: The total number of faces for all polyhedra.

**Groups cited**:
  :ref:`NXcg_face_list_data_structure`, :ref:`NXcg_half_edge_data_structure`

.. index:: NXcg_face_list_data_structure (base class); used in base class, NXcg_half_edge_data_structure (base class); used in base class

**Structure**:

  .. _/NXcg_polyhedron_set/number_of_faces-field:

  .. index:: number_of_faces (field)

  **number_of_faces**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [c]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    .. collapse:: The number of faces for each polyhedron. Faces of adjoining polyhedra ...

        The number of faces for each polyhedron. Faces of adjoining polyhedra
        are counted for each polyhedron.

  .. _/NXcg_polyhedron_set/face_area-field:

  .. index:: face_area (field)

  **face_area**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_f_total]) {units=\ :ref:`NX_AREA <NX_AREA>`} 

    Area of each of faces.

  .. _/NXcg_polyhedron_set/number_of_edges-field:

  .. index:: number_of_edges (field)

  **number_of_edges**: (optional) :ref:`NX_INT <NX_INT>` 

    .. collapse:: The number of edges for each polyhedron. Edges of adjoining polyhedra ...

        The number of edges for each polyhedron. Edges of adjoining polyhedra
        are counterd for each polyhedron.

  .. _/NXcg_polyhedron_set/edge_length-field:

  .. index:: edge_length (field)

  **edge_length**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_e_total]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Length of each edge.

  .. _/NXcg_polyhedron_set/polyhedra-group:

  **polyhedra**: (optional) :ref:`NXcg_face_list_data_structure` 

    Combined storage of all primitives of all polyhedra.

  .. _/NXcg_polyhedron_set/polyhedronID-group:

  **polyhedronID**: (optional) :ref:`NXcg_face_list_data_structure` 

    Individual storage of each polyhedron.

  .. _/NXcg_polyhedron_set/polyhedron_half_edgeID-group:

  **polyhedron_half_edgeID**: (optional) :ref:`NXcg_half_edge_data_structure` 

    Individual storage of each polygon as a graph.


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXcg_polyhedron_set/edge_length-field </NXcg_polyhedron_set/edge_length-field>`
* :ref:`/NXcg_polyhedron_set/face_area-field </NXcg_polyhedron_set/face_area-field>`
* :ref:`/NXcg_polyhedron_set/number_of_edges-field </NXcg_polyhedron_set/number_of_edges-field>`
* :ref:`/NXcg_polyhedron_set/number_of_faces-field </NXcg_polyhedron_set/number_of_faces-field>`
* :ref:`/NXcg_polyhedron_set/polyhedra-group </NXcg_polyhedron_set/polyhedra-group>`
* :ref:`/NXcg_polyhedron_set/polyhedron_half_edgeID-group </NXcg_polyhedron_set/polyhedron_half_edgeID-group>`
* :ref:`/NXcg_polyhedron_set/polyhedronID-group </NXcg_polyhedron_set/polyhedronID-group>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXcg_polyhedron_set.nxdl.xml