ansys.dpf.core.FieldDefinition
==============================

.. py:class:: ansys.dpf.core.FieldDefinition(field_definition=None, server=None)

   Contains the physical and mathematical description of the field.

   :param field_definition: The default is ``None``.
   :type field_definition: optional
   :param server: Server with the channel connected to the remote or local instance.
                  The default is ``None``, in which case an attempt is made to use
                  the global server.
   :type server: ansys.dpf.core.server, optional


   .. py:attribute:: _server


   .. py:attribute:: _api


   .. py:property:: location

      Field location.

      :returns: Location string, such as :class:`ansys.dpf.core.locations.nodal`,
                :class:`ansys.dpf.core.locations.elemental` or
                :class:`ansys.dpf.core.locations.time_freq`.
      :rtype: str


   .. py:property:: name

      Field name.

      :rtype: str


   .. py:property:: unit

      Units of the field.

      :returns: Units of the field.
      :rtype: str


   .. py:property:: shell_layers

      Order of the shell layers.

      :returns: **shell_layers** -- ``LayerIndependent`` is returned for fields unrelated to layers.
      :rtype: shell_layers


   .. py:property:: dimensionality

      Dimensionality.

      :returns: **dimensionality** -- Nature and size of the elementary data.
      :rtype: Dimensionality


   .. py:property:: quantity_types

      Getter for Quantity Types.

      :returns: All quantity types of the elementary data for this FieldDefinition.
      :rtype: str


   .. py:method:: add_quantity_type(quantity_type_to_add)

      Add a new Quantity Type.

      :param quantity_type_to_add: Quantity type to add
      :type quantity_type_to_add: str



   .. py:method:: num_quantity_types()

      Return number of available quantity types.

      :returns: **num_quantity_types** -- Number of quantity types
      :rtype: int



   .. py:method:: is_of_quantity_type(quantity_type)

      Check if the field definition is of a given quantity type.

      :param quantity_type: Quantity type to check
      :type quantity_type: str

      :returns: **is_of_quantity_type** -- True if the field definition is of the given quantity type
      :rtype: bool



   .. py:method:: deep_copy(server=None)

      Create a deep copy of the field_definition's data on a given server.

      This can be useful to pass data from one server instance to another.

      :param server:
      :type server: DPFServer, optional

      :returns: **field_definition_copy**
      :rtype: FieldDefinition



   .. py:method:: __del__()

      Delete the current instance.