droplet module

class droplet.Droplet[source]

Bases: cortix.src.module.Module

Droplet Cortix module used to model very simple fluid-particle interactions.

Notes

Port names used in this module: external-flow exchanges data with any other module that provides information about the flow outside the droplet, visualization sends data to a visualization module.

__init__()[source]
initial_time
Type

float

end_time
Type

float

time_step
Type

float

show_time

Two-element tuple, (bool,float), True will print to standard output.

Type

tuple

run(*args)[source]

Module run function

Run method with an option to pass data back to the parent process when running in Python multiprocessing mode. If the user does not want to share data with the parent process, this function can be overriden with run(self) or run(self, *args) as long as self.state = None. If self.state points to anything but None, the user must use `run(self, *args).

Notes

When in multiprocessing, *args has two elements: comm_idx and comm_state. To pass back the state of the module, the user should insert the provided index comm_idx and the state into the queue as follows:

if self.use_multiprocessing:
try:

pickle.dumps(self.state)

except pickle.PicklingError:

args[1].put((arg[0],None))

else:

args[1].put((arg[0],self.state))

at the bottom of the user defined run() function.

Warning

This function must be overridden by all Cortix modules

Parameters

  • arg[0] (int) – Index of the state in the communication queue.

  • arg[1] (multiprocessing.Queue) – When using the Python multiprocessing library state_comm must have the module’s self.state in it. That is, state_comm.put((idx_comm,self.state)) must be the last command in the method before return. In addition, self.state must be pickle-able.