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

.. index::
    ! NXcg_cylinder (base class)
    ! cg_cylinder (base class)
    see: cg_cylinder (base class); NXcg_cylinder

.. _NXcg_cylinder:

=============
NXcg_cylinder
=============

**Status**:

  base class, extends :ref:`NXcg_primitive`

**Description**:

  .. collapse:: Computational geometry description of a set of cylinders or (truncated) cones. ...

      Computational geometry description of a set of cylinders or (truncated) cones.

      The radius can either be defined in the radii field or by filling the upper_cap_radii
      and lower_cap_radii fields respectively. The latter field case can
      thus be used to represent (truncated) cones.

      It is possible to define only one of the cap_radii fields
      to represent half-open cylinder.

**Symbols**:

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

  **d**: The dimensionality of the space in which the members are assumed embedded.

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

**Groups cited**:
  none

**Structure**:

  .. _/NXcg_cylinder/height-field:

  .. index:: height (field)

  **height**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [c, d]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXcg_primitive/height-field>`

    .. collapse:: A direction vector which is parallel to the cylinder/cone axis ...

        A direction vector which is parallel to the cylinder/cone axis
        and whose magnitude is the height of the cylinder/cone.

        The upper_cap is assumed to represent the end while the
        lower_cap is assumed to represent the start of the
        respective cylinder instances when inspecting along the
        direction vector.

  .. _/NXcg_cylinder/radius-field:

  .. index:: radius (field)

  **radius**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Radius of the cylinder if all have the same radius.

  .. _/NXcg_cylinder/radii-field:

  .. index:: radii (field)

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

    Radii of the cylinder.

  .. _/NXcg_cylinder/upper_cap_radii-field:

  .. index:: upper_cap_radii (field)

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

    .. collapse:: Radii of the upper circular cap. ...

        Radii of the upper circular cap.

        This field, combined with lower_cap_radius can be used to describe
        (eventually truncated) circular cones.

  .. _/NXcg_cylinder/lower_cap_radii-field:

  .. index:: lower_cap_radii (field)

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

    .. collapse:: Radii of the upper circular cap. ...

        Radii of the upper circular cap.

        This field, combined with upper_cap_radius can be used to describe
        (eventually truncated) circular cones.

  .. _/NXcg_cylinder/lateral_surface_area-field:

  .. index:: lateral_surface_area (field)

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

    Lateral surface area of each cylinder.

  .. _/NXcg_cylinder/upper_cap_surface_area-field:

  .. index:: upper_cap_surface_area (field)

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

    Area of the upper cap of each cylinder.

  .. _/NXcg_cylinder/lower_cap_surface_area-field:

  .. index:: lower_cap_surface_area (field)

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

    Area of the lower cap of each cylinder.

  .. _/NXcg_cylinder/total_surface_area-field:

  .. index:: total_surface_area (field)

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

    Sum of upper and lower cap area and lateral surface area of each cylinder.


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

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


* :ref:`/NXcg_cylinder/height-field </NXcg_cylinder/height-field>`
* :ref:`/NXcg_cylinder/lateral_surface_area-field </NXcg_cylinder/lateral_surface_area-field>`
* :ref:`/NXcg_cylinder/lower_cap_radii-field </NXcg_cylinder/lower_cap_radii-field>`
* :ref:`/NXcg_cylinder/lower_cap_surface_area-field </NXcg_cylinder/lower_cap_surface_area-field>`
* :ref:`/NXcg_cylinder/radii-field </NXcg_cylinder/radii-field>`
* :ref:`/NXcg_cylinder/radius-field </NXcg_cylinder/radius-field>`
* :ref:`/NXcg_cylinder/total_surface_area-field </NXcg_cylinder/total_surface_area-field>`
* :ref:`/NXcg_cylinder/upper_cap_radii-field </NXcg_cylinder/upper_cap_radii-field>`
* :ref:`/NXcg_cylinder/upper_cap_surface_area-field </NXcg_cylinder/upper_cap_surface_area-field>`

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