`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.
`get_type`	Type of the support as a string.
`get_as_time_freq_support`	Get the support as a TimeFreqSupport object.
`get_as_meshed_region`	Get the support as a MeshedRegion object.
`get_as_cyclic_support`	Get the support as a CyclicSupport object.
`get_as_generic_support`	Get the support as a GenericSupport object.
`deep_copy`	Create a deep copy of the Support on a given server.

Special methods

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

Available with server’s version starting at 5.0.

Support.prop_field_support_by_property(property_name: str)#

Return a PropertyField supporting (describing) a given property.

Return type:: PropertyField

Notes

Available with server’s version starting at 5.0.

Support.string_field_support_by_property(property_name: str)#

Return a StringField supporting (describing) a given property.

Return type:: StringField

Notes

Available with server’s version starting at 5.0.

Support.available_field_supported_properties()#

Return the list of property names supported by a Field.

Return type:: list

Notes

Available with server’s version starting at 5.0.

Support.available_prop_field_supported_properties()#

Return the list of property names supported by a PropertyField.

Return type:: list

Notes

Available with server’s version starting at 5.0.

Support.available_string_field_supported_properties()#

Return the list of property names supported by a StringField.

Return type:: list

Notes

Available with server’s version starting at 5.0.

Support.get_type() → str#

Type of the support as a string.

Returns:: type – Type of the support as a string
Return type:: str

Support.get_as_time_freq_support() → ansys.dpf.core.time_freq_support.TimeFreqSupport#

Get the support as a TimeFreqSupport object.

Returns:: TimeFreqSupport – TimeFreqSupport object
Return type:: TimeFreqSupport

Support.get_as_meshed_region() → ansys.dpf.core.meshed_region.MeshedRegion#

Get the support as a MeshedRegion object.

Returns:: MeshedRegion – MeshedRegion object
Return type:: MeshedRegion

Support.get_as_cyclic_support() → ansys.dpf.core.cyclic_support.CyclicSupport#

Get the support as a CyclicSupport object.

Returns:: CyclicSupport – CyclicSupport object
Return type:: CyclicSupport

Support.get_as_generic_support() → ansys.dpf.core.generic_support.GenericSupport#

Get the support as a GenericSupport object.

Returns:: GenericSupport – GenericSupport object
Return type:: GenericSupport

Support.deep_copy(server=None)#

Create a deep copy of the Support on a given server.

Parameters:: 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.
Returns:: support
Return type:: Support

Support.__del__()#

Clean up resources associated with the instance.

This method calls the deleter function to release resources. If an exception occurs during deletion, a warning is issued.

Raises:: Warning – If an exception occurs while attempting to delete resources.