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

.. index::
    ! NXphase (base class)
    ! phase (base class)
    see: phase (base class); NXphase

.. _NXphase:

=======
NXphase
=======

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Base class to describe a (thermodynamic) phase as a component of a material. ...

      Base class to describe a (thermodynamic) phase as a component of a material.

      Instances of phases can be crystalline.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXatom`, :ref:`NXmicrostructure_ipf`, :ref:`NXmicrostructure_odf`, :ref:`NXmicrostructure_pf`, :ref:`NXmicrostructure`, :ref:`NXunit_cell`

.. index:: NXunit_cell (base class); used in base class, NXatom (base class); used in base class, NXmicrostructure_ipf (base class); used in base class, NXmicrostructure_odf (base class); used in base class, NXmicrostructure_pf (base class); used in base class, NXmicrostructure (base class); used in base class

**Structure**:

  .. _/NXphase/phase_id-field:

  .. index:: phase_id (field)

  **phase_id**: (optional) :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    .. collapse:: Identifier for each phase. ...

        Identifier for each phase.

        The value 0 is reserved for the unknown phase that represents the
        null-model (no sufficiently significant information available).
        In other words, the phase_name is n/a aka notIndexed.

        The  phase_id value should match with the integer suffix of the
        group name which represents that instance in a NeXus/HDF5 file, i.e.
        if three phases were used e.g. 0, 1, and 2, three instances of
        :ref:`NXphase` named phase0, phase1, and phase2 should be stored
        in that HDF5 file.

  .. _/NXphase/name-field:

  .. index:: name (field)

  **name**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Given name as an alias for identifying this phase. ...

        Given name as an alias for identifying this phase.

        If the  phase_id is 0 and one would like to use
        the field name, the value should be n/a or notIndexed.

  .. _/NXphase/UNIT_CELL-group:

  :bolditalic:`UNIT_CELL`: (optional) :ref:`NXunit_cell` 


  .. _/NXphase/ATOM-group:

  :bolditalic:`ATOM`: (optional) :ref:`NXatom` 


  .. _/NXphase/MICROSTRUCTURE_IPF-group:

  :bolditalic:`MICROSTRUCTURE_IPF`: (optional) :ref:`NXmicrostructure_ipf` 


  .. _/NXphase/MICROSTRUCTURE_ODF-group:

  :bolditalic:`MICROSTRUCTURE_ODF`: (optional) :ref:`NXmicrostructure_odf` 


  .. _/NXphase/MICROSTRUCTURE_PF-group:

  :bolditalic:`MICROSTRUCTURE_PF`: (optional) :ref:`NXmicrostructure_pf` 


  .. _/NXphase/MICROSTRUCTURE-group:

  :bolditalic:`MICROSTRUCTURE`: (optional) :ref:`NXmicrostructure` 



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

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


* :ref:`/NXphase/ATOM-group </NXphase/ATOM-group>`
* :ref:`/NXphase/MICROSTRUCTURE-group </NXphase/MICROSTRUCTURE-group>`
* :ref:`/NXphase/MICROSTRUCTURE_IPF-group </NXphase/MICROSTRUCTURE_IPF-group>`
* :ref:`/NXphase/MICROSTRUCTURE_ODF-group </NXphase/MICROSTRUCTURE_ODF-group>`
* :ref:`/NXphase/MICROSTRUCTURE_PF-group </NXphase/MICROSTRUCTURE_PF-group>`
* :ref:`/NXphase/name-field </NXphase/name-field>`
* :ref:`/NXphase/phase_id-field </NXphase/phase_id-field>`
* :ref:`/NXphase/UNIT_CELL-group </NXphase/UNIT_CELL-group>`

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