InputsScalarsToField

class ansys.dpf.core.operators.utility.scalars_to_field.InputsScalarsToField(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to scalars_to_field operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> my_double_or_vector_double = float()
>>> op.inputs.double_or_vector_double.connect(my_double_or_vector_double)
>>> my_unit = str()
>>> op.inputs.unit.connect(my_unit)
>>> my_location = str()
>>> op.inputs.location.connect(my_location)
>>> my_num_entities = int()
>>> op.inputs.num_entities.connect(my_num_entities)
>>> my_num_components = int()
>>> op.inputs.num_components.connect(my_num_components)
>>> my_scoping = dpf.Scoping()
>>> op.inputs.scoping.connect(my_scoping)

Overview

Methods

connect

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

Properties

double_or_vector_double	Allows to connect double_or_vector_double input to the operator.
unit	Allows to connect unit input to the operator.
location	Allows to connect location input to the operator.
num_entities	Allows to connect num_entities input to the operator.
num_components	Allows to connect num_components input to the operator.
scoping	Allows to connect scoping input to the operator.

Special methods

__getattr__
__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.scalars_to_field import InputsScalarsToField

Property detail

property InputsScalarsToField.double_or_vector_double: ansys.dpf.core.inputs.Input[float]

Allows to connect double_or_vector_double input to the operator.

Data of the field. Default is 0-field. Specify a double to create a field with uniform values, or a vector for explicit data per entity

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> op.inputs.double_or_vector_double.connect(my_double_or_vector_double)
>>> # or
>>> op.inputs.double_or_vector_double(my_double_or_vector_double)

property InputsScalarsToField.unit: ansys.dpf.core.inputs.Input[str]

Allows to connect unit input to the operator.

Unit symbol (m, Hz, kg, …). Default is dimensionless

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> op.inputs.unit.connect(my_unit)
>>> # or
>>> op.inputs.unit(my_unit)

property InputsScalarsToField.location: ansys.dpf.core.inputs.Input[str]

Allows to connect location input to the operator.

Location of the field: ‘Nodal’, ‘ElementalNodal’, ‘Elemental’, etc. Default is ‘numeric’

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> op.inputs.location.connect(my_location)
>>> # or
>>> op.inputs.location(my_location)

property InputsScalarsToField.num_entities: ansys.dpf.core.inputs.Input[int]

Allows to connect num_entities input to the operator.

Number of field entities. Default is 1, or the size of the scoping if provided

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> op.inputs.num_entities.connect(my_num_entities)
>>> # or
>>> op.inputs.num_entities(my_num_entities)

property InputsScalarsToField.num_components: ansys.dpf.core.inputs.Input[int]

Allows to connect num_components input to the operator.

Number of field components per entity. Default is 1 for scalar, >1 for vector

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> op.inputs.num_components.connect(my_num_components)
>>> # or
>>> op.inputs.num_components(my_num_components)

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

Allows to connect scoping input to the operator.

Scoping defining entity IDs and locations. If provided, overrides num_entities

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.scalars_to_field()
>>> op.inputs.scoping.connect(my_scoping)
>>> # or
>>> op.inputs.scoping(my_scoping)

Method detail

InputsScalarsToField.__getattr__(name)

InputsScalarsToField.__str__()

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

InputsScalarsToField.__call__(inpt)

InputsScalarsToField.__getitem__(item) → Input