/[MITgcm]/MITgcm/eesupp/inc/CPP_EEMACROS.h
ViewVC logotype

Diff of /MITgcm/eesupp/inc/CPP_EEMACROS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1 by adcroft, Wed Apr 5 15:23:20 2000 UTC revision 1.17 by jmc, Tue Apr 28 17:51:11 2009 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C  C $Name$
3  C     /==========================================================\  
4  C     | CPP_EEMACROS.h                                           |  CBOP
5  C     |==========================================================|  C     !ROUTINE: CPP_EEMACROS.h
6  C     | C preprocessor "execution environment" supporting        |  C     !INTERFACE:
7  C     | macros. Use this file to define macros for  simplifying  |  C     include "CPP_EEMACROS.h "
8  C     | execution environment in which a model runs - as opposed |  C     !DESCRIPTION:
9  C     | to the dynamical problem the model solves.               |  C     *==========================================================*
10  C     \==========================================================/  C     | CPP_EEMACROS.h
11    C     *==========================================================*
12    C     | C preprocessor "execution environment" supporting
13    C     | macros. Use this file to define macros for  simplifying
14    C     | execution environment in which a model runs - as opposed
15    C     | to the dynamical problem the model solves.
16    C     *==========================================================*
17    CEOP
18    
19  #ifndef _CPP_EEMACROS_H_  #ifndef _CPP_EEMACROS_H_
20  #define _CPP_EEMACROS_H_  #define _CPP_EEMACROS_H_
# Line 28  C     Flag used to indicate which flavou Line 35  C     Flag used to indicate which flavou
35  C     compiler directives to use. Only set one of these.  C     compiler directives to use. Only set one of these.
36  C     USE_SOLARIS_THREADING  - Takes directives for SUN Workshop  C     USE_SOLARIS_THREADING  - Takes directives for SUN Workshop
37  C                              compiler.  C                              compiler.
38  C     USE_KAP_THREADING      - Takes directives for Kuck and  C     USE_KAP_THREADING      - Takes directives for Kuck and
39  C                              Associates multi-threading compiler  C                              Associates multi-threading compiler
40  C                              ( used on Digital platforms ).  C                              ( used on Digital platforms ).
41  C     USE_IRIX_THREADING     - Takes directives for SGI MIPS  C     USE_IRIX_THREADING     - Takes directives for SGI MIPS
# Line 39  C     USE_C90_THREADING      - Takes dir Line 46  C     USE_C90_THREADING      - Takes dir
46  C                              system F90 compiler.  C                              system F90 compiler.
47  #ifdef TARGET_SUN  #ifdef TARGET_SUN
48  #define USE_SOLARIS_THREADING  #define USE_SOLARIS_THREADING
49    #define USING_THREADS
50  #endif  #endif
51    
52  #ifdef TARGET_DEC  #ifdef TARGET_DEC
53  #define USE_KAP_THREADING  #define USE_KAP_THREADING
54    #define USING_THREADS
55  #endif  #endif
56    
57  #ifdef TARGET_SGI  #ifdef TARGET_SGI
58  #define USE_IRIX_THREADING  #define USE_IRIX_THREADING
59    #define USING_THREADS
60  #endif  #endif
61    
62  #ifdef TARGET_HP  #ifdef TARGET_HP
63  #define USE_EXEMPLAR_THREADING  #define USE_EXEMPLAR_THREADING
64    #define USING_THREADS
65  #endif  #endif
66    
67  #ifdef TARGET_CRAY_VECTOR  #ifdef TARGET_CRAY_VECTOR
68  #define USE_C90_THREADING  #define USE_C90_THREADING
69    #define USING_THREADS
70    #endif
71    
72    #ifdef USE_OMP_THREADING
73    #define USING_THREADS
74  #endif  #endif
75    
76  C--   Define the mapping for the _BARRIER macro  C--   Define the mapping for the _BARRIER macro
# Line 62  C     On some systems low-level hardware Line 78  C     On some systems low-level hardware
78  C     compiler directives here.  C     compiler directives here.
79  #define _BARRIER CALL BARRIER(myThid)  #define _BARRIER CALL BARRIER(myThid)
80    
81  C--   Define the mapping for the BEGIN_CRIT() and  END_CRIT() macros.  C--   Define the mapping for the BEGIN_CRIT() and  END_CRIT() macros.
82  C     On some systems we simply execute this section only using the  C     On some systems we simply execute this section only using the
83  C     master thread i.e. its not really a critical section. We can  C     master thread i.e. its not really a critical section. We can
84  C     do this because we do not use critical sections in any critical  C     do this because we do not use critical sections in any critical
# Line 74  C--   Define the mapping for the BEGIN_M Line 90  C--   Define the mapping for the BEGIN_M
90  C     END_MASTER_SECTION() macros. These are generally implemented by  C     END_MASTER_SECTION() macros. These are generally implemented by
91  C     simply choosing a particular thread to be "the master" and have  C     simply choosing a particular thread to be "the master" and have
92  C     it alone execute the BEGIN_MASTER..., END_MASTER.. sections.  C     it alone execute the BEGIN_MASTER..., END_MASTER.. sections.
 #define _BEGIN_MASTER(a)  IF ( a .EQ. 1 ) THEN  
 #define _END_MASTER(a)    ENDIF  
93    
94  C--   Control use of JAM routines for Artic network  #define _BEGIN_MASTER(a) IF ( a .EQ. 1 ) THEN
95  C     These invoke optimized versions of "exchange" and "sum" that  #define _END_MASTER(a)   ENDIF
96  C     utilize the programmable aspect of Artic cards.  CcnhDebugStarts
97  #ifdef LETS_MAKE_JAM  C      Alternate form to the above macros that increments (decrements) a counter each
98  #define _JAMEXT _jam  C      time a MASTER section is entered (exited). This counter can then be checked in barrier
99  #else  C      to try and detect calls to BARRIER within single threaded sections.
100  #define _JAMEXT  C      Using these macros requires two changes to Makefile - these changes are written
101  #endif  C      below.
102    C      1 - add a filter to the CPP command to kill off commented _MASTER lines
103    C      2 - add a filter to the CPP output the converts the string N EWLINE to an actual newline.
104    C      The N EWLINE needs to be changes to have no space when this macro and Makefile changes
105    C      are used. Its in here with a space to stop it getting parsed by the CPP stage in these
106    C      comments.
107    C      #define _BEGIN_MASTER(a)  IF ( a .EQ. 1 ) THEN  N EWLINE      CALL BARRIER_MS(a)
108    C      #define _END_MASTER(a)    CALL BARRIER_MU(a) N EWLINE        ENDIF
109    C      'CPP = cat $< | $(TOOLSDIR)/set64bitConst.sh |  grep -v '^[cC].*_MASTER' | cpp  -traditional -P'
110    C      .F.f:
111    C               $(CPP) $(DEFINES) $(INCLUDES) |  sed 's/N EWLINE/\n/' > $@
112    CcnhDebugEnds
113    
114  C--   Control storage of floating point operands  C--   Control storage of floating point operands
115  C     On many systems it improves performance only to use  C     On many systems it improves performance only to use
# Line 94  C     can use 4-byte precision, reducing Line 119  C     can use 4-byte precision, reducing
119  C     boosting performance because of a smaller working  C     boosting performance because of a smaller working
120  C     set size. However, on vector CRAY systems this degrades  C     set size. However, on vector CRAY systems this degrades
121  C     performance.  C     performance.
122    C- Note: global_sum/max macros were used to switch to  JAM routines (obsolete);
123    C  in addition, since only the R4 & R8 S/R are coded, GLOBAL RS & RL macros
124    C  enable to call the corresponding R4 or R8 S/R.
125  #ifdef REAL4_IS_SLOW  #ifdef REAL4_IS_SLOW
126  #define _RS Real*8  #define _RS Real*8
127  #define RS_IS_REAL8  #define RS_IS_REAL8
128  #define _EXCH_XY_R4(a,b) CALL EXCH_XY_R8 _JAMEXT ( a, b )  #define _GLOBAL_SUM_RS(a,b) CALL GLOBAL_SUM_R8 ( a, b)
129  #define _EXCH_XYZ_R4(a,b) CALL EXCH_XYZ_R8 _JAMEXT ( a, b )  #define _GLOBAL_MAX_RS(a,b) CALL GLOBAL_MAX_R8 ( a, b )
130  #define _GLOBAL_SUM_R4(a,b) CALL GLOBAL_SUM_R8 _JAMEXT ( a, b)  #define _MPI_TYPE_RS MPI_DOUBLE_PRECISION
 #define _GLOBAL_MAX_R4(a,b) CALL GLOBAL_MAX_R8 ( a, b )  
131  #else  #else
132  #define _RS Real*4  #define _RS Real*4
133  #define RS_IS_REAL4  #define RS_IS_REAL4
134  #define _EXCH_XY_R4(a,b) CALL EXCH_XY_R4 ( a, b )  #define _GLOBAL_SUM_RS(a,b) CALL GLOBAL_SUM_R4 ( a, b )
135  #define _EXCH_XYZ_R4(a,b) CALL EXCH_XYZ_R4 ( a, b )  #define _GLOBAL_MAX_RS(a,b) CALL GLOBAL_MAX_R4 ( a, b )
136  #define _GLOBAL_SUM_R4(a,b) CALL GLOBAL_SUM_R4 ( a, b )  #define _MPI_TYPE_RS MPI_REAL
 #define _GLOBAL_MAX_R4(a,b) CALL GLOBAL_MAX_R4 ( a, b )  
137  #endif  #endif
138    
139  #define _RL Real*8  #define _RL Real*8
140  #define _EXCH_XY_R8(a,b) CALL EXCH_XY_R8 _JAMEXT ( a, b )  #define RL_IS_REAL8
141  #define _EXCH_XYZ_R8(a,b) CALL EXCH_XYZ_R8 _JAMEXT ( a, b )  #define _GLOBAL_SUM_RL(a,b) CALL GLOBAL_SUM_R8 ( a, b )
142  #define _GLOBAL_SUM_R8(a,b) CALL GLOBAL_SUM_R8 _JAMEXT ( a, b )  #define _GLOBAL_MAX_RL(a,b) CALL GLOBAL_MAX_R8 ( a, b )
143  #define _GLOBAL_MAX_R8(a,b) CALL GLOBAL_MAX_R8 ( a, b )  #define _MPI_TYPE_RL MPI_DOUBLE_PRECISION
144    
145    #define _MPI_TYPE_R4 MPI_REAL
146    #if (defined (TARGET_SGI) || defined (TARGET_AIX) || defined (TARGET_LAM))
147    #define _MPI_TYPE_R8 MPI_DOUBLE_PRECISION
148    #else
149    #define _MPI_TYPE_R8 MPI_REAL8
150    #endif
151    #define _R4 Real*4
152    #define _R8 Real*8
153    
154    C- Note: a) exch macros were used to switch to  JAM routines (obsolete)
155    C        b) exch R4 & R8 macros are not practically used ; if needed,
156    C           will directly call the corrresponding S/R.
157    #define _EXCH_XY_RS(a,b) CALL EXCH_XY_RS ( a, b )
158    #define _EXCH_XY_RL(a,b) CALL EXCH_XY_RL ( a, b )
159    c#define _EXCH_XY_R4(a,b) CALL EXCH_XY_R4 ( a, b )
160    c#define _EXCH_XY_R8(a,b) CALL EXCH_XY_R8 ( a, b )
161    #define _EXCH_XYZ_RS(a,b) CALL EXCH_XYZ_RS ( a, b )
162    #define _EXCH_XYZ_RL(a,b) CALL EXCH_XYZ_RL ( a, b )
163    c#define _EXCH_XYZ_R4(a,b) CALL EXCH_XYZ_R4 ( a, b )
164    c#define _EXCH_XYZ_R8(a,b) CALL EXCH_XYZ_R8 ( a, b )
165    
166    C--   Control use of JAM routines for Artic network (no longer supported)
167    C     These invoke optimized versions of "exchange" and "sum" that
168    C     utilize the programmable aspect of Artic cards.
169    #ifdef LETS_MAKE_JAM
170    #define _GLOBAL_SUM_RS(a,b) CALL GLOBAL_SUM_R8_JAM ( a, b)
171    #define _GLOBAL_SUM_RL(a,b) CALL GLOBAL_SUM_R8_JAM ( a, b )
172    #define _EXCH_XY_RS(a,b) CALL EXCH_XY_R8_JAM ( a, b )
173    #define _EXCH_XY_RL(a,b) CALL EXCH_XY_R8_JAM ( a, b )
174    #define _EXCH_XYZ_RS(a,b) CALL EXCH_XYZ_R8_JAM ( a, b )
175    #define _EXCH_XYZ_RL(a,b) CALL EXCH_XYZ_R8_JAM ( a, b )
176    #endif
177    
178  C--   Control use of "double" precision constants.  C--   Control use of "double" precision constants.
179  C     Use D0 where it means REAL*8 but not where it means REAL*16  C     Use D0 where it means REAL*8 but not where it means REAL*16
180  #ifdef REAL_D0_IS_16BYTES  #ifdef REAL_D0_IS_16BYTES
# Line 127  C     Sun compilers do not use 8-byte pr Line 186  C     Sun compilers do not use 8-byte pr
186  C     unless .Dnn is specified. CRAY vector machines use 16-byte  C     unless .Dnn is specified. CRAY vector machines use 16-byte
187  C     precision when they see .Dnn which runs very slowly!  C     precision when they see .Dnn which runs very slowly!
188  #ifdef REAL_D0_IS_16BYTES  #ifdef REAL_D0_IS_16BYTES
189  #define _d  #define _d E
190  #define _F64( a ) a  #define _F64( a ) a
191  #endif  #endif
192  #ifndef REAL_D0_IS_16BYTES  #ifndef REAL_D0_IS_16BYTES
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.17
  ViewVC Help
Powered by ViewVC 1.1.22