| 1 | dgoldberg | 1.1 | C $Header: /u/gcmpack/MITgcm_contrib/verification_other/shelfice_remeshing/code/shelfice_readparms.F,v 1.4 2016/01/26 10:49:13 dgoldberg Exp $ | 
| 2 |  |  | C $Name:  $ | 
| 3 |  |  |  | 
| 4 |  |  | #include "SHELFICE_OPTIONS.h" | 
| 5 |  |  |  | 
| 6 |  |  | CBOP | 
| 7 |  |  | C !ROUTINE: SHELFICE_READPARMS | 
| 8 |  |  |  | 
| 9 |  |  | C !INTERFACE: ========================================================== | 
| 10 |  |  | SUBROUTINE SHELFICE_READPARMS( myThid ) | 
| 11 |  |  |  | 
| 12 |  |  | C !DESCRIPTION: | 
| 13 |  |  | C     Initialize SHELFICE parameters, read in data.shelfice | 
| 14 |  |  |  | 
| 15 |  |  | C !USES: =============================================================== | 
| 16 |  |  | IMPLICIT NONE | 
| 17 |  |  | #include "SIZE.h" | 
| 18 |  |  | #include "EEPARAMS.h" | 
| 19 |  |  | #include "PARAMS.h" | 
| 20 |  |  | #include "SHELFICE.h" | 
| 21 |  |  | #ifdef ALLOW_COST | 
| 22 |  |  | # include "SHELFICE_COST.h" | 
| 23 |  |  | #endif /* ALLOW_COST */ | 
| 24 |  |  | #ifdef ALLOW_MNC | 
| 25 |  |  | # include "MNC_PARAMS.h" | 
| 26 |  |  | #endif | 
| 27 |  |  |  | 
| 28 |  |  | C !INPUT PARAMETERS: =================================================== | 
| 29 |  |  | C  myThid               :: thread number | 
| 30 |  |  | INTEGER myThid | 
| 31 |  |  |  | 
| 32 |  |  | C !OUTPUT PARAMETERS: ================================================== | 
| 33 |  |  | C  none | 
| 34 |  |  |  | 
| 35 |  |  | #ifdef ALLOW_SHELFICE | 
| 36 |  |  |  | 
| 37 |  |  | C !LOCAL VARIABLES: ==================================================== | 
| 38 |  |  | C  iUnit                :: unit number for I/O | 
| 39 |  |  | C  msgBuf               :: message buffer | 
| 40 |  |  | INTEGER iUnit | 
| 41 |  |  | CHARACTER*(MAX_LEN_MBUF) msgBuf | 
| 42 |  |  | CEOP | 
| 43 |  |  |  | 
| 44 |  |  | NAMELIST /SHELFICE_PARM01/ | 
| 45 |  |  | &     SHELFICEheatTransCoeff, | 
| 46 |  |  | &     SHELFICEsaltTransCoeff, | 
| 47 |  |  | &     SHELFICEMassStepping, | 
| 48 |  |  | &     rhoShelfice, SHELFICEkappa, | 
| 49 |  |  | &     SHELFICElatentHeat, SHELFICEHeatCapacity_Cp, | 
| 50 |  |  | &     SHELFICEDragLinear, SHELFICEDragQuadratic, | 
| 51 |  |  | &     SHELFICEthetaSurface, | 
| 52 |  |  | &     useISOMIPTD, no_slip_shelfice, | 
| 53 |  |  | &     SHELFICEconserve, SHELFICEboundaryLayer, | 
| 54 |  |  | &     SHELFICEthickBoundaryLayer, | 
| 55 |  |  | &     SHELFICErealFWflux, | 
| 56 |  |  | &     SHELFICEwriteState, | 
| 57 |  |  | &     SHELFICE_dumpFreq, | 
| 58 |  |  | &     SHELFICE_taveFreq, | 
| 59 |  |  | &     SHELFICE_tave_mnc, | 
| 60 |  |  | &     SHELFICE_dump_mnc, | 
| 61 |  |  | &     SHELFICEtopoFile, | 
| 62 |  |  | &     SHELFICEmassFile, SHELFICEloadAnomalyFile, | 
| 63 |  |  | &     SHELFICEMassDynTendFile, | 
| 64 |  |  | &     SHELFICEDynMassOnly, | 
| 65 |  |  | &     SHELFICEadvDiffHeatFlux, | 
| 66 |  |  | &     SHELFICEuseGammaFrict, | 
| 67 |  |  | &     SHELFICERemeshFrequency, | 
| 68 |  |  | &     SHELFICESplitThreshold, | 
| 69 |  |  | &     SHELFICEMergeThreshold, | 
| 70 |  |  | &     shiCdrag, shiZetaN, shiRc, | 
| 71 |  |  | &     shiPrandtl, shiSchmidt, shiKinVisc, | 
| 72 |  |  | &     shelficeEtaSponge, ShelficeEtaRelax, | 
| 73 |  |  | &     shelfice_etarestore_spongewidth | 
| 74 |  |  | #ifdef ALLOW_COST | 
| 75 |  |  | &     , mult_shelfice | 
| 76 |  |  | &     , mult_shifwflx, wshifwflx0, shifwflx_errfile | 
| 77 |  |  | #endif | 
| 78 |  |  |  | 
| 79 |  |  | C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| | 
| 80 |  |  |  | 
| 81 |  |  | IF ( .NOT.useShelfIce ) THEN | 
| 82 |  |  | C-    pkg SHELFICE is not used | 
| 83 |  |  | _BEGIN_MASTER(myThid) | 
| 84 |  |  | C-    Track pkg activation status: | 
| 85 |  |  | SHELFICEisOn = .FALSE. | 
| 86 |  |  | C     print a (weak) warning if data.shelfice is found | 
| 87 |  |  | CALL PACKAGES_UNUSED_MSG( 'useShelfIce', ' ', ' ' ) | 
| 88 |  |  | _END_MASTER(myThid) | 
| 89 |  |  | RETURN | 
| 90 |  |  | ENDIF | 
| 91 |  |  |  | 
| 92 |  |  | _BEGIN_MASTER(myThid) | 
| 93 |  |  |  | 
| 94 |  |  | C This routine has been called by the main model so we set our | 
| 95 |  |  | C internal flag to indicate we are in business | 
| 96 |  |  | SHELFICEisOn = .TRUE. | 
| 97 |  |  |  | 
| 98 |  |  | C Set defaults values for parameters in SHELFICE.h | 
| 99 |  |  | useISOMIPTD              = .FALSE. | 
| 100 |  |  | SHELFICEconserve         = .FALSE. | 
| 101 |  |  | SHELFICEboundaryLayer    = .FALSE. | 
| 102 |  |  | SHELFICEthickBoundaryLayer | 
| 103 |  |  | &                         = .FALSE. | 
| 104 |  |  | SHELFICErealFWflux       = .FALSE. | 
| 105 |  |  | SHELFICEMassStepping     = .FALSE. | 
| 106 |  |  | SHELFICEDynMassOnly      = .FALSE. | 
| 107 |  |  | SHELFICEtopoFile         = ' ' | 
| 108 |  |  | SHELFICEmassFile         = ' ' | 
| 109 |  |  | SHELFICEloadAnomalyFile  = ' ' | 
| 110 |  |  | SHELFICEMassDynTendFile  = ' ' | 
| 111 |  |  | SHELFICElatentHeat       =  334.0 _d 3 | 
| 112 |  |  | SHELFICEHeatCapacity_Cp  = 2000.0 _d 0 | 
| 113 |  |  | rhoShelfIce              =  917.0 _d 0 | 
| 114 |  |  | SHELFICEheatTransCoeff   =    1.0 _d -04 | 
| 115 |  |  | SHELFICEsaltTransCoeff   = UNSET_RL | 
| 116 |  |  | SHELFICEkappa            =   1.54 _d -06 | 
| 117 |  |  | SHELFICEthetaSurface     = - 20.0 _d 0 | 
| 118 |  |  | no_slip_shelfice         = no_slip_bottom | 
| 119 |  |  | SHELFICEDragLinear       = bottomDragLinear | 
| 120 |  |  | SHELFICEDragQuadratic    = UNSET_RL | 
| 121 |  |  | SHELFICEselectDragQuadr  = -1 | 
| 122 |  |  | SHELFICEwriteState       = .FALSE. | 
| 123 |  |  | SHELFICE_dumpFreq        = dumpFreq | 
| 124 |  |  | SHELFICE_taveFreq        = taveFreq | 
| 125 |  |  | SHELFICEadvDiffHeatFlux  = .FALSE. | 
| 126 |  |  | SHELFICEuseGammaFrict    = .FALSE. | 
| 127 |  |  | SHELFICERemeshFrequency  = 2592000. | 
| 128 |  |  | SHELFICESplitThreshold   = 5 | 
| 129 |  |  | SHELFICEMergeThreshold   = -8 | 
| 130 |  |  | shelficeEtaRelax         = 0. | 
| 131 |  |  | shelfice_etarestore_spongewidth = 0 | 
| 132 |  |  | shelficeEtaSponge        = .false. | 
| 133 |  |  | C these params. are default of Holland and Jenkins (1999) | 
| 134 |  |  | shiCdrag                 = 0.0015 _d 0 | 
| 135 |  |  | shiZetaN                 = 0.052 _d 0 | 
| 136 |  |  | shiRc                    = 0.2 _d 0 | 
| 137 |  |  | shiPrandtl               = 13.8 _d 0 | 
| 138 |  |  | shiSchmidt               = 2432.0 _d 0 | 
| 139 |  |  | shiKinVisc               = 1.95 _d -6 | 
| 140 |  |  | #ifdef ALLOW_COST | 
| 141 |  |  | mult_shelfice            = 0. _d 0 | 
| 142 |  |  | mult_shifwflx            = 0. _d 0 | 
| 143 |  |  | wshifwflx0               = 0. _d 0 | 
| 144 |  |  | shifwflx_errfile         = ' ' | 
| 145 |  |  | #endif | 
| 146 |  |  | #ifdef ALLOW_MNC | 
| 147 |  |  | SHELFICE_tave_mnc = timeave_mnc | 
| 148 |  |  | SHELFICE_dump_mnc = snapshot_mnc | 
| 149 |  |  | #else | 
| 150 |  |  | SHELFICE_tave_mnc = .FALSE. | 
| 151 |  |  | SHELFICE_dump_mnc = .FALSE. | 
| 152 |  |  | #endif | 
| 153 |  |  |  | 
| 154 |  |  | C Open and read the data.shelfice file | 
| 155 |  |  | WRITE(msgBuf,'(A)') ' SHELFICE_READPARMS: opening data.shelfice' | 
| 156 |  |  | CALL PRINT_MESSAGE(msgBuf, standardMessageUnit, | 
| 157 |  |  | &                   SQUEEZE_RIGHT, myThid ) | 
| 158 |  |  | CALL OPEN_COPY_DATA_FILE( | 
| 159 |  |  | I                   'data.shelfice', 'SHELFICE_READPARMS', | 
| 160 |  |  | O                   iUnit, | 
| 161 |  |  | I                   myThid ) | 
| 162 |  |  | READ(UNIT=iUnit,NML=SHELFICE_PARM01) | 
| 163 |  |  | WRITE(msgBuf,'(A)') | 
| 164 |  |  | &  ' SHELFICE_READPARMS: finished reading data.shelfice' | 
| 165 |  |  | CALL PRINT_MESSAGE(msgBuf, standardMessageUnit, | 
| 166 |  |  | &                   SQUEEZE_RIGHT, myThid ) | 
| 167 |  |  |  | 
| 168 |  |  | C Close the open data file | 
| 169 |  |  | CLOSE(iUnit) | 
| 170 |  |  |  | 
| 171 |  |  | C Now set-up any remaining parameters that result from the input parameters | 
| 172 |  |  | IF ( SHELFICEsaltTransCoeff .EQ. UNSET_RL ) | 
| 173 |  |  | &     SHELFICEsaltTransCoeff = | 
| 174 |  |  | &     5.05 _d -3 *SHELFICEheatTransCoeff | 
| 175 |  |  |  | 
| 176 |  |  | C Set quadratic bottom drag depending on choices: | 
| 177 |  |  | IF ( SHELFICEDragQuadratic .EQ. UNSET_RL) THEN | 
| 178 |  |  | IF ( SHELFICEuseGammaFrict ) THEN | 
| 179 |  |  | SHELFICEDragQuadratic = shiCdrag | 
| 180 |  |  | ELSE | 
| 181 |  |  | SHELFICEDragQuadratic = bottomDragQuadratic | 
| 182 |  |  | ENDIF | 
| 183 |  |  | ENDIF | 
| 184 |  |  | IF ( SHELFICEDragQuadratic.EQ.0. _d 0 ) THEN | 
| 185 |  |  | SHELFICEselectDragQuadr = -1 | 
| 186 |  |  | ELSEIF ( SHELFICEselectDragQuadr.EQ.-1 ) THEN | 
| 187 |  |  | SHELFICEselectDragQuadr = MAX( 0, selectBotDragQuadr ) | 
| 188 |  |  | ENDIF | 
| 189 |  |  |  | 
| 190 |  |  | C-    Set Output type flags : | 
| 191 |  |  | SHELFICE_tave_mdsio = .TRUE. | 
| 192 |  |  | SHELFICE_dump_mdsio = .TRUE. | 
| 193 |  |  | #ifdef ALLOW_MNC | 
| 194 |  |  | IF (useMNC) THEN | 
| 195 |  |  | IF ( .NOT.outputTypesInclusive | 
| 196 |  |  | &       .AND. SHELFICE_tave_mnc ) SHELFICE_tave_mdsio = .FALSE. | 
| 197 |  |  | IF ( .NOT.outputTypesInclusive | 
| 198 |  |  | &       .AND. SHELFICE_dump_mnc ) SHELFICE_dump_mdsio = .FALSE. | 
| 199 |  |  | ENDIF | 
| 200 |  |  | #endif | 
| 201 |  |  |  | 
| 202 |  |  | _END_MASTER(myThid) | 
| 203 |  |  | C Everyone else must wait for the parameters to be loaded | 
| 204 |  |  | _BARRIER | 
| 205 |  |  |  | 
| 206 |  |  | #endif /* ALLOW_SHELFICE */ | 
| 207 |  |  |  | 
| 208 |  |  | RETURN | 
| 209 |  |  | END |