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

.. index::
    ! NXcs_processor (base class)
    ! cs_processor (base class)
    see: cs_processor (base class); NXcs_processor

.. _NXcs_processor:

==============
NXcs_processor
==============

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: Base class for reporting the description of processing units of a computer. ...

      Base class for reporting the description of processing units of a computer.

      Examples are e.g. classical so-called central processing units (CPUs),
      coprocessors, graphic cards, accelerator processing units or a system of these.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcircuit`

.. index:: NXcircuit (base class); used in base class

**Structure**:

  .. _/NXcs_processor/CIRCUIT-group:

  :bolditalic:`CIRCUIT`: (optional) :ref:`NXcircuit` 

    .. collapse:: Typical examples for the granularization of processing units are: ...

        Typical examples for the granularization of processing units are:

        * A desktop computer with a single CPU; describe using one instance of NXcircuit.
        * A dual-socket server; describe using two instances of NXcircuit.
        * A server with two dual-socket server nodes; describe with four
          instances of NXcircuit surplus a field that defines their level
          in the hierarchy.

    .. _/NXcs_processor/CIRCUIT/type-field:

    .. index:: type (field)

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

      .. collapse:: General type of the processing unit e.g. ...

          General type of the processing unit e.g.

          * pu, processing core or hyper-threading core
          * cpu, (multi-)core central processing unit
          * gpu, (multi-)core general purpose processing unit
          * fpga, field programmable gate array

          Any of these values or a custom value (if you use a custom value, also set @custom=True): ``pu`` | ``cpu`` | ``gpu`` | ``fpga``

    .. _/NXcs_processor/CIRCUIT/clock_speed-field:

    .. index:: clock_speed (field)

    **clock_speed**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` 

      Clock speed of the circuit


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

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


* :ref:`/NXcs_processor/CIRCUIT-group </NXcs_processor/CIRCUIT-group>`
* :ref:`/NXcs_processor/CIRCUIT/clock_speed-field </NXcs_processor/CIRCUIT/clock_speed-field>`
* :ref:`/NXcs_processor/CIRCUIT/type-field </NXcs_processor/CIRCUIT/type-field>`

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