is_cyclic¶

class ansys.dpf.core.operators.metadata.is_cyclic.is_cyclic(streams_container=None, data_sources=None, config=None, server=None)¶

Read if the model is cyclic form the result file.

available inputs:

streams_container (StreamsContainer) (optional)
data_sources (DataSources)

available outputs:

file_path (str)

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.metadata.is_cyclic()

>>> # Make input connections
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.metadata.is_cyclic(streams_container=my_streams_container,data_sources=my_data_sources)

>>> # Get output data
>>> result_file_path = op.outputs.file_path()

static default_config()¶

Returns the default config for a given operator. This config can then be changed to the user needs and be used to instantiate the given operator

Parameters

name (str) – Name of the operator. For example ‘U’.
server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the the global server.

property inputs¶

Enables to connect inputs to the operator

Returns: inputs
Return type: InputsIsCyclic

property outputs¶

Enables to get outputs of the operator by evaluationg it

Returns: outputs
Return type: OutputsIsCyclic

property config¶

Returns a copy of the current config of the operator. To use the config that you modify, please use operator.config = new_config or create an operator with the new config as a parameter.

Returns: config
Return type: Config

connect(pin, inpt, pin_out=0)¶

Connect an input on the operator using a pin number.

Parameters

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list of int, list of doubles, Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion, MeshesContainer, DataSources, Operator) – Object you wish to connect.
pin_out (int, optional) – In case of the input is an Operator, this is the output pin of the input Operator. Defaults to 0.

Examples

Compute the minimum of displacement by chaining the 'U' and 'min_max_fc' operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.multishells_rst)
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
array([[0.59428386, 0.00201751, 0.0006032 ]])

get_output(pin=0, output_type=None)¶

Returns the output of the operator on the pin number.

Parameters

pin (int, optional) – Number of the output pin.
output_type (core.type enum, optional) – The requested type of the output.

run()¶: Evaluate this operator

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

Intermediate class used to connect user inputs to is_cyclic operator

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.metadata.is_cyclic()
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)

property streams_container¶

Allows to connect streams_container input to the operator

pindoc: streams (result file container) (optional)

Parameters: my_streams_container (StreamsContainer,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.metadata.is_cyclic()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> #or
>>> op.inputs.streams_container(my_streams_container)

property data_sources¶

Allows to connect data_sources input to the operator

pindoc: if the stream is null then we need to get the file path from the data sources

Parameters: my_data_sources (DataSources,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.metadata.is_cyclic()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> #or
>>> op.inputs.data_sources(my_data_sources)

connect(inpt)¶

Allows you to connect any input (an entity or an operator output) to any input pin of this operator.

The matching input type corresponding to the output is looked for.

Parameters: inpt (str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, ScopingsContainer, CyclicSupport, ..., Output, Outputs, Operator) – input of the operator

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

Intermediate class used to get outputs from is_cyclic operator .. rubric:: 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()

property file_path¶

Allows to get file_path output of the operator

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

Returns: my_file_path
Return type: str,

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()

cyclic_support_provider material_provider