api/aspherix_fix_external.h

This is the header file used to define a new fix which must be derived from this class. The member functions are:


FixExternal

Constructor

hasScalarOutput

Function to tell Aspherix® that this external fix has a scalar output value.

hasVectorOutput

Function to tell Aspherix® that this external fix has a vector output value with n components.

hasArrayOutput

Function to tell Aspherix® that this external fix has a array output value with n x m components.

setCallFrequency

Determines the frequency with which the external fix is called. Usually this should be set to 1, i.e. call the fix every time step.

compute_scalar

Overridable (virtual) function that can be used to provide an output scalar usable also in input scripts.

compute_vector

Overridable (virtual) function that can be used to provide an output vector usable also in input scripts.

compute_array

Overridable (virtual) function that can be used to provide an output array usable also in input scripts.

getId

Function to get the id of the fix as set via the input script (or an api call, see api/aspherix.h)