pyPDAF.set_parallel

pyPDAF.set_parallel()

Set MPI communicators and parallelisation in PDAF.

The MPI communicators asked by this function depends on the parallelisation strategy. For the default parallelisation strategy, the user can use the parallelisation module provided under in example directory without modifications. The parallelisation can differ based on online and offline cases. Users can also refer to parallelisation documentation for explanations or modifications.

Parameters:

• in_comm_model (int) – Model communicator

• in_comm_filter (int) – Filter communicator

• in_comm_couple (int) – Coupling communicator

• in_task_id (int) – Id of my ensemble task

• in_n_modeltasks (int) – Number of parallel model tasks

• in_filterpe (bint) – Is my PE a filter-PE?

• flag (int) – Status flag

Returns:

flag – Status flag, 0: no error, error codes:

Return type:

int