InputsVelocity

class ansys.dpf.core.operators.result.velocity.InputsVelocity(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to velocity operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.velocity()
>>> 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_bool_rotate_to_global = bool()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_read_cyclic = int()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> 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.
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.
bool_rotate_to_global	Allows to connect bool_rotate_to_global input to the operator.
mesh	Allows to connect mesh input to the operator.
read_cyclic	Allows to connect read_cyclic 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.velocity import InputsVelocity

Property detail

property InputsVelocity.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.velocity()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)

property InputsVelocity.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.velocity()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

property InputsVelocity.fields_container

Allows to connect fields_container input to the operator.

Fields container already allocated modified inplace

Parameters:

my_fields_container (FieldsContainer)

Examples

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

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

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

property InputsVelocity.bool_rotate_to_global

Allows to connect bool_rotate_to_global input to the operator.

If true the field is rotated to global coordinate system (default true)

Parameters:

my_bool_rotate_to_global (bool)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.velocity()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> # or
>>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)

property InputsVelocity.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.velocity()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)

property InputsVelocity.read_cyclic

Allows to connect read_cyclic input to the operator.

If 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1)

Parameters:

my_read_cyclic (int)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.velocity()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # or
>>> op.inputs.read_cyclic(my_read_cyclic)

property InputsVelocity.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.velocity()
>>> op.inputs.region_scoping.connect(my_region_scoping)
>>> # or
>>> op.inputs.region_scoping(my_region_scoping)

property InputsVelocity.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.velocity()
>>> op.inputs.qualifiers1.connect(my_qualifiers1)
>>> # or
>>> op.inputs.qualifiers1(my_qualifiers1)

property InputsVelocity.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.velocity()
>>> op.inputs.qualifiers2.connect(my_qualifiers2)
>>> # or
>>> op.inputs.qualifiers2(my_qualifiers2)