Vector Field Formula¶
Functionality¶
This node generates a Vector Field, defined by some user-provided formula.
Generator-> Line
Generator-> Circle
Fields-> Evaluate Vector Field
Number-> Number Range
Viz-> Viewer Draw
The formula should map the coordinates of the point in 3D space into some vector in 3D space. Both original points and the resulting vector can be expressed in one of supported coordinate systems.
It is possible to use additional parameters in the formula, they will become inputs of the node.
It is also possible to use the value of some other Vector Field in the same point in the formula.
Expression syntax¶
Syntax being used for formulas is standard Python’s syntax for expressions. For exact syntax definition, please refer to https://docs.python.org/3/reference/expressions.html.
In short, you can use usual mathematical operations (+, -, *, /, ** for power), numbers, variables, parenthesis, and function call, such as sin(x).
One difference with Python’s syntax is that you can call only restricted number of Python’s functions. Allowed are:
Functions from math module:
acos, acosh, asin, asinh, atan, atan2, atanh, ceil, copysign, cos, cosh, degrees, erf, erfc, exp, expm1, fabs, factorial, floor, fmod, frexp, fsum, gamma, hypot, isfinite, isinf, isnan, ldexp, lgamma, log, log10, log1p, log2, modf, pow, radians, sin, sinh, sqrt, tan, tanh, trunc;
Constants from math module: pi, e;
Additional functions: abs, sign;
From mathutlis module: Vector, Matrix;
Python type conversions: tuple, list, dict.
This restriction is for security reasons. However, Python’s ecosystem does not guarantee that no one can call some unsafe operations by using some sort of language-level hacks. So, please be warned that usage of this node with JSON definition obtained from unknown or untrusted source can potentially harm your system or data.
Examples of valid expressions are:
1.0
x
x+1
0.75*X + 0.25*Y
R * sin(phi)
Inputs¶
This node has the following input:
Field. A vector field, whose values can be used in the formula. This input is required only if the formula involves the V variable.
Each variable used in the formula, except for V and the coordinate variables, also becomes additional input.
The following variables are considered to be point coordinates:
For Cartesian input mode: x, y and z;
Generator->Generatots Extended-> Spiral
For Cylindrical input mode: rho, phi and z;
Generator->Generatots Extended-> Spiral
For Spherical input mode: rho, phi and theta.
Generator->Generators Extended Torus Knot
V variable in formulas stands for NumPy array of shape (3,)
, which
represents the value of field passed in the Field input, in the appropriate
point in space. So, V[0] is X coordinate of that field’s value, V[1] is
it’s Y coordinate, and V[2] is Z coordinate.
Parameters¶
This node has the following parameters:
Input. This defines the coordinate system being used for the input points. The available values are Carhtesian, Cylindrical and Spherical. The default value is Cartesian.
Formula1, Formula2, Formula3. Three formulas defining the respective coordinate / components of the resulting vectors: X, Y, Z, or Rho, Phi, Z, or Rho, Phi, Theta, depending on the Output parameter. The default formulas are -y, x and z, which defines the field which rotates the whole space 90 degrees around the Z axis.
Fields-> Vector Field Math
Fields-> Apply Vector Field
Output. This defines the coordinate system in which the resulting vectors are expressed. The available values are Carhtesian, Cylindrical and Spherical. The default value is Cartesian.
Vectorize. This parameter is available in the N panel only. If enabled, then to evaluate formulas for a series of input values, the node will use NumPy functions to perform several computations at a time; otherwise, the formulas will be evaluated separately for each input value. The use of vectorization usually makes computations a lot faster (2x to 100x). The parameter is enabled by default. If you experience some kind of troubles with calculating some of functions (errors or not good enough precision), you can disable this parameter.
Outputs¶
This node has the following output:
Field. The generated vector field.
Examples of usage¶
Generator-> Segment
Generator-> Cylinder
Fields-> Vector Field Math
Fields-> Evaluate Vector Field
Fields-> Apply Vector Field
List->List Struct-> List Item
Viz-> Viewer Draw
Some vector field defined by a formula in Spherical coordinates:
Generator-> Box
Number-> A Number
Viz-> Viewer Draw
Similar field applied to some box:
Generator-> Box
Fields-> Apply Vector Field
Number-> A Number
Viz-> Viewer Draw
Example of V variable usage:
Generator-> Plane
Fields-> Attractor Field
Fields-> Apply Vector Field
Number-> List Input
Viz-> Viewer Draw