| 1 | 
C $Header: /u/u0/gcmpack/MITgcm/model/src/ini_grid.F,v 1.12 2002/02/15 21:25:09 heimbach Exp $ | 
| 2 | 
C $Name: checkpoint48 $ | 
| 3 | 
 | 
| 4 | 
#include "CPP_OPTIONS.h" | 
| 5 | 
 | 
| 6 | 
CBOP | 
| 7 | 
C     !ROUTINE: INI_GRID | 
| 8 | 
C     !INTERFACE: | 
| 9 | 
      SUBROUTINE INI_GRID( myThid ) | 
| 10 | 
C     !DESCRIPTION: \bv | 
| 11 | 
C     *==========================================================* | 
| 12 | 
C     | SUBROUTINE INI_GRID                                        | 
| 13 | 
C     | o Initialise model grid                                    | 
| 14 | 
C     *==========================================================* | 
| 15 | 
C     | These arrays are used throughout the code in evaluating    | 
| 16 | 
C     | gradients, integrals and spatial avarages. This routine    | 
| 17 | 
C     | is called separately by each thread and initialise only    | 
| 18 | 
C     | the region of the domain it is "responsible" for.          | 
| 19 | 
C     | Notes:                                                     | 
| 20 | 
C     | Two examples are shown in this code. One illustrates the   | 
| 21 | 
C     | initialisation of a cartesian grid. The other shows the    | 
| 22 | 
C     | inialisation of a spherical polar grid. Other orthonormal  | 
| 23 | 
C     | grids can be fitted into this design. In this case         | 
| 24 | 
C     | custom metric terms also need adding to account for the    | 
| 25 | 
C     | projections of velocity vectors onto these grids.          | 
| 26 | 
C     | The structure used here also makes it possible to          | 
| 27 | 
C     | implement less regular grid mappings. In particular        | 
| 28 | 
C     | o Schemes which leave out blocks of the domain that are    | 
| 29 | 
C     |   all land could be supported.                             | 
| 30 | 
C     | o Multi-level schemes such as icosohedral or cubic         | 
| 31 | 
C     |   grid projectedions onto a sphere can also be fitted      | 
| 32 | 
C     |   within the strategy we use.                              | 
| 33 | 
C     |   Both of the above also require modifying the support     | 
| 34 | 
C     |   routines that map computational blocks to simulation     | 
| 35 | 
C     |   domain blocks.                                           | 
| 36 | 
C     *==========================================================* | 
| 37 | 
C     \ev | 
| 38 | 
 | 
| 39 | 
C     !USES: | 
| 40 | 
      IMPLICIT NONE | 
| 41 | 
C     === Global variables === | 
| 42 | 
#include "SIZE.h" | 
| 43 | 
#include "EEPARAMS.h" | 
| 44 | 
#include "PARAMS.h" | 
| 45 | 
#include "GRID.h" | 
| 46 | 
 | 
| 47 | 
C     !INPUT/OUTPUT PARAMETERS: | 
| 48 | 
C     == Routine arguments == | 
| 49 | 
C     myThid -  Number of this instance of INI_GRID | 
| 50 | 
      INTEGER myThid | 
| 51 | 
 | 
| 52 | 
C     !LOCAL VARIABLES: | 
| 53 | 
C     == Local variables == | 
| 54 | 
C     msgBuf - Used for informational I/O. | 
| 55 | 
      CHARACTER*(MAX_LEN_MBUF) msgBuf | 
| 56 | 
CEOP | 
| 57 | 
 | 
| 58 | 
C--   Set up vertical grid and coordinate system | 
| 59 | 
      CALL INI_VERTICAL_GRID( myThid ) | 
| 60 | 
 | 
| 61 | 
C--   Set up horizontal grid and coordinate system | 
| 62 | 
      IF ( usingCartesianGrid ) THEN | 
| 63 | 
       CALL INI_CARTESIAN_GRID( myThid ) | 
| 64 | 
      ELSEIF ( usingSphericalPolarGrid ) THEN | 
| 65 | 
       CALL INI_SPHERICAL_POLAR_GRID( myThid ) | 
| 66 | 
      ELSEIF ( usingCurvilinearGrid ) THEN | 
| 67 | 
       CALL INI_CURVILINEAR_GRID( myThid ) | 
| 68 | 
      ELSEIF ( bUseCylindricalGrid ) THEN | 
| 69 | 
       CALL INI_CYLINDER( myThid ) | 
| 70 | 
      ELSE | 
| 71 | 
       _BEGIN_MASTER(myThid) | 
| 72 | 
        WRITE(msgBuf,'(A)')  | 
| 73 | 
     &   'S/R INI_GRID: No grid coordinate system has been selected' | 
| 74 | 
         CALL PRINT_ERROR( msgBuf , myThid) | 
| 75 | 
         STOP 'ABNORMAL END: S/R INI_GRID' | 
| 76 | 
       _END_MASTER(myThid) | 
| 77 | 
      ENDIF | 
| 78 | 
 | 
| 79 | 
C--   Write certain grid data to files (useful for creating netCDF | 
| 80 | 
C     and general post-analysis) | 
| 81 | 
      CALL WRITE_FLD_XY_RS( 'XC',' ',XC,0,myThid) | 
| 82 | 
      CALL WRITE_FLD_XY_RS( 'YC',' ',YC,0,myThid) | 
| 83 | 
      CALL WRITE_FLD_XY_RS( 'XG',' ',XG,0,myThid) | 
| 84 | 
      CALL WRITE_FLD_XY_RS( 'YG',' ',YG,0,myThid) | 
| 85 | 
      CALL WRITE_FLD_XY_RS( 'RAC',' ',rA,0,myThid) | 
| 86 | 
      CALL WRITE_FLD_XY_RS( 'RAW',' ',rAw,0,myThid) | 
| 87 | 
      CALL WRITE_FLD_XY_RS( 'RAS',' ',rAs,0,myThid) | 
| 88 | 
      CALL WRITE_FLD_XY_RS( 'DXG',' ',DXG,0,myThid) | 
| 89 | 
      CALL WRITE_FLD_XY_RS( 'DYG',' ',DYG,0,myThid) | 
| 90 | 
      CALL WRITE_FLD_XY_RS( 'DXC',' ',DXC,0,myThid) | 
| 91 | 
      CALL WRITE_FLD_XY_RS( 'DYC',' ',DYC,0,myThid) | 
| 92 | 
 | 
| 93 | 
C--   Print out statistics of each horizontal grid array (helps when debugging) | 
| 94 | 
 | 
| 95 | 
#ifndef EXCLUDE_MONITOR | 
| 96 | 
      CALL MON_PRINTSTATS_RS(1,XC,'XC',myThid) | 
| 97 | 
      CALL MON_PRINTSTATS_RS(1,XG,'XG',myThid) | 
| 98 | 
      CALL MON_PRINTSTATS_RS(1,DXC,'DXC',myThid) | 
| 99 | 
      CALL MON_PRINTSTATS_RS(1,DXF,'DXF',myThid) | 
| 100 | 
      CALL MON_PRINTSTATS_RS(1,DXG,'DXG',myThid) | 
| 101 | 
      CALL MON_PRINTSTATS_RS(1,DXV,'DXV',myThid) | 
| 102 | 
      CALL MON_PRINTSTATS_RS(1,YC,'YC',myThid) | 
| 103 | 
      CALL MON_PRINTSTATS_RS(1,YG,'YG',myThid) | 
| 104 | 
      CALL MON_PRINTSTATS_RS(1,DYC,'DYC',myThid) | 
| 105 | 
      CALL MON_PRINTSTATS_RS(1,DYF,'DYF',myThid) | 
| 106 | 
      CALL MON_PRINTSTATS_RS(1,DYG,'DYG',myThid) | 
| 107 | 
      CALL MON_PRINTSTATS_RS(1,DYU,'DYU',myThid) | 
| 108 | 
      CALL MON_PRINTSTATS_RS(1,RA,'RA',myThid) | 
| 109 | 
      CALL MON_PRINTSTATS_RS(1,RAW,'RAW',myThid) | 
| 110 | 
      CALL MON_PRINTSTATS_RS(1,RAS,'RAS',myThid) | 
| 111 | 
      CALL MON_PRINTSTATS_RS(1,RAZ,'RAZ',myThid) | 
| 112 | 
#endif | 
| 113 | 
 | 
| 114 | 
      RETURN | 
| 115 | 
      END |