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")

field_support_by_property(property_name: str)

Returns a Field supporting (describing) a given property.

Return type:

Field

Notes

Available with server’s version starting at 5.0.

prop_field_support_by_property(property_name: str)

Returns a PropertyField supporting (describing) a given property.

Return type:

PropertyField

Notes

Available with server’s version starting at 5.0.

string_field_support_by_property(property_name: str)

Returns a StringField supporting (describing) a given property.

Return type:

StringField

Notes

Available with server’s version starting at 5.0.

available_field_supported_properties()

Returns the list of property names supported by a Field.

Return type:

list

Notes

Available with server’s version starting at 5.0.

available_prop_field_supported_properties()

Returns the list of property names supported by a PropertyField.

Return type:

list

Notes

Available with server’s version starting at 5.0.

available_string_field_supported_properties()

Returns the list of property names supported by a StringField.

Return type:

list

Notes

Available with server’s version starting at 5.0.