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

.. index::
    ! NXpump (base class)
    ! pump (base class)
    see: pump (base class); NXpump

.. _NXpump:

======
NXpump
======

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  Device to reduce an atmosphere to a controlled pressure.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXpump/design-field:

  .. index:: design (field)

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

    .. collapse:: Principle type of the pump. ...

        Principle type of the pump.

        Any of these values or a custom value (if you use a custom value, also set @custom=True):

          * ``membrane``

          * ``rotary_vane``

          * ``roots``

          * ``turbo_molecular``

          * ``ion``

          * ``cryo``

          * ``diffusion``

          * ``scroll``


  .. _/NXpump/base_pressure-field:

  .. index:: base_pressure (field)

  **base_pressure**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PRESSURE <NX_PRESSURE>`} 

    .. collapse:: The minimum pressure achievable in a chamber after ...

        The minimum pressure achievable in a chamber after
        it has been pumped down for an extended period.

  .. _/NXpump/medium-field:

  .. index:: medium (field)

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

    .. collapse:: The material being moved by the pump. ...

        The material being moved by the pump.

        Pumps intending to create a vacuum should state "vacuum" as the medium,
        while pumps having the primary purpose of creating a flow or pressure
        of gas should state "gas" as the medium.

        Any of these values: ``vacuum`` | ``liquid`` | ``gas`` | ``slurry`` | ``powder``


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

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


* :ref:`/NXpump/base_pressure-field </NXpump/base_pressure-field>`
* :ref:`/NXpump/design-field </NXpump/design-field>`
* :ref:`/NXpump/medium-field </NXpump/medium-field>`

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