ansys.dpf.core.GenericSupport
=============================

.. py:class:: ansys.dpf.core.GenericSupport(name: str = '', generic_support=None, server=None)

   Bases: :py:obj:`ansys.dpf.core.support.Support`


   Can support a location or label to describe its domain with its scope and properties.

   :param generic_support:
   :type generic_support: ctypes.c_void_p, ansys.grpc.dpf.tgeneric_support_pb2.GenericSupport
   :param server: 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.
   :type server: ansys.dpf.core.server, optional

   .. rubric:: Examples

   Create a generic support.

   >>> from ansys.dpf import core as dpf
   >>> from ansys.dpf.core import GenericSupport
   >>> support = GenericSupport("phase")
   >>> field = dpf.Field(location="phase", nature=dpf.natures.scalar)
   >>> support.set_support_of_property("viscosity", field)
   >>> field = dpf.StringField()
   >>> support.set_support_of_property("names", field)
   >>> field = dpf.PropertyField(location="phase", nature=dpf.natures.scalar)
   >>> support.set_support_of_property("type", field)
   >>> support.available_field_supported_properties()
   ['viscosity']
   >>> support.available_string_field_supported_properties()
   ['names']
   >>> support.available_prop_field_supported_properties()
   ['type']
   >>> field = support.field_support_by_property("viscosity")

   .. rubric:: Notes

   Class available with server's version starting at 5.0 (Ansys 2023R1).


   .. py:attribute:: _api


   .. py:method:: set_support_of_property(property_name: str, field_support) -> None

      Support a Property by Field data.

      :param property_name: Name of the Property.
      :type property_name: str
      :param field_support: Data supporting this property.
      :type field_support: Field, PropertyField, StringField