Module containing the FluidSimulation class.

FluidSimulation

class ansys.dpf.post.fluid_simulation.FluidSimulation(result_file: PathLike | str | DataSources | None = None, cas: PathLike | str | List[PathLike | str] | None = None, dat: PathLike | str | List[PathLike | str] | None = None, flprj: PathLike | str | None = None, server: BaseServer | None = None)

Base class for fluid type simulations.

This class provides common methods and properties for all fluid type simulations.

property mesh_info: FluidMeshInfo

Return available mesh information.

property cell_zones: dict

Return a dictionary of the cell zones in the simulation.

property face_zones: dict

Return a dictionary of the face zones in the simulation.

For CFX files, we gather face zones in COMPOSITE entities more physics-related.

property species: SpeciesDict

Return a dictionary-like object of species in the simulation.

property phases: PhasesDict

Return a dictionary-like object of phases in the simulation.

density(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract density results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of faces IDs to get results for. For CFX files, these IDs correspond to the COMPOSITE that gathers the related face zones.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

density_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract density results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

density_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract density results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

density_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract density results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

dynamic_viscosity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract dynamic viscosity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

dynamic_viscosity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract dynamic viscosity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

dynamic_viscosity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract dynamic viscosity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

dynamic_viscosity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract dynamic viscosity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of cell zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

enthalpy(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract enthalpy results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

enthalpy_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract enthalpy results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

enthalpy_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract enthalpy results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

enthalpy_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract enthalpy results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of cell zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

entropy(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract entropy results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

entropy_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract entropy results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

entropy_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract entropy results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

entropy_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract entropy results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

epsilon(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract epsilon results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

epsilon_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract epsilon results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

epsilon_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract epsilon results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

epsilon_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract epsilon results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mach_number(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract mach number results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mach_number_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mach number results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mach_number_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mach number results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mach_number_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mach number results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mass_flow_rate(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mass flow rate results on faces from the simulation.

Note

This is an integrated result only available on faces.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mass_flow_rate_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mass flow rate results on faces from the simulation.

Note

This is an integrated result only available on faces.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mass_fraction(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract mass fraction results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mass_fraction_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mass fraction results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mass_fraction_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mass fraction results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mass_fraction_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mass fraction results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_static_pressure(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract mean static pressure results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_static_pressure_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean static pressure results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_static_pressure_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean static pressure results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_static_pressure_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean static pressure results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_temperature(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract mean temperature results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_temperature_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean temperature results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_temperature_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean temperature results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_temperature_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean temperature results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_velocity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract mean velocity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_velocity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean velocity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_velocity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean velocity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

mean_velocity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract mean velocity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

omega(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract omega results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

omega_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract omega results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

omega_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract omega results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

omega_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract omega results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_static_pressure(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract RMS static pressure results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_static_pressure_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS static pressure results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_static_pressure_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS static pressure results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_static_pressure_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS static pressure results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_temperature(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract RMS temperature results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_temperature_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS temperature results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_temperature_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS temperature results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_temperature_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS temperature results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_velocity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract RMS velocity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_velocity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS velocity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_velocity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS velocity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

rms_velocity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract RMS velocity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

specific_heat(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract specific heat results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

specific_heat_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract specific heat results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

specific_heat_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract specific heat results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

specific_heat_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract specific heat results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

static_pressure(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract static pressure results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

static_pressure_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract static pressure results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

static_pressure_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract static pressure results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

static_pressure_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract static pressure results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

superficial_velocity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract superficial velocity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

superficial_velocity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract superficial velocity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

superficial_velocity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract superficial velocity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

superficial_velocity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract superficial velocity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

surface_heat_rate(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract surface heat rate results on faces from the simulation.

Note

This is an integrated result only available on faces.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

surface_heat_rate_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract surface heat rate results on faces from the simulation.

Note

This is an integrated result only available on faces.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

temperature(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract temperature results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

temperature_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract temperature results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

temperature_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract temperature results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

temperature_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract temperature results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

thermal_conductivity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract thermal conductivity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

thermal_conductivity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract thermal conductivity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

thermal_conductivity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract thermal conductivity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

thermal_conductivity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract thermal conductivity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_pressure(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract total pressure results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_pressure_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract total pressure results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_pressure_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract total pressure results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_pressure_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract total pressure results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_temperature(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract total temperature results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_temperature_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract total temperature results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_temperature_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract total temperature results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

total_temperature_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract total temperature results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_kinetic_energy(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract turbulent kinetic energy results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_kinetic_energy_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract turbulent kinetic energy results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_kinetic_energy_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract turbulent kinetic energy results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_kinetic_energy_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract turbulent kinetic energy results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_viscosity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract turbulent viscosity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_viscosity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract turbulent viscosity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_viscosity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract turbulent viscosity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

turbulent_viscosity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract turbulent viscosity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

velocity(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract velocity results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

velocity_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract velocity results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

velocity_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract velocity results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

velocity_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract velocity results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

volume_fraction(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract volume fraction results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

volume_fraction_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract volume fraction results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

volume_fraction_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract volume fraction results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

volume_fraction_on_cells(cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract volume fraction results on cells from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and cell_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

wall_shear_stress(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract wall shear stress results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

wall_shear_stress_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract wall shear stress results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

wall_shear_stress_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, components: str | List[str] | int | List[int] | None = None, norm: bool = False, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract wall shear stress results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• components (Optional[Union`[:py:class:`str, List[str], int, List[int]]], default: None) – Components to get results for. Available components are “X”, “Y”, “Z”, and their respective equivalents 1, 2, 3.

• norm (bool, default: False) – Whether to return the norm of the results.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

y_plus(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None, location: locations | str | None = None)

Extract y+ results from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

• location (Optional[locations, str]], default: None) – Location to extract results at. Available locations are listed in class:post.locations and are: post.locations.nodal, post.locations.elemental, and post.locations.faces. If no location is given, the result is returned as it is stored in the result file. Using post.locations.elemental gives results with one value for each cell, while using post.locations.nodal gives results with one value for each node.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

y_plus_on_nodes(node_ids: List[int] | None = None, face_ids: List[int] | None = None, cell_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract y+ results on nodes from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, cell_ids, face_ids, and node_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• node_ids (Optional[List[int]], default: None) – List of IDs of nodes to get results for.

• face_ids (Optional[List[int]], default: None) – List of IDs of faces which nodes to get results for.

• cell_ids (Optional[List[int]], default: None) – List of IDs of cells which nodes to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

y_plus_on_faces(face_ids: List[int] | None = None, zone_ids: List[int] | None = None, phases: List[int | str] | None = None, species: List[int] | None = None, qualifiers: dict | None = None, times: float | List[float] | None = None, set_ids: int | List[int] | None = None, all_sets: bool = False, named_selections: List[str] | str | None = None, selection: Selection | None = None)

Extract y+ results on faces from the simulation.

Arguments selection, set_ids, all_sets, and times are mutually exclusive. If none of the above is given, only the last result will be returned.

Arguments selection, named_selections, and face_ids are mutually exclusive. If none of the above is given, results will be extracted for the whole mesh.

Argument qualifiers overrides arguments zones_ids, phases, and species.

Parameters:

• face_ids (Optional[List[int]], default: None) – List of IDs of faces to get results for.

• zone_ids (Optional[List[int]], default: None) – List of IDs of zones to get results for.

• phases (Optional[List[Union[int, str]]], default: None) – List of IDs of phases to get results for.

• species (Optional[List[int]], default: None) – List of IDs of species to get results for.

• qualifiers (Optional[dict], default: None) – Dictionary of qualifier labels with associated values to get results for. Overrides any other qualifier argument such as phases, species or zone_ids.

• times (Optional[Union`[:py:class:`float, List[float]]], default: None) – List of time values to get results for.

• set_ids (Optional[Union`[:py:class:`int, List[int]]], default: None) – Sets to get results for. A set is defined as a unique combination of {time, load step, sub-step}.

• all_sets (bool, default: False) – Whether to get results for all sets.

• named_selections (Optional[List[str], str]], default: None) – Named selection or list of named selections to get results for.

• selection (Optional[Selection], default: None) – Selection to get results for. A Selection defines both spatial and time-like criteria for filtering.

Return type:

Returns a ansys.dpf.post.data_object.DataFrame instance.

property active_selection: Selection | None

Active selection used by default for result queries.

Returns a :object:`ansys.dpf.post.selection.Selection` object.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> selection = post.selection.Selection()
>>> simulation.active_selection = selection
>>> print(simulation.active_selection) 
<ansys.dpf.post.selection.Selection object at ...>

deactivate_selection()

Deactivate the currently active selection.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> selection = post.selection.Selection()
>>> simulation.active_selection = selection
>>> print(simulation.active_selection) 
<ansys.dpf.post.selection.Selection object at ...>
>>> simulation.deactivate_selection()
>>> print(simulation.active_selection) 
None

property geometries

List of constructed geometries in the simulation.

Returns a list of geometry objects.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> print(simulation.geometries) 
[]

property mesh: Mesh

Mesh representation of the model.

Returns a ansys.dpf.post.mesh.Mesh object.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> print(simulation.mesh) 
    DPF  Mesh:
      81 nodes
      8 elements
      Unit: m
      With solid (3D) elements

property named_selections: List[str]

List of named selections in the simulation.

Returns a list of named selections names.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> print(simulation.named_selections) 
['_FIXEDSU']

plot(mesh: bool = True, constructed_geometries: bool = True, loads: bool = True, boundary_conditions: bool = True, **kwargs)

General plot of the simulation object.

Plots by default the complete mesh contained in the simulation, as well as a representation of the constructed geometry, the loads, and the boundary conditions currently defined. Each representation can be deactivated with its respective boolean argument.

Parameters:

• mesh (bool, default: True) – Whether to plot the mesh representation.

• constructed_geometries (bool, default: True) – Whether to plot the constructed geometries.

• loads (bool, default: True) – Whether to plot the loads.

• boundary_conditions (bool, default: True) – Whether to plot the boundary conditions.

• **kwargs – Additional keyword arguments for the plotter. More information are available at pyvista.plot().

Returns:

Returns a plotter instance of the active visualization backend.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> simulation.plot() 

release_streams()

Release the streams to data files if any is active.

property result_info

Return information concerning the available results.

property results: List[AvailableResult]

Available results.

Returns a list of available results.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post import examples
>>> simulation = post.load_simulation(examples.static_rst)
>>> print(simulation.results) 
[...]

property set_ids: List

Returns the list of set IDs available in the simulation.

split_mesh_by_properties(properties: List[elemental_properties] | Dict[elemental_properties, int | List[int]])

Splits the simulation Mesh according to properties and returns it as Meshes.

Parameters:

properties (Union[List[elemental_properties], Dict[elemental_properties, Union[int, List[int]]]]) – Elemental properties to split the global mesh by. Returns all meshes if a list, or returns only meshes for certain elemental property values if a dict with elemental properties labels with associated value or list of values.

Return type:

A Meshes entity with resulting meshes.

Examples

>>> from ansys.dpf import post
>>> from ansys.dpf.post.common import elemental_properties
>>> from ansys.dpf.post import examples
>>> example_path = examples.download_all_kinds_of_complexity()
>>> simulation = post.StaticMechanicalSimulation(example_path)
>>> # Split by elemental properties and get all resulting meshes
>>> meshes_split = simulation.split_mesh_by_properties(
...     properties=[elemental_properties.material,
...                 elemental_properties.element_shape]
... )
>>> # Split by elemental properties and only get meshes for certain property values
>>> # Here: split by material and shape, return only for material 1 and shapes 0 and 1
>>> meshes_filtered = simulation.split_mesh_by_properties(
...     properties={elemental_properties.material: 1,
...                 elemental_properties.element_shape: [0, 1]}
... )

property time_freq_support: TimeFreqSupport

Description of the temporal/frequency analysis of the model.

property units

Returns the current units used.