1 Coupling initialisation

• CALL oasis_init_comp (compid, comp_name, kinfo, coupled, commworld)
• CALL prism_init_comp_proto (compid, comp_name, kinfo, coupled, commworld)
  • compid [INTEGER; OUT]: returned component ID
  • comp_name [CHARACTER; IN]: component name; maximum length of 80 characters
  • kinfo [INTEGER; OUT]: returned error code
  • coupled [LOGICAL, OPTIONAL; IN]: flag to specify if the calling task is participating or not to the coupling (.true. by default).
  • commworld [INTEGER, OPTIONAL; IN] : optional argument to specify the global communicator gathering the components of the coupled model. If not specified, MPI_COMM_WORLD will be used as the default communicator to startup. All components of the coupled model must specify the same commworld argument.

  This routine must called by all tasks of all components whether or not they are involved in the coupling ³.

  A component is defined as the ensemble of tasks calling oasis_init_comp with the same comp _name argument. If and only if all tasks of a component are excluded from the coupling, the logical coupled can be set to .false. for this component tasks; in this case, oasis_init_comp is the only API routine that needs to be called by the component tasks. If at least one tasks of a component is participating to the coupling, all component tasks have to call oasis_init_comp with coupled=.true. (which is the default); in this case, the component tasks not participating to the coupling will also have to call oasis_get_localcomm, oasis_create_couplcomm, oasis_enddef and oasis_terminate.

Footnotes

... coupling³

The component may also call MPI_Init explicitly, but if so, has to call it before calling oasis_init_comp; in this case, the component also has to call MPI_Finalize explicitly, but only after calling oasis_terminate.