DataLoader

Interface used to provide windfield and other data for a simulation run.

 

__init__() -> DataLoader

Constructor for inheritance.

 

step() -> bool

This function should update the internal structure of your class for the next windfield-timestep. Return True if successful, False otherwise.

 

windfield() -> bool

Should return a list of either two or three (depending on space) windfields in order (x, y, [z]) for the current windfield-timestep.

 

additionalVolumes() -> dict[str: numpy.ndarray(dtype=float)]

Should return a dictionary mapping the variable identifiers to volumes. It is expected that the identifiers stay constant during the entire simulation run.

 

constants() -> dict[str: numpy.ndarray(dtype=float)]

Should return a dictionary mapping the variable identifiers to compute constants for each particle. It is expected that the identifiers stay constant during the entire simulation run.

 

uplift() -> numpy.ndarray(dtype=float)

When using a different UpLiftMode than Off, this has to provide an array with the number of particles in your simulation fitting the space dimension.