`Support`#

class ansys.dpf.core.support.Support(support, server=None)#

Base class for support (supporting Field’s location, Scoping’s location, Collection’s labels…).

Field, PropertyField and StringField support can be accessed generically via this base class.

Parameters:

support (ctypes.c_void_p, ansys.grpc.dpf.support_pb2.Support)
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.

Examples

Create a time frequency support from a model.

>>> from ansys.dpf.core import Model
>>> from ansys.dpf.core import examples
>>> transient = examples.download_transient_result()
>>> model = Model(transient)
>>> time_freq_support = model.metadata.time_freq_support # printable
>>> time_freq_support.available_field_supported_properties()
['time_freqs']
>>> field = time_freq_support.field_support_by_property("time_freqs")

Overview#

Methods

`field_support_by_property`	Return a Field supporting (describing) a given property.
`prop_field_support_by_property`	Return a PropertyField supporting (describing) a given property.
`string_field_support_by_property`	Return a StringField supporting (describing) a given property.
`available_field_supported_properties`	Return the list of property names supported by a Field.
`available_prop_field_supported_properties`	Return the list of property names supported by a PropertyField.
`available_string_field_supported_properties`	Return the list of property names supported by a StringField.

Special methods

__del__

Clean up resources associated with the instance.

Import detail#

from ansys.dpf.core.support import Support

Method detail#

Support.field_support_by_property(property_name: str)#

Return a Field supporting (describing) a given property.

Return type:: Field

Notes