math:scale (field)
Version: 0.0.0
Description
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
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | field | field, fields_container | field or fields container with only one field is expected |
| Pin 1 Required | weights | double, field, vector<double> | 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 |
| Pin 2 | boolean | bool | Default is false. If set to true, output of scale is made dimensionless |
| Pin 3 | algorithm | int32 | Default is 0 use mkl. If set to 1, don't |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | field | field |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
| permissive | bool | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. |
Scripting
Category: math
Plugin: core
Scripting name: None
Full name: None
Internal name: scale
License: None
Changelog
- Version 0.0.0: Initial release.