InputsBoundaryConditionProvider

class ansys.dpf.core.operators.metadata.boundary_condition_provider.InputsBoundaryConditionProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to boundary_condition_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.boundary_condition_provider()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> 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_property = int()
>>> op.inputs.property.connect(my_property)

Overview

Methods

connect

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

Properties

time_scoping	Allows to connect time_scoping input to the operator.
streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.
property	Allows to connect property input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.boundary_condition_provider import InputsBoundaryConditionProvider

Property detail

property InputsBoundaryConditionProvider.time_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping]

Allows to connect time_scoping input to the operator.

Time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.boundary_condition_provider()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)

property InputsBoundaryConditionProvider.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.metadata.boundary_condition_provider()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsBoundaryConditionProvider.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.metadata.boundary_condition_provider()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property InputsBoundaryConditionProvider.property: ansys.dpf.core.inputs.Input[int]

Allows to connect property input to the operator.

Type of boundary condition to get.

Available boundary conditions are : - Applied Force : 1 - Fixed Displacement : 2 - Applied Pressure : 3 - Fixed Temperature : 4 - Applied Heat Flux : 5 - Fluid Temperature : 6 - Film Coefficient Convection : 7 - Ambient Temperature : 8 - Spatial Integrand : 9 - Fixed Rotation : 10 - Fixed Acceleration : 11 - Fixed Velocity : 12

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.boundary_condition_provider()
>>> op.inputs.property.connect(my_property)
>>> # or
>>> op.inputs.property(my_property)

Method detail

InputsBoundaryConditionProvider.__str__()

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

InputsBoundaryConditionProvider.__call__(inpt)

InputsBoundaryConditionProvider.__getitem__(item) → Input