Input

Input Block

A block that describes the name, length, and types of a vector input argument to a UserFunc or Term.

Each (vector) input argument has a given length, and each element has a type (either boolean, integer, or float).

Input kinds

kind (string)

Specifies the kind of Input block.

arbitraryVector

A vector of arbitrary length, with arbitrary types.

uniformVector

A vector argument of arbitrary length, but uniform type.

arbitraryVector Parameters

types (vector of strings, required)

The type of each element of the input argument, in a list. For example, [ integer float float boolean ] specifies of vector of length 4, with the first element of type integer, the second of type float, etc.

uniformVector Parameters

The kind = uniformVector is especially useful for specifying NDIM-dimensional arguments (with the same dimension as the simulation), for simulations that can be run with arbitrary NDIM. Instead of constructing a list and truncating it to NDIM elements, one just adds length = NDIM.

type (string, required)

The type of each element of the input argument; either float, integer, or boolean.

length (optional non-negative integer, default=1)

The length of the vector.