math:scale fields container

Version: 0.0.0

Description

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

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

fields_container (Pin 0)

• Required: Yes
• Expected type(s): fields_container

fields container to be scaled

weights (Pin 1)

• Required: Yes
• Expected type(s): double, field, vector<double>, fields_container

Double/Vector of doubles/Field/FieldsContainer. 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 (Pin 2)

• Required: No
• Expected type(s): bool

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

algorithm (Pin 3)

• Required: No
• Expected type(s): int32

Algorithm selection: 0 (default) uses MKL for optimization, 1 uses standard loops

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

fields_container (Pin 0)

• Expected type(s): fields_container

FieldsContainer with scaled field values

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

num_threads

• Expected type(s): int32
• Default value: 0

Number of threads to use to run in parallel

permissive

• Expected type(s): bool
• Default value: false

If this option is set to true, warning checks (like unit or data sizes) won't be done.

run_in_parallel

• Expected type(s): bool
• Default value: true

Loops are allowed to run in parallel if the value of this config is set to true.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: math

Plugin: core

Scripting name: None

Full name: None

Internal name: scale_fc

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("scale_fc"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_weights);
op.connect(2, my_boolean);
op.connect(3, my_algorithm);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.math.None() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.weights.connect(my_weights)
op.inputs.boolean.connect(my_boolean)
op.inputs.algorithm.connect(my_algorithm)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.None() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.weights.Connect(my_weights)
op.inputs.boolean.Connect(my_boolean)
op.inputs.algorithm.Connect(my_algorithm)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.