The ``available_result.py`` module ================================== .. py:module:: ansys.dpf.core.available_result Summary ------- .. py:currentmodule:: available_result .. tab-set:: .. tab-item:: Classes .. list-table:: :header-rows: 0 :widths: auto * - :py:obj:`~ansys.dpf.core.available_result.AvailableResult` - Represents a result that can be requested via an operator. .. tab-item:: Enums .. list-table:: :header-rows: 0 :widths: auto * - :py:obj:`~ansys.dpf.core.available_result.Homogeneity` - Enum class listing all possible homogeneity names of results. .. tab-item:: Functions .. list-table:: :header-rows: 0 :widths: auto * - :py:obj:`~available_result_from_name` - Create an instance of AvailableResult from a specified results name. .. toctree:: :titlesonly: :maxdepth: 1 :hidden: AvailableResult .. toctree:: :titlesonly: :maxdepth: 1 :hidden: Homogeneity Description ----------- AvailableResult. Module contains the class representing the results that an operator can request. Module detail ------------- .. py:function:: available_result_from_name(name) -> AvailableResult Create an instance of AvailableResult from a specified results name. :param name: Valid property name. :type name: str :returns: Instance created from specified result name. :rtype: AvailableResult