ansys.dpf.core.FieldDefinition#

class ansys.dpf.core.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 location#

Field location.

Returns:: Location string, such as ansys.dpf.core.locations.nodal, ansys.dpf.core.locations.elemental or ansys.dpf.core.locations.time_freq.
Return type:: str

property name#

Field name.

property unit#

Units of the field.

property shell_layers#

Order of the shell layers.

Returns:: shell_layers – LayerIndependent is returned for fields unrelated to layers.
Return type:: shell_layers

property dimensionality#

Dimensionality.

property quantity_types#

Getter for Quantity Types.

Returns:: All quantity types of the elementary data for this FieldDefinition.
Return type:: str

add_quantity_type(quantity_type_to_add)#

Add a new Quantity Type.

num_quantity_types()#

Return number of available quantity types.

is_of_quantity_type(quantity_type)#

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

Parameters:: quantity_type (str) – Quantity type to check
Returns:: is_of_quantity_type – True if the field definition is of the given quantity type
Return type:: bool

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.