InputsEnthalpy

class ansys.dpf.core.operators.result.enthalpy.InputsEnthalpy(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to enthalpy operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.enthalpy()
>>> 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_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_region_scoping = dpf.Scoping()
>>> op.inputs.region_scoping.connect(my_region_scoping)
>>> my_qualifiers1 = dict()
>>> op.inputs.qualifiers1.connect(my_qualifiers1)
>>> my_qualifiers2 = dict()
>>> op.inputs.qualifiers2.connect(my_qualifiers2)

Overview

Properties

time_scoping	Allows to connect time_scoping input to the operator.
mesh_scoping	Allows to connect mesh_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.
mesh	Allows to connect mesh input to the operator.
region_scoping	Allows to connect region_scoping input to the operator.
qualifiers1	Allows to connect qualifiers1 input to the operator.
qualifiers2	Allows to connect qualifiers2 input to the operator.

Import detail

from ansys.dpf.core.operators.result.enthalpy import InputsEnthalpy

Property detail

property InputsEnthalpy.time_scoping

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.

Parameters:

my_time_scoping (Scoping or int or float or Field)

Examples

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

property InputsEnthalpy.mesh_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

Parameters:

my_mesh_scoping (ScopingsContainer or Scoping)

Examples

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

property InputsEnthalpy.streams_container

Allows to connect streams_container input to the operator.

Result file container allowed to be kept open to cache data

Parameters:

my_streams_container (StreamsContainer)

Examples

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

property InputsEnthalpy.data_sources

Allows to connect data_sources input to the operator.

Result file path container, used if no streams are set

Parameters:

my_data_sources (DataSources)

Examples

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

property InputsEnthalpy.mesh

Allows to connect mesh input to the operator.

Prevents from reading the mesh in the result files

Parameters:

my_mesh (MeshedRegion or MeshesContainer)

Examples

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

property InputsEnthalpy.region_scoping

Allows to connect region_scoping input to the operator.

Region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for fluid results or part for lsdyna results).

Parameters:

my_region_scoping (Scoping or int)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.enthalpy()
>>> op.inputs.region_scoping.connect(my_region_scoping)
>>> # or
>>> op.inputs.region_scoping(my_region_scoping)

property InputsEnthalpy.qualifiers1

Allows to connect qualifiers1 input to the operator.

(for fluid results only) labelspace with combination of zone, phases or species ids

Parameters:

my_qualifiers1 (dict)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.enthalpy()
>>> op.inputs.qualifiers1.connect(my_qualifiers1)
>>> # or
>>> op.inputs.qualifiers1(my_qualifiers1)

property InputsEnthalpy.qualifiers2

Allows to connect qualifiers2 input to the operator.

(for fluid results only) labelspace with combination of zone, phases or species ids

Parameters:

my_qualifiers2 (dict)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.enthalpy()
>>> op.inputs.qualifiers2.connect(my_qualifiers2)
>>> # or
>>> op.inputs.qualifiers2(my_qualifiers2)