InputsRun

class ansys.dpf.core.operators.result.run.InputsRun(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to run operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.run()
>>> my_mapdl_exe_path = str()
>>> op.inputs.mapdl_exe_path.connect(my_mapdl_exe_path)
>>> my_working_dir = str()
>>> op.inputs.working_dir.connect(my_working_dir)
>>> my_number_of_processes = int()
>>> op.inputs.number_of_processes.connect(my_number_of_processes)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_server_mode = bool()
>>> op.inputs.server_mode.connect(my_server_mode)

Overview

Methods

connect

Connect any input (an entity or an operator output) to any input pin of this operator.

Properties

mapdl_exe_path	Allows to connect mapdl_exe_path input to the operator.
working_dir	Allows to connect working_dir input to the operator.
number_of_processes	Allows to connect number_of_processes input to the operator.
data_sources	Allows to connect data_sources input to the operator.
server_mode	Allows to connect server_mode input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.run import InputsRun

Property detail

property InputsRun.mapdl_exe_path: ansys.dpf.core.inputs.Input

Allows to connect mapdl_exe_path input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.run()
>>> op.inputs.mapdl_exe_path.connect(my_mapdl_exe_path)
>>> # or
>>> op.inputs.mapdl_exe_path(my_mapdl_exe_path)

property InputsRun.working_dir: ansys.dpf.core.inputs.Input

Allows to connect working_dir input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.run()
>>> op.inputs.working_dir.connect(my_working_dir)
>>> # or
>>> op.inputs.working_dir(my_working_dir)

property InputsRun.number_of_processes: ansys.dpf.core.inputs.Input

Allows to connect number_of_processes input to the operator.

Set the number of MPI processes used for resolution (default is 2)

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.run()
>>> op.inputs.number_of_processes.connect(my_number_of_processes)
>>> # or
>>> op.inputs.number_of_processes(my_number_of_processes)

property InputsRun.data_sources: ansys.dpf.core.inputs.Input

Allows to connect data_sources input to the operator.

data sources containing the input file.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.run()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property InputsRun.server_mode: ansys.dpf.core.inputs.Input

Allows to connect server_mode input to the operator.

used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.run()
>>> op.inputs.server_mode.connect(my_server_mode)
>>> # or
>>> op.inputs.server_mode(my_server_mode)

Method detail

InputsRun.__str__()

InputsRun.connect(inpt)

Connect any input (an entity or an operator output) to any input pin of this operator.

Searches for the input type corresponding to the output.

Deprecated since version Deprecated: in favor of explicit output-to-input connections.

Parameters:

• inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping, Enum,)

• ScopingsContainer (E501) – Input of the operator.

• MeshedRegion (E501) – Input of the operator.

• MeshesContainer (E501) – Input of the operator.

• DataSources (E501) – Input of the operator.

• CyclicSupport (E501) – Input of the operator.

• Outputs (E501) – Input of the operator.

• noqa (os.PathLike #) – Input of the operator.

InputsRun.__call__(inpt)

InputsRun.__getitem__(item) → Input