basic_operations

`add(summand_1, summand_2, sum)`

Add two inputs together, sum to a new field.

Parameters:

Name	Type	Description	Default
`summand_1`	`FloatField`	input field	required
`summand_2`	`FloatField`	input field	required
`sum`	`FloatField`	output field	required

`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(field, summand)`

Add a summand to a field.

Parameters:

Name	Type	Description	Default
`field`	`FloatField`	field to be modifid	required
`summand`	`FloatField`	modification to be made	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 modifid	required
`summand`	`FloatFieldIJ`	modification to be made	required

`adjust_divide_stencil(adjustment, field)`

Divides a field by an adjustment factor, modifying the original field.

Parameters:

Name	Type	Description	Default
`adjustment`	`FloatField`	adjustment factor	required
`field`	`FloatField`	field to be modified	required

`adjustmentfactor_stencil(adjustment, field)`

Multiplies a field by an adjustment factor, modifying the original field.

Parameters:

Name	Type	Description	Default
`adjustment`	`FloatFieldIJ`	adjustment factor	required
`field`	`FloatField`	field to be modified	required

`average_in(q_out, adjustment)`

Averages every element of q_out with every element of the adjustment field, overwriting q_out.

Parameters:

Name	Type	Description	Default
`adjustment`	`FloatField`	adjustment field	required
`q_out`	`FloatField`	output field	required

`copy(input, output)`

Copy one field into another.

Parameters:

Name	Type	Description	Default
`input`	`FloatField`	input field	required
`output`	`FloatField`	output field	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

`dim(a, b)`

Calculates a - b, camped to 0, i.e. max(a - b, 0).

`divide(dividend, divisor, quotient)`

Divide dividend by divisor, output to a new field.

Parameters:

Name	Type	Description	Default
`dividend`	`FloatField`	input field	required
`divisor`	`FloatField`	input field	required
`quotient`	`FloatField`	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_to_self(field, divisor)`

Muultiply a field by a factor - 2D variant.

Parameters:

Name	Type	Description	Default
`field`	`FloatField`	field to be modifid	required
`divisor`	`FloatField`	modification factor	required

`divide_to_self_2d(field, divisor)`

Muultiply a field by a factor - 2D variant.

Parameters:

Name	Type	Description	Default
`field`	`FloatFieldIJ`	field to be modifid	required
`divisor`	`FloatFieldIJ`	modification factor	required

`multiply(factor_1, factor_2, product)`

Multiply two inputs together, output to a new field.

Parameters:

Name	Type	Description	Default
`factor_1`	`FloatField`	input field	required
`factor_2`	`FloatField`	input field	required
`output`		output field	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
`output`		output field	required

`multiply_to_self(field, factor)`

Muultiply a field by a factor.

Parameters:

Name	Type	Description	Default
`field`	`FloatField`	field to be modifid	required
`factor`	`FloatField`	modification factor	required

`multiply_to_self_2d(field, factor)`

Muultiply a field by a factor - 2D variant.

Parameters:

Name	Type	Description	Default
`field`	`FloatFieldIJ`	field to be modifid	required
`factor`	`FloatFieldIJ`	modification factor	required

`select_k(in_field, out_field, k_mask, k_select)`

Saves a specific k-index of a 3D field to a new 2D array. The k-value can be different for each i,j point.

Parameters:

Name	Type	Description	Default
`in_field`	`FloatField`	A 3D array to select from	required
`out_field`	`FloatFieldIJ`	A 2D field to save values in	required
`k_mask`	`IntField`	a field that lists each k-index	required
`k_select`	`IntFieldIJ`	the k-value to extract from in_field	required

`set_IJ_mask_value(field, value)`

Sets every element of buffer to either True or False.

Parameters:

Name	Type	Description	Default
`field`	`BoolFieldIJ`	output field	required
`value`	`Bool`	value of Bool type	required

`set_value(field, value)`

Sets every element of a field to a single value.

Parameters:

Name	Type	Description	Default
`field`	`FloatField`	output field	required
`value`	`Float`	value of Float 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

`sign(a, b)`

Defines a_sign_b as the absolute value of a, and checks if b is positive or negative, assigning the analogous sign value to a_sign_b. a_sign_b is returned.

Parameters:

Name	Type	Description	Default
`a`		A number	required
`b`		A number	required

`subtract(minuend, subtrahend, difference)`

Subtract subtrahend from minuend, output to a new field.

Parameters:

Name	Type	Description	Default
`minuend`	`FloatField`	input field	required
`subtrahend`	`FloatField`	input field	required
`difference`	`FloatField`	output field	required

`subtract_2d(minuend, subtrahend, difference)`

Subtract summand_2 from minuend, output to a new field - 2D variant.

Parameters:

Name	Type	Description	Default
`minuend`	`FloatFieldIJ`	input field	required
`summand_2`		input field	required
`difference`	`FloatFieldIJ`	output field	required

`subtract_to_self(field, subtrahend)`

Subtract a subtrahend from a field.

Parameters:

Name	Type	Description	Default
`field`	`FloatField`	field to be modifid	required
`subtrahend`	`FloatField`	modification to be made	required

`subtract_to_self_2d(field, subtrahend)`

Subtract a modification from a field - 2D variant.

Parameters:

Name	Type	Description	Default
`field`	`FloatFieldIJ`	field to be modifid	required
`subtrahend`	`FloatFieldIJ`	modification to be made	required