next up previous contents
Next: MPH_init - initialize MPI Up: Module MPH_module - Multi Previous: Module MPH_module - Multi

MPH_components - main MPH setup function

This is the main function for each of the executable to call to setup the distributed multi-component environment. For example, if ocean and atmosphere sits in one executable, the source code will contain:

      mpi_exec_world =                       &
            MPH_components(name1='ocean', name2='atmosphere',...)
This function returns the MPI communicator of local executable world.

REVISION HISTORY:

       2001-Dec-03 -- reduce from 10 arguments to 5
       2001-Nov-15 -- add PROTEX convention
       2001-May-20 -- first prototype
INTERFACE:
       integer function MPH_components(name1, name2, name3, name4, name5)
USES:
       implicit none
INPUT PARAMETERS:
       These are component names
       character(len=*),intent(in) :: name1
       character(len=*),intent(in),optional :: name2, name3, name4, name5
OUTPUT PARAMETERS:
       ! This function returns the MPI communicator of this executable 
       ! world: exe_world (exe_id)
SEE ALSO:
       MPH_init, MPH_local, MPH_global, MPH_debug
LOCAL VARIABLES:
       integer :: k

\



Yun (Helen) He
Mon Mar 3 10:31:17 PST 2003