Basic operations (2D)
ndsl.stencil offers the following basic operations as building blocks in 2D:
add_2d(summand_1, summand_2, sum)
Add two inputs together, sum to a new field - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
summand_1
|
FloatFieldIJ
|
input field |
required |
summand_2
|
FloatFieldIJ
|
input field |
required |
sum
|
FloatFieldIJ
|
output field |
required |
add_to_self_2d(field, summand)
Add a summand to a field - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
field
|
FloatFieldIJ
|
field to be modified |
required |
summand
|
FloatFieldIJ
|
modification to be made |
required |
copy_2d(input, output)
Copy one field into another - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
FloatFieldIJ
|
input field |
required |
output
|
FloatFieldIJ
|
output field |
required |
divide_2d(dividend, divisor, quotient)
Divide dividend by divisor, output to a new field - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dividend
|
FloatFieldIJ
|
input field |
required |
divisor
|
FloatFieldIJ
|
input field |
required |
quotient
|
FloatFieldIJ
|
output field |
required |
divide_self_2d(field, divisor)
Divide dividend by divisor - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
field
|
FloatFieldIJ
|
field to be modified |
required |
divisor
|
FloatFieldIJ
|
modification factor |
required |
multiply_2d(factor_1, factor_2, product)
Multiply two inputs together, output to a new field - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
factor_1
|
FloatFieldIJ
|
input field |
required |
factor_2
|
FloatFieldIJ
|
input field |
required |
product
|
FloatFieldIJ
|
output field |
required |
multiply_to_self_2d(field, factor)
Multiply a field by a factor - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
field
|
FloatFieldIJ
|
field to be modified |
required |
factor
|
FloatFieldIJ
|
modification factor |
required |
set_boolean_value_2d(field, value)
Sets every element of a field to either True or False - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
field
|
BoolFieldIJ
|
output field |
required |
value
|
Bool
|
value of Bool type |
required |
set_value_2d(field, value)
Sets every element of a field to a single value - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
field
|
FloatFieldIJ
|
output field |
required |
value
|
Float
|
value of Float type |
required |
subtract_2d(minuend, subtrahend, difference)
Subtract subtrahend from minuend, output to a new field - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
minuend
|
FloatFieldIJ
|
input field |
required |
subtrahend
|
FloatFieldIJ
|
input field |
required |
difference
|
FloatFieldIJ
|
output field |
required |
subtract_from_self_2d(field, subtrahend)
Subtract a modification from a field - 2D variant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
field
|
FloatFieldIJ
|
field to be modified |
required |
subtrahend
|
FloatFieldIJ
|
modification to be made |
required |