`InputsHydrostaticPressure`#

class ansys.dpf.core.operators.result.hydrostatic_pressure.InputsHydrostaticPressure(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to hydrostatic_pressure operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> 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_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_requested_location = str()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> my_read_beams = bool()
>>> op.inputs.read_beams.connect(my_read_beams)
>>> my_split_shells = bool()
>>> op.inputs.split_shells.connect(my_split_shells)
>>> my_shell_layer = int()
>>> op.inputs.shell_layer.connect(my_shell_layer)
>>> my_extend_to_mid_nodes = bool()
>>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)

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.
`mesh_scoping`	Allows to connect mesh_scoping input to the operator.
`fields_container`	Allows to connect fields_container 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.
`mesh`	Allows to connect mesh input to the operator.
`requested_location`	Allows to connect requested_location input to the operator.
`read_beams`	Allows to connect read_beams input to the operator.
`split_shells`	Allows to connect split_shells input to the operator.
`shell_layer`	Allows to connect shell_layer input to the operator.
`extend_to_mid_nodes`	Allows to connect extend_to_mid_nodes input to the operator.

Special methods

`__str__`
`__call__`
`__getitem__`

Import detail#

from ansys.dpf.core.operators.result.hydrostatic_pressure import InputsHydrostaticPressure

Property detail#

property InputsHydrostaticPressure.time_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping | int | float | ansys.dpf.core.field.Field]#

Allows to connect time_scoping input to the operator.

time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on “TimeFreq_steps”. Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.

Returns:: An Input instance for this pin.
Return type:: input

Examples

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

property InputsHydrostaticPressure.mesh_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scopings_container.ScopingsContainer | ansys.dpf.core.scoping.Scoping]#

Allows to connect mesh_scoping input to the operator.

nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping’s location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

property InputsHydrostaticPressure.fields_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]#

Allows to connect fields_container input to the operator.

Fields container already allocated modified inplace

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)

property InputsHydrostaticPressure.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.hydrostatic_pressure()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsHydrostaticPressure.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.hydrostatic_pressure()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property InputsHydrostaticPressure.mesh: ansys.dpf.core.inputs.Input[ansys.dpf.core.meshed_region.MeshedRegion | ansys.dpf.core.meshes_container.MeshesContainer]#

Allows to connect mesh input to the operator.

prevents from reading the mesh in the result files

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)

property InputsHydrostaticPressure.requested_location: ansys.dpf.core.inputs.Input[str]#

Allows to connect requested_location input to the operator.

requested location Nodal, Elemental or ElementalNodal

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)

property InputsHydrostaticPressure.read_beams: ansys.dpf.core.inputs.Input[bool]#

Allows to connect read_beams input to the operator.

elemental nodal beam results are read if this pin is set to true (default is false)

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # or
>>> op.inputs.read_beams(my_read_beams)

property InputsHydrostaticPressure.split_shells: ansys.dpf.core.inputs.Input[bool]#

Allows to connect split_shells input to the operator.

If true, this pin forces the results to be split by element shape, indicated by the presence of the ‘elshape’ label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.split_shells.connect(my_split_shells)
>>> # or
>>> op.inputs.split_shells(my_split_shells)

property InputsHydrostaticPressure.shell_layer: ansys.dpf.core.inputs.Input[int]#

Allows to connect shell_layer input to the operator.

If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.shell_layer.connect(my_shell_layer)
>>> # or
>>> op.inputs.shell_layer(my_shell_layer)

property InputsHydrostaticPressure.extend_to_mid_nodes: ansys.dpf.core.inputs.Input[bool]#

Allows to connect extend_to_mid_nodes input to the operator.

Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.hydrostatic_pressure()
>>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
>>> # or
>>> op.inputs.extend_to_mid_nodes(my_extend_to_mid_nodes)

Method detail#

InputsHydrostaticPressure.__str__()#

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

InputsHydrostaticPressure.__call__(inpt)#

InputsHydrostaticPressure.__getitem__(item) → Input#

InputsHydrostaticPressure#

Overview#

Import detail#

Property detail#

Method detail#

`InputsHydrostaticPressure`#