InputsScale

class ansys.dpf.core.operators.math.scale.InputsScale(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to scale operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.scale()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_ponderation = float()
>>> op.inputs.ponderation.connect(my_ponderation)
>>> my_boolean = bool()
>>> op.inputs.boolean.connect(my_boolean)
>>> my_algorithm = int()
>>> op.inputs.algorithm.connect(my_algorithm)

Overview

Properties

field	Allows to connect field input to the operator.
ponderation	Allows to connect ponderation input to the operator.
boolean	Allows to connect boolean input to the operator.
algorithm	Allows to connect algorithm input to the operator.

Import detail

from ansys.dpf.core.operators.math.scale import InputsScale

Property detail

property InputsScale.field

Allows to connect field input to the operator.

Field or fields container with only one field is expected

Parameters:

my_field (Field or FieldsContainer)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.scale()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

property InputsScale.ponderation

Allows to connect ponderation input to the operator.

Double/field/vector of doubles. when scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping

Parameters:

my_ponderation (float or Field)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.scale()
>>> op.inputs.ponderation.connect(my_ponderation)
>>> # or
>>> op.inputs.ponderation(my_ponderation)

property InputsScale.boolean

Allows to connect boolean input to the operator.

Default is false. if set to true, output of scale is made dimensionless

Parameters:

my_boolean (bool)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.scale()
>>> op.inputs.boolean.connect(my_boolean)
>>> # or
>>> op.inputs.boolean(my_boolean)

property InputsScale.algorithm

Allows to connect algorithm input to the operator.

Default is 0 use mkl. if set to 1, don’t

Parameters:

my_algorithm (int)

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.scale()
>>> op.inputs.algorithm.connect(my_algorithm)
>>> # or
>>> op.inputs.algorithm(my_algorithm)