Module containing the Index class and sub-classes.

Index#

class ansys.dpf.post.index.ref_labels#: Reference naming for different common Indexes.

class ansys.dpf.post.index.Index(name: str, values: List | None = None, scoping: Scoping | None = None)#

A Pandas style API to manipulate indexes.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.MeshIndex(location: locations | str, values: List[int] | None = None, scoping: Scoping | None = None, fc: FieldsContainer | None = None)#

Index class specific to mesh entities.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.ResultsIndex(values: List[str], units: List[str | None] | None = None)#

Index class specific to results.

property units: List[str]#: Return the list of units for this index.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.LabelIndex(name: str, values: List | None = None, scoping: Scoping | None = None)#

Index class specific to labels.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.TimeIndex(values: List | None = None, scoping: Scoping | None = None)#

Index class specific to time.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.ModeIndex(values: List | None = None, scoping: Scoping | None = None)#

Index class specific to modes.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.FrequencyIndex(values: List | None = None, scoping: Scoping | None = None)#

Index class specific to frequency.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.SetIndex(values: List | None = None, scoping: Scoping | None = None)#

Index class specific to set_ids.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.CompIndex(values: List | None = None)#

Index class specific to components.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.ElementNodeIndex#

Index class specific to elemental nodal results.

property name#: Returns the name of the Index.

property values#: Returns the values of the Index.

class ansys.dpf.post.index.MultiIndex(indexes: List[Index])#

A Pandas style API to manipulate multi-indexes.

property indexes: List[Index]#: Returns the list of Index in the MultiIndex.

property names#: Returns a list with the name of each Index.

property results_index: ResultsIndex | None#: Returns the available ResultsIndex if present.

property mesh_index: MeshIndex | None#: Returns the available ResultsIndex if present.

property set_index: SetIndex | None#: Returns the available SetIndex if present.