numerous.image_tools.examples.multiply_by_two module#

class numerous.image_tools.examples.multiply_by_two.MultiplyByTwoJob#

Bases: NumerousSimulationJob

initialize_simulation_system()#

A method that is called once model is initialized (after the first data is read). Can return the initial output to be saved.

serialize_states(t)#

A method called when saving states. Returns: states, which must be JSON serializable, to be saved.

Return type:

bool

step(t, dt)#

A method that is called after each data read. Could be a step solver, or some other data manipulating function. Returns: tuple of next timestamp and outputs as a dict with tags to be saved

Return type:

tuple[float, dict]

numerous.image_tools.examples.multiply_by_two.run_example()#