Gridtrace

class xmsgridtrace.gridtrace.GridTrace

Class in which the flow trace of a point between 2 velocity vector time steps on an XmGrid is calculated and the velocity vectors can be assigned to either the points or to the cells.

add_grid_scalars_at_time(self: xmsgridtrace.gridtrace.GridTrace, scalars: iterable, scalar_loc: unicode, cell_activity: iterable, activity_loc: unicode, time: float) → None

Assigns velocity vectors to each point or cell for a time step, keeping the previous step, and dropping the one before that for a maximum of two time steps.

Parameters:

• scalars (iterable) – The velocity vectors.
• scalar_loc (string) – Whether the vectors are assigned to cells or points.
• cell_activity (iterable) – Whether each cell or point is active.
• activity_loc (string) – Whether the activities are assigned to cells or points.
• time (float) – The time of the scalars.

get_exit_message(self: xmsgridtrace.gridtrace.GridTrace) → unicode

Returns a message describing what caused trace to exit.

Returns:The exit message of the last TracePoint operation. Return type:str

max_change_direction_in_radians

The max change direction in radians.

max_change_distance

The max change distance.

max_change_velocity

The max change velocity.

max_tracing_distance

The max tracing distance.

max_tracing_time

The max tracing time.

min_delta_time

The min delta time.

trace_point(self: xmsgridtrace.gridtrace.GridTrace, pt: iterable, pt_time: float) → iterable

Runs the Grid Trace for a point.

Parameters:

• pt (iterable) – The starting point of the trace.
• pt_time (float) – The starting time of the trace.

Returns:

Contains the resultant positions at each step and the resultant times at each step.

Return type:

iterable

vector_multiplier

The vector multiplier.