`scale`#

class ansys.dpf.core.operators.math.scale.scale(field=None, weights=None, boolean=None, algorithm=None, config=None, server=None, ponderation=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Scales a field by a constant factor. This factor can be a scalar or a vector, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality

Parameters:

field (Field or FieldsContainer) – field or fields container with only one field is expected
weights (float or Field) – 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
boolean (bool, optional) – Default is false. If set to true, output of scale is made dimensionless
algorithm (int, optional) – Default is 0 use mkl. If set to 1, don’t

Returns:

field

Return type:

Field

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.math.scale()

>>> # Make input connections
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_weights = float()
>>> op.inputs.weights.connect(my_weights)
>>> my_boolean = bool()
>>> op.inputs.boolean.connect(my_boolean)
>>> my_algorithm = int()
>>> op.inputs.algorithm.connect(my_algorithm)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.scale(
...     field=my_field,
...     weights=my_weights,
...     boolean=my_boolean,
...     algorithm=my_algorithm,
... )

>>> # Get output data
>>> result_field = op.outputs.field()

Overview#

Properties

`inputs`	Enables to connect inputs to the operator
`outputs`	Enables to get outputs of the operator by evaluating it

Static methods

default_config

Returns the default config of the operator.

Import detail#

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

Property detail#

property scale.inputs: InputsScale#

Enables to connect inputs to the operator

Returns:: An instance of InputsScale.
Return type:: inputs

property scale.outputs: OutputsScale#

Enables to get outputs of the operator by evaluating it

Returns:: An instance of OutputsScale.
Return type:: outputs

Method detail#

static scale.default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#