FieldDefinition#

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

Contains the physical and mathematical description of the field.

Parameters
  • field_definition (optional) – The default is None.

  • server (ansys.dpf.core.server, optional) – 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.

property unit#

Units of the field.

Returns

Units of the field.

Return type

str

property location#

Field location.

Returns

Location string, such as "Nodal", "Elemental", or "TimeFreq_sets".

Return type

str

property shell_layers#

Order of the shell layers.

Returns

shell_layersLayerIndependent is returned for fields unrelated to layers.

Return type

shell_layers

property dimensionality#

Dimensionality

Returns

dimensionality – Nature and size of the elementary data.

Return type

Dimensionality

deep_copy(server=None)#

Creates 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.

Parameters

server (DPFServer, optional) –

Returns

field_definition_copy

Return type

FieldDefinition