InputsPartMomentum

class ansys.dpf.core.operators.result.part_momentum.InputsPartMomentum(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to part_momentum operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.part_momentum()
>>> 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)
>>> my_entity_scoping = dpf.Scoping()
>>> op.inputs.entity_scoping.connect(my_entity_scoping)
>>> my_unit_system = int()
>>> op.inputs.unit_system.connect(my_unit_system)

Overview

Methods

connect

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

Properties

streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.
entity_scoping	Allows to connect entity_scoping input to the operator.
unit_system	Allows to connect unit_system input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.part_momentum import InputsPartMomentum

Property detail

property InputsPartMomentum.streams_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.streams_container.StreamsContainer]

Allows to connect streams_container input to the operator.

result file container allowed to be kept open to cache data

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.part_momentum()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsPartMomentum.data_sources: ansys.dpf.core.inputs.Input[ansys.dpf.core.data_sources.DataSources]

Allows to connect data_sources input to the operator.

result file path container, used if no streams are set

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsPartMomentum.entity_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping]

Allows to connect entity_scoping input to the operator.

entity (part for matsum, interface for rcforc) where the result will be scoped

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.part_momentum()
>>> op.inputs.entity_scoping.connect(my_entity_scoping)
>>> # or
>>> op.inputs.entity_scoping(my_entity_scoping)

property InputsPartMomentum.unit_system: ansys.dpf.core.inputs.Input[int | str | ansys.dpf.core.unit_system.UnitSystem]

Allows to connect unit_system input to the operator.

(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.part_momentum()
>>> op.inputs.unit_system.connect(my_unit_system)
>>> # or
>>> op.inputs.unit_system(my_unit_system)

Method detail

InputsPartMomentum.__str__()

InputsPartMomentum.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.

InputsPartMomentum.__call__(inpt)

InputsPartMomentum.__getitem__(item) → Input