OutputsIsCyclic

class ansys.dpf.core.operators.metadata.is_cyclic.OutputsIsCyclic(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.outputs._Outputs

Intermediate class used to get outputs from is_cyclic operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.is_cyclic()
>>> # Connect inputs : op.inputs. ...
>>> result_file_path = op.outputs.file_path()

Overview

Properties

file_path

Allows to get file_path output of the operator

Special methods

__getitem__
__str__

Import detail

from ansys.dpf.core.operators.metadata.is_cyclic import OutputsIsCyclic

Property detail

property OutputsIsCyclic.file_path: ansys.dpf.core.outputs.Output[str]

Allows to get file_path output of the operator

returns ‘single_stage’ or ‘multi_stage’ or an empty string for non cyclic model

Returns:

An Output instance for this pin.

Return type:

output

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.is_cyclic()
>>> # Get the output from op.outputs. ...
>>> result_file_path = op.outputs.file_path()

Method detail

OutputsIsCyclic.__getitem__(index) → Output

OutputsIsCyclic.__str__()