iwave.h

Go to the documentation of this file.

/* 
   iwave.h
   Igor Terentyev.

   thoroughly mangled by WWS 01/09
   even further mangled by WWS & XW 11/10
   mashed by WWS 10/13-01/14
*/
/*============================================================================*/
#ifndef __IWAVE_H_
#define __IWAVE_H_
/*----------------------------------------------------------------------------*/

#include "utils.h"
#include "usempi.h"
#include "exchangeinfo.h"
#include "parser.h"
#include "fd.h"

/*----------------------------------------------------------------------------*/
/*
  Parallel information (MPI, MPI Cartesian grid, OpenMP).
  Cartesian grid for 1D/2D/3D.
*/
typedef struct s_PARALLELINFO {
  int ndim;                
  int nnei;                
  int wsize;               
  int wrank;               
  int threadsupp;          
  MPI_Comm ccomm;          
  IPNT cdims;              
  IPNT crank;              
  int lrank;               
  int sranks[IWAVE_NNEI];  
  int rranks[IWAVE_NNEI];  
  EXCHANGEINFO seinfo[RDOM_MAX_NARR][IWAVE_NNEI]; 
  EXCHANGEINFO reinfo[RDOM_MAX_NARR][IWAVE_NNEI]; 
} PARALLELINFO;


/*----------------------------------------------------------------------------*/
int initparallel(int ts);

/*----------------------------------------------------------------------------*/
void initparallel_global(int);

/*----------------------------------------------------------------------------*/
int initparallel_local(PARARRAY, FILE *);

int initpinfo(PARALLELINFO *pinfo, FILE *stream);
/*----------------------------------------------------------------------------*/
/*
  Creates MPI Cartesian grid and computes neighbor processor ranks.
  Exits quitely if process is out of Cartesian grid.
  Sets OMP threads.
*/
/*
 * Determines the number of processes in each dimension, i.e.\ cdims and asgnrk 
 * in \ref PARALLELINFO. 
 */
/* 10.04.11: deprecated WWS
   int readparallel(PARALLELINFO *pinfo, PARARRAY *pars, FILE *stream);
*/
/*----------------------------------------------------------------------------*/
/*
 * Computes and stores neighbor processor ranks for correct physical grid dimn
 * Exits quietly if process is out of Cartesian grid and sets OMP threads.
 *
 * @param [out] pinfo - (PARALLELINFO *) parallel info pointer
 * @param [in] ndim - (int) physical grid dimension (as opposed to MPI cart comm dim)
 * @param [in] stream - (FILE *) file pointer where to dump run-time message
 * @return 0 on successful completion, else error code as in 
 * base/include/utils.h.
 */
int initexch(PARALLELINFO *pinfo, int ndim, FILE *stream);

/*----------------------------------------------------------------------------*/
/*
 * Destroy Cartesian grid and MPI-related.
 *
 * int fabort :  flag to abort.
 *
 * Destroy the parallel info.
 *
 * Frees the communicator and destroys the send and recv info. No STORAGE 
 * DEALLOCATION occurs at this point.
 */
/* renamed 10.04.11 WWS
   int destroyparallel(PARALLELINFO *pinfo, int fabort);
*/
int destroypinfo(PARALLELINFO *pinfo, int fabort);
/*----------------------------------------------------------------------------*/

typedef struct s_IWAVE {
  PARALLELINFO pinfo; 
  IMODEL model;
  int stats;
  int nopts;
  int printact;
#ifdef IWAVE_USE_MPI
  /* ALL OF THIS STUFF REMOVED TEMP 13.03.12 WWS */
  /*    double wt0; */
  /*    double stat_times[RDOM_MAX_NARR][MODEL_MAX_NACTION][3];  min, max, ave */
  /*    int stat_calls[RDOM_MAX_NARR][MODEL_MAX_NACTION][3]; */
#endif
} IWAVE;

/* MAJOR IWAVE INTERFACES */
int iwave_construct(IWAVE * state, PARARRAY * pars, FILE * stream, IWaveInfo const & ic);

void iwave_printf(IWAVE * state, PARARRAY * pars, FILE * stream, IWaveInfo const & ic);

void iwave_dynamic_init(IWAVE * state,
            int it, IWaveInfo const & ic);

void iwave_destroy(IWAVE * state, FD_MODELDEST d);

/* MORE IWAVE/PARALLELINFO HELPER FUNCTIONS */
void quietexit(PARARRAY * pars,FILE ** stream);

void abortexit(int err,PARARRAY * pars,FILE ** stream);

int initoutstream(FILE ** stream, int rk, int sz);
int readinput(PARARRAY ** pars, FILE * stream, int argc, char **argv);
void readparpars(PARARRAY * pars,
         int * stats,
         int * nopts,
         int * printact,
         FILE * out);

void storeparallel(PARALLELINFO *pinfo);

int setrecvexchange(IMODEL * model, PARALLELINFO * pinfo, FILE * stream, IWaveInfo const & ic);

int dump_pi(PARARRAY * pars, PARALLELINFO *pinfo, FILE *stream);  

void dump_ac(PARARRAY * pars, IMODEL * model, FILE * stream);

void dump_rs(PARARRAY * pars, IMODEL * model, FILE * stream, int sends, IWaveInfo const & ic, PARALLELINFO * pinfo);

#ifdef IWAVE_USE_MPI

void prepexch(PARALLELINFO * pinfo, IMODEL * model, IWaveInfo const & ic);
/* REMOVED TEMP 13.03.12 WWS
//      int stats, 
//      double * wt0); */

/* REMOVED TEMP 13.03.12 WWS
//  void preptime(double stat_times[RDOM_MAX_NARR][MODEL_MAX_NACTION][3],
//      int stat_calls[RDOM_MAX_NARR][MODEL_MAX_NACTION][3],
//                IWAVE * state); */

/* REMOVED TEMP 13.03.12 WWS
//  void printtime(double stat_times[RDOM_MAX_NARR][MODEL_MAX_NACTION][3],
//                 int stat_calls[RDOM_MAX_NARR][MODEL_MAX_NACTION][3],
//                 IWAVE * state, FILE * stream); */

#endif

#endif /*__IWAVE_H_*/

---