transi.h

Go to the documentation of this file.

/*
 * (C) Copyright 2014- ECMWF.
 * 
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation
 * nor does it submit to any jurisdiction.
 */


 
#ifndef ectrans_transi_h
#define ectrans_transi_h
 
#include <stddef.h> // size_t
 
typedef int _bool;
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ectrans/version.h"
 
#define TRANS_FFT992 1
#define TRANS_FFTW   2
 
#define TRANS_SUCCESS         0
 
struct Trans_t;
struct DirTrans_t;
struct DirTransAdj_t;
struct InvTrans_t;
struct InvTransAdj_t;
struct DistGrid_t;
struct GathGrid_t;
struct DistSpec_t;
struct GathSpec_t;
struct VorDivToUV_t;
struct SpecNorm_t;
 

const char* trans_error_msg(int errcode);

int trans_set_handles_limit(int limit);

int trans_set_radius(double radius);

int trans_set_nprtrv(int nprtrv);

int trans_set_nprgpew(int nprgpew);

int trans_set_leq_regions(_bool ldeq_regions);

int trans_use_mpi(_bool);

int trans_init(void);

int trans_set_mpi_comm(int mpi_user_comm);
 
int trans_set_read(struct Trans_t*, const char* filepath);
int trans_set_write(struct Trans_t*, const char* filepath);
int trans_set_cache(struct Trans_t*, const void*, size_t);

int trans_setup(struct Trans_t* trans);
 

int trans_inquire(struct Trans_t* trans, const char* varlist);

int trans_dirtrans(struct DirTrans_t* dirtrans);
 

int trans_dirtrans_adj(struct DirTransAdj_t* dirtransadj);
 

int trans_invtrans(struct InvTrans_t* invtrans);
 
 

int trans_invtrans_adj(struct InvTransAdj_t* invtrans_adj);

int trans_distgrid(struct DistGrid_t* distgrid);

int trans_gathgrid(struct GathGrid_t* gathgrid);

int trans_distspec(struct DistSpec_t* distspec);

int trans_gathspec(struct GathSpec_t* gathspec);

int trans_vordiv_to_UV(struct VorDivToUV_t* vordiv_to_UV);

int trans_specnorm(struct SpecNorm_t* specnorm);

int trans_delete(struct Trans_t* trans);
 

int trans_finalize(void);
 

struct Trans_t {

  int    ndgl;       
  int*   nloen;      
  int    nlon;       
  int    nsmax;      
  _bool  llam;       
 
  _bool  lsplit;         
  int    llatlon;        
  int    flt;            
  int    fft;            
 
  char*  readfp;
  char*  writefp;
  const void*  cache;
  size_t cachesize;

  int    myproc;     
  int    nproc;      

  int   handle;      


  int   nspec;       
  int   nspec2;      
  int   nspec2g;     
  int   nspec2mx;    
  int   nump;        
  int   ngptot;      
  int   ngptotg;     
  int   ngptotmx;    
  int*  ngptotl;     
  int*  nmyms;       
  int*  nasm0;       
  int   nprtrw;      
  int*  numpp;       
  int*  npossp;      
  int*  nptrms;      
  int*  nallms;      
  int*  ndim0g;      
  int*  nvalue;      


  int   n_regions_NS;
  int   n_regions_EW;
  int   my_region_NS;
  int   my_region_EW;
  int*  n_regions;   
  int*  nfrstlat;    
  int*  nlstlat;     
  int   nfrstloff;   
  int*  nptrlat;     
  int*  nptrfrstlat; 
  int*  nptrlstlat;  
  int   nptrfloff;   
  int*  nsta;        
  int*  nonl;        
  _bool* ldsplitlat; 


  int   nprtrns;     
  int*  nultpp;      
  int*  nptrls;      
  int*  nnmeng;      

 

  double*  rmu;      
  double*  rgw;      
  double*  rpnm;     
  int      nlei3;    
  int      nspolegl; 
  int*     npms;     
  double*  rlapin;   
  int*     ndglu;    


  double    pexwn;         
  double    peywn;         
  double *  pweight;       
  int       ndgux;         
  int       nmsmax;        
  int *     mvalue;        
};

int trans_new( struct Trans_t* );

int trans_set_resol( struct Trans_t* trans, int ndgl, const int* nloen );

int trans_set_resol_lonlat( struct Trans_t* trans, int nlon, int nlat );

int trans_set_resol_lam( struct Trans_t* trans, int nx, int ny, double dx, double dy );

int trans_set_trunc( struct Trans_t* trans, int nsmax );

int trans_set_trunc_lam( struct Trans_t* trans, int trunc_x, int trunc_y );
 

struct DirTrans_t
{
  const double* rgp;     
  double* rspscalar;     
  double* rspvor;        
  double* rspdiv;        
  const double* rmeanu;  
  const double* rmeanv;  
  int nproma;            
  int nscalar;           
  int nvordiv;           
  int ngpblks;           
  int lglobal;           
  struct Trans_t* trans; 
  int count;             
};

struct DirTrans_t new_dirtrans(struct Trans_t* trans);
 

struct DirTransAdj_t
{
  const double* rgp;     
  double* rspscalar;     
  double* rspvor;        
  double* rspdiv;        
  const double* rmeanu;  
  const double* rmeanv;  
  int nproma;            
  int nscalar;           
  int nvordiv;           
  int ngpblks;           
  int lglobal;           
  struct Trans_t* trans; 
  int count;             
};

struct DirTransAdj_t new_dirtrans_adj(struct Trans_t* trans);
 

struct InvTrans_t
{
  const double* rspscalar;  
  const double* rspvor;     
  const double* rspdiv;     
  const double* rmeanu;     
  const double* rmeanv;     
  double* rgp;              
  int nproma;               
  int nscalar;              
  int nvordiv;              
  int lscalarders;          
  int luvder_EW;            
  int lvordivgp;            
  int ngpblks;              
  int lglobal;              
  struct Trans_t* trans;    
  int count;                
};

struct InvTrans_t new_invtrans(struct Trans_t* trans);
 

 
struct InvTransAdj_t
{
  double* rspscalar;        
  double* rspvor;           
  double* rspdiv;           
  const double* rmeanu;     
  const double* rmeanv;     
  const double* rgp;        
  int nproma;               
  int nscalar;              
  int nvordiv;              
  int lscalarders;          
  int luvder_EW;            
  int lvordivgp;            
  int ngpblks;              
  int lglobal;              
  struct Trans_t* trans;    
  int count;                
};

struct InvTransAdj_t new_invtrans_adj(struct Trans_t* trans);
 
 

struct DistGrid_t
{
  const double* rgpg;    
  double* rgp;           
  const int* nfrom;      
  int nproma;            
  int nfld;              
  int ngpblks;           
  struct Trans_t* trans; 
  int count;             
};

struct DistGrid_t new_distgrid(struct Trans_t* trans);

struct GathGrid_t
{
  double* rgpg;          
  const double* rgp;     
  const int* nto;        
  int nproma;            
  int nfld;              
  int ngpblks;           
  struct Trans_t* trans; 
  int count;             
};

struct GathGrid_t new_gathgrid(struct Trans_t* trans);

struct DistSpec_t
{
  const double* rspecg;  
  double* rspec;         
  const int* nfrom;      
  int nfld;              
  struct Trans_t* trans; 
  int count;             
};

struct DistSpec_t new_distspec(struct Trans_t* trans);

struct GathSpec_t
{
  double* rspecg;        
  const double* rspec;   
  const int* nto;        
  int nfld;              
  struct Trans_t* trans; 
  int count;             
};

struct GathSpec_t new_gathspec(struct Trans_t* trans);

struct VorDivToUV_t
{
  const double* rspvor;  
  const double* rspdiv;  
  double* rspu;          
  double* rspv;          
  int nfld;              
  int nsmax;             
  int ncoeff;            
  int count;             
};

struct VorDivToUV_t new_vordiv_to_UV(void);
 
 
struct SpecNorm_t
{
  const double *rspec;     
  int nmaster;             
  const double *rmet;      
  double* rnorm;           
  int nfld;                
  struct Trans_t* trans;   
  int count;               
};

struct SpecNorm_t new_specnorm(struct Trans_t* trans);
 
#ifdef __cplusplus
}
#endif
 
#endif