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

.. index::
    ! NXmicrostructure_slip_system (base class)
    ! microstructure_slip_system (base class)
    see: microstructure_slip_system (base class); NXmicrostructure_slip_system

.. _NXmicrostructure_slip_system:

============================
NXmicrostructure_slip_system
============================

**Status**:

  *base class* (contribution), extends :ref:`NXobject`

**Description**:

  Base class for describing a set of crystallographic slip systems.

**Symbols**:

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

  **n**: Number of slip systems.

  **m**: Number of indices used for reporting Miller (3) or Miller-Bravais indices (4).

**Groups cited**:
  none

**Structure**:

  .. _/NXmicrostructure_slip_system/lattice_type-field:

  .. index:: lattice_type (field)

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

    .. collapse:: Bravais lattice type ...

        Bravais lattice type

        Any of these values:

          * ``triclinic``

          * ``monoclinic``

          * ``orthorhombic``

          * ``tetragonal``

          * ``trigonal``

          * ``hexagonal``

          * ``cubic``


  .. _/NXmicrostructure_slip_system/miller_plane-field:

  .. index:: miller_plane (field)

  **miller_plane**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [n, i]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    Array of Miller indices which describe the crystallographic planes.

  .. _/NXmicrostructure_slip_system/miller_direction-field:

  .. index:: miller_direction (field)

  **miller_direction**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [n, m]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    .. collapse:: Array of Miller or Miller-Bravais indices that describe the crystallographic ...

        Array of Miller or Miller-Bravais indices that describe the crystallographic
        direction.

  .. _/NXmicrostructure_slip_system/is_specific-field:

  .. index:: is_specific (field)

  **is_specific**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    .. collapse:: For each slip system a marker whether the Miller indices refer to a specific s ...

        For each slip system a marker whether the Miller indices refer to a specific slip system
        or to a set of equivalent crystallographic slip systems.


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

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


* :ref:`/NXmicrostructure_slip_system/is_specific-field </NXmicrostructure_slip_system/is_specific-field>`
* :ref:`/NXmicrostructure_slip_system/lattice_type-field </NXmicrostructure_slip_system/lattice_type-field>`
* :ref:`/NXmicrostructure_slip_system/miller_direction-field </NXmicrostructure_slip_system/miller_direction-field>`
* :ref:`/NXmicrostructure_slip_system/miller_plane-field </NXmicrostructure_slip_system/miller_plane-field>`

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