| 1 | dimitri | 1.2 | C $Header: /u/gcmpack/MITgcm_contrib/submesoscale/code/ini_grid.F,v 1.1 2008/05/31 00:13:54 dimitri Exp $ | 
| 2 | dimitri | 1.1 | C $Name:  $ | 
| 3 |  |  |  | 
| 4 |  |  | #include "PACKAGES_CONFIG.h" | 
| 5 |  |  | #include "CPP_OPTIONS.h" | 
| 6 |  |  |  | 
| 7 |  |  | CBOP | 
| 8 |  |  | C     !ROUTINE: INI_GRID | 
| 9 |  |  |  | 
| 10 |  |  | C     !INTERFACE: | 
| 11 |  |  | SUBROUTINE INI_GRID( myThid ) | 
| 12 |  |  | C     !DESCRIPTION: | 
| 13 |  |  | C     These arrays are used throughout the code in evaluating gradients, | 
| 14 |  |  | C     integrals and spatial avarages. This routine is called separately | 
| 15 |  |  | C     by each thread and initializes only the region of the domain it is | 
| 16 |  |  | C     "responsible" for. | 
| 17 |  |  |  | 
| 18 |  |  | C     !USES: | 
| 19 |  |  | IMPLICIT NONE | 
| 20 |  |  | #include "SIZE.h" | 
| 21 |  |  | #include "EEPARAMS.h" | 
| 22 |  |  | #include "PARAMS.h" | 
| 23 |  |  | #include "GRID.h" | 
| 24 |  |  | #ifdef ALLOW_MNC | 
| 25 |  |  | #include "MNC_PARAMS.h" | 
| 26 |  |  | #endif | 
| 27 |  |  | #ifdef ALLOW_MONITOR | 
| 28 |  |  | #include "MONITOR.h" | 
| 29 |  |  | #endif | 
| 30 |  |  |  | 
| 31 |  |  | C     !INPUT/OUTPUT PARAMETERS: | 
| 32 |  |  | C     myThid  :: my Thread Id number | 
| 33 |  |  | INTEGER myThid | 
| 34 |  |  | CEOP | 
| 35 |  |  |  | 
| 36 |  |  | C     === Functions ==== | 
| 37 |  |  | LOGICAL  MASTER_CPU_IO | 
| 38 |  |  | EXTERNAL MASTER_CPU_IO | 
| 39 |  |  |  | 
| 40 |  |  | C     !LOCAL VARIABLES: | 
| 41 |  |  | C     msgBuf  :: Informational/error message buffer | 
| 42 |  |  | CHARACTER*(MAX_LEN_MBUF) msgBuf | 
| 43 |  |  | #ifdef ALLOW_MNC | 
| 44 |  |  | INTEGER i | 
| 45 |  |  | #endif | 
| 46 |  |  |  | 
| 47 |  |  | C     load grid spacing (vector) from files | 
| 48 |  |  | CALL LOAD_GRID_SPACING( myThid ) | 
| 49 |  |  |  | 
| 50 |  |  | C     Set up reference vertical profile (vector) for state variables | 
| 51 |  |  | C jmc: this call will not stay here but will move to S/R INITIALISE_FIXED | 
| 52 |  |  | C      (a better place) once anelatic initialisation is cleaned-up. | 
| 53 |  |  | CALL INI_REFERENCE_STATE( myThid ) | 
| 54 |  |  |  | 
| 55 |  |  | C     Set up vertical grid and coordinate system | 
| 56 |  |  | CALL INI_VERTICAL_GRID( myThid ) | 
| 57 |  |  |  | 
| 58 |  |  | C     Two examples are shown in this code. One illustrates the | 
| 59 |  |  | C     initialization of a cartesian grid. The other shows the | 
| 60 |  |  | C     inialization of a spherical polar grid. Other orthonormal grids | 
| 61 |  |  | C     can be fitted into this design. In this case custom metric terms | 
| 62 |  |  | C     also need adding to account for the projections of velocity | 
| 63 |  |  | C     vectors onto these grids.  The structure used here also makes it | 
| 64 |  |  | C     possible to implement less regular grid mappings. In particular: | 
| 65 |  |  | C      o Schemes which leave out blocks of the domain that are | 
| 66 |  |  | C        all land could be supported. | 
| 67 |  |  | C      o Multi-level schemes such as icosohedral or cubic | 
| 68 |  |  | C        grid projectedions onto a sphere can also be fitted | 
| 69 |  |  | C       within the strategy we use. | 
| 70 |  |  | C        Both of the above also require modifying the support | 
| 71 |  |  | C        routines that map computational blocks to simulation | 
| 72 |  |  | C        domain blocks. | 
| 73 |  |  |  | 
| 74 |  |  | C     Set up horizontal grid and coordinate system | 
| 75 |  |  | IF ( usingCartesianGrid ) THEN | 
| 76 |  |  | CALL INI_CARTESIAN_GRID( myThid ) | 
| 77 |  |  | ELSEIF ( usingSphericalPolarGrid ) THEN | 
| 78 |  |  | CALL INI_SPHERICAL_POLAR_GRID( myThid ) | 
| 79 |  |  | ELSEIF ( usingCurvilinearGrid ) THEN | 
| 80 |  |  | CALL INI_CURVILINEAR_GRID( myThid ) | 
| 81 |  |  | ELSEIF ( usingCylindricalGrid ) THEN | 
| 82 |  |  | CALL INI_CYLINDER_GRID( myThid ) | 
| 83 |  |  | ELSE | 
| 84 |  |  | _BEGIN_MASTER(myThid) | 
| 85 |  |  | WRITE(msgBuf,'(2A)') 'S/R INI_GRID: ', | 
| 86 |  |  | &       'No grid coordinate system has been selected' | 
| 87 |  |  | CALL PRINT_ERROR( msgBuf , myThid) | 
| 88 |  |  | STOP 'ABNORMAL END: S/R INI_GRID' | 
| 89 |  |  | _END_MASTER(myThid) | 
| 90 |  |  | ENDIF | 
| 91 |  |  |  | 
| 92 | dimitri | 1.2 | #ifdef ALLOW_OBCS | 
| 93 |  |  | IF ( useOBCS ) THEN | 
| 94 |  |  | C     Fix overlap regions to avoid discontinuities in dxc, dyc, etc. | 
| 95 |  |  | CALL OBCS_CHECK_GRID( myThid ) | 
| 96 |  |  | ENDIF | 
| 97 |  |  | #endif /* ALLOW_OBCS */ | 
| 98 |  |  |  | 
| 99 | dimitri | 1.1 | #ifdef ALLOW_MONITOR | 
| 100 |  |  | IF ( MASTER_CPU_IO(myThid) ) THEN | 
| 101 |  |  | C--   only the master thread is allowed to switch On/Off mon_write_stdout | 
| 102 |  |  | C     & mon_write_mnc (since it's the only thread that uses those flags): | 
| 103 |  |  |  | 
| 104 |  |  | IF (monitor_stdio) THEN | 
| 105 |  |  | mon_write_stdout = .TRUE. | 
| 106 |  |  | ELSE | 
| 107 |  |  | mon_write_stdout = .FALSE. | 
| 108 |  |  | ENDIF | 
| 109 |  |  | mon_write_mnc = .FALSE. | 
| 110 |  |  | #ifdef ALLOW_MNC | 
| 111 |  |  | IF (useMNC .AND. monitor_mnc) THEN | 
| 112 |  |  | DO i = 1,MAX_LEN_MBUF | 
| 113 |  |  | mon_fname(i:i) = ' ' | 
| 114 |  |  | ENDDO | 
| 115 |  |  | mon_fname(1:12) = 'monitor_grid' | 
| 116 |  |  | CALL MNC_CW_SET_UDIM(mon_fname, 1, myThid) | 
| 117 |  |  | mon_write_mnc = .TRUE. | 
| 118 |  |  | ENDIF | 
| 119 |  |  | #endif /*  ALLOW_MNC  */ | 
| 120 |  |  |  | 
| 121 |  |  | ENDIF | 
| 122 |  |  |  | 
| 123 |  |  | C     Print out statistics of each horizontal grid array (helps when | 
| 124 |  |  | C     debugging) | 
| 125 |  |  | CALL MON_PRINTSTATS_RS(1,xC,'XC',myThid) | 
| 126 |  |  | CALL MON_PRINTSTATS_RS(1,xG,'XG',myThid) | 
| 127 |  |  | CALL MON_PRINTSTATS_RS(1,dxC,'DXC',myThid) | 
| 128 |  |  | CALL MON_PRINTSTATS_RS(1,dxF,'DXF',myThid) | 
| 129 |  |  | CALL MON_PRINTSTATS_RS(1,dxG,'DXG',myThid) | 
| 130 |  |  | CALL MON_PRINTSTATS_RS(1,dxV,'DXV',myThid) | 
| 131 |  |  | CALL MON_PRINTSTATS_RS(1,yC,'YC',myThid) | 
| 132 |  |  | CALL MON_PRINTSTATS_RS(1,yG,'YG',myThid) | 
| 133 |  |  | CALL MON_PRINTSTATS_RS(1,dyC,'DYC',myThid) | 
| 134 |  |  | CALL MON_PRINTSTATS_RS(1,dyF,'DYF',myThid) | 
| 135 |  |  | CALL MON_PRINTSTATS_RS(1,dyG,'DYG',myThid) | 
| 136 |  |  | CALL MON_PRINTSTATS_RS(1,dyU,'DYU',myThid) | 
| 137 |  |  | CALL MON_PRINTSTATS_RS(1,rA,'RA',myThid) | 
| 138 |  |  | CALL MON_PRINTSTATS_RS(1,rAw,'RAW',myThid) | 
| 139 |  |  | CALL MON_PRINTSTATS_RS(1,rAs,'RAS',myThid) | 
| 140 |  |  | CALL MON_PRINTSTATS_RS(1,rAz,'RAZ',myThid) | 
| 141 |  |  | CALL MON_PRINTSTATS_RS(1,angleCosC,'AngleCS',myThid) | 
| 142 |  |  | CALL MON_PRINTSTATS_RS(1,angleSinC,'AngleSN',myThid) | 
| 143 |  |  |  | 
| 144 |  |  | IF ( MASTER_CPU_IO(myThid) ) THEN | 
| 145 |  |  | mon_write_stdout = .FALSE. | 
| 146 |  |  | mon_write_mnc    = .FALSE. | 
| 147 |  |  | ENDIF | 
| 148 |  |  | #endif /* ALLOW_MONITOR */ | 
| 149 |  |  |  | 
| 150 |  |  | C--   Everyone else must wait for the grid to be set | 
| 151 |  |  | _BARRIER | 
| 152 |  |  |  | 
| 153 |  |  | RETURN | 
| 154 |  |  | END |