cta_par.h

Go to the documentation of this file.

/*
COSTA: Problem solving environment for data assimilation
Copyright (C) 2005  Nils van Velzen

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
#ifndef CTA_PAR_H
#define CTA_PAR_H
#include "cta_system.h"
#include "cta_handles.h"
#include "cta_datatypes.h"

#ifdef USE_MPI
#include "mpi.h"
#endif

/**
\file  cta_par.h

\brief Interface for creating parallel applications with COSTA */

/** Type of processes */
enum CTA_ParProcType {CTA_ParMaster, CTA_ParWorker, CTA_ParOther};


#ifdef __cplusplus
extern "C" {
#endif



/** Flag CTA_TRUE/CTA_FALSE to indicate whether run is in a parallel
 *  environment */
CTAEXPORT extern int CTA_IS_PARALLEL;

/** Rank in world of all processes Note this variable is only
 * used for debugging and output. */
CTAEXPORT extern int CTA_PAR_MY_RANK;



/** Kind of this process */
CTAEXPORT extern enum CTA_ParProcType CTA_MY_PROC_TYPE;

#ifdef USE_MPI
/** The whole communication universe              */
CTAEXPORT extern MPI_Comm CTA_COMM_WORLD;

/** My own communication group                    */
CTAEXPORT extern MPI_Comm CTA_COMM_MYWORLD;

/** Group consisting of master process and all worker processes the master
 *  communicates with */
CTAEXPORT extern MPI_Comm CTA_COMM_MASTER_WORKER;        

#endif


/** \brief Initialises parallel environment and create process groups
 *
 * \param parConfig I  configuration input from XML-file
 * \param StartPat  I  CTA_TRUE/CTA_FALSE start parallel model builder
 *
 * Note when a worker process is part of a Master-Worker model and it does
 * not implement the COSTA model interface it should not start the parallel model builder
 *
 * \return error status: CTA_OK if successful
 */
int CTA_Par_CreateGroups(int parConfig, int StartPar);

/** \brief Get a new communicator for a new model instance
 *
 * \param forModel I  model class of new model
 * \param comm     O  MPI communicator
 *
 * \return error status: CTA_OK if successful
 */
#ifdef USE_MPI
int CTA_Par_CreateNewCreateGetComm(CTA_ModelClass modelCls, MPI_Comm *comm);
#endif

/** \brief Get the Fortran (integer handles) of the communicators 
 *
 * \param O cta_comm_world          Fortran communcator CTA_COMM_WORLD
 * \param O cta_comm_myworld        Fortran communcator CTA_COMM_MYWORLD
 * \param O cta_comm_master_worker  Fortran communcator CTA_COMM_MASTER_WORKER
 *
 */
#ifdef USE_MPI
int CTA_Par_CreateNewCreateGetComm(CTA_ModelClass modelCls, MPI_Comm *comm);
#endif

/** \brief Get a communicator for a process group by index 
 *
 * \param I indx  indx of communicator
 * \param O comm  MPI communicator
 * \return CTA_OK when succesfull. The value is CTA_CANNOT_FIND_PROCESS_GROUP is
 *         returned when the communicator cannot be found
 *
 */
#ifdef USE_MPI
int CTA_Par_GetAllCommByIndex(int indx, MPI_Comm *comm);
#endif





#ifdef __cplusplus
}
#endif
#endif

---