C $Header: /home/ubuntu/mnt/e9_copy/MITgcm_contrib/submesoscale/code/gmredi_check.F,v 1.4 2010/03/12 18:31:00 zhc Exp $ C $Name: $ #include "GMREDI_OPTIONS.h" #ifdef ALLOW_PTRACERS # include "PTRACERS_OPTIONS.h" #endif CBOP C !ROUTINE: GMREDI_CHECK C !INTERFACE: SUBROUTINE GMREDI_CHECK( myThid ) C !DESCRIPTION: \bv C *==========================================================* C | SUBROUTINE GMREDI_CHECK C | o Check consistency with model configuration C *==========================================================* C *==========================================================* C \ev C !USES: IMPLICIT NONE C === Global variables === #include "SIZE.h" #include "EEPARAMS.h" #include "PARAMS.h" #include "GMREDI.h" #ifdef ALLOW_GENERIC_ADVDIFF # include "GAD.h" #endif #ifdef ALLOW_PTRACERS # include "PTRACERS_SIZE.h" # include "PTRACERS_PARAMS.h" #endif C !INPUT/OUTPUT PARAMETERS: C === Routine arguments === C myThid :: my Thread Id number INTEGER myThid #ifdef ALLOW_GMREDI C !LOCAL VARIABLES: C === Local variables === C msgBuf :: Informational/error meesage buffer CHARACTER*(MAX_LEN_MBUF) msgBuf CEOP #ifdef ALLOW_PTRACERS INTEGER iTr LOGICAL redFlag #endif _BEGIN_MASTER(myThid) WRITE(msgBuf,'(A)') 'GMREDI_CHECK: #define GMREDI' CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, & SQUEEZE_RIGHT , myThid ) C- print out some kee parameters : CALL WRITE_0D_L( GM_AdvForm, INDEX_NONE, & 'GM_AdvForm =', ' /* if FALSE => use SkewFlux Form */') CALL WRITE_0D_L( GM_InMomAsStress, INDEX_NONE, & 'GM_InMomAsStress =', ' /* if TRUE => apply as Eddy Stress */') CALL WRITE_0D_L( GM_AdvSeparate, INDEX_NONE, & 'GM_AdvSeparate =',' /* Calc Bolus & Euler Adv. separately */') CALL WRITE_0D_L( GM_ExtraDiag, INDEX_NONE, & 'GM_ExtraDiag =',' /* Tensor Extra Diag (line 1&2) non 0 */') CALL WRITE_0D_RL( GM_isopycK, INDEX_NONE, 'GM_isopycK =', & ' /* Background Isopyc. Diffusivity [m^2/s] */') CALL WRITE_0D_RL( GM_background_K*GM_skewflx, INDEX_NONE, & 'GM_skewflx*K =', & ' /* Background GM_SkewFlx Diffusivity [m^2/s] */') CALL WRITE_0D_RL( GM_background_K*GM_advect, INDEX_NONE, & 'GM_advec*K =', & ' /* Backg. GM-Advec(=Bolus) Diffusivity [m^2/s]*/') CALL WRITE_0D_RL( GM_background_K*GM_advect, INDEX_NONE, & 'GM_Kmin_horiz =', & ' /* Minimum Horizontal Diffusivity [m^2/s] */') CALL WRITE_0D_RL( GM_Visbeck_alpha, INDEX_NONE, & 'GM_Visbeck_alpha =', ' /* Visbeck alpha coeff. [-] */') CALL WRITE_0D_RL( GM_Small_Number, INDEX_NONE, & 'GM_Small_Number =', ' /* epsilon used in slope calc */') CALL WRITE_0D_RL( GM_slopeSqCutoff, INDEX_NONE, & 'GM_slopeSqCutoff =', ' /* Slope^2 cut-off value */') CALL WRITE_0D_C( GM_taper_scheme, 0, INDEX_NONE, & 'GM_taper_scheme =', & ' /* Type of Tapering/Clipping scheme */') CALL WRITE_0D_RL( GM_maxSlope, INDEX_NONE, & 'GM_maxSlope =', ' /* Maximum Slope (Tapering/Clipping) */') CALL WRITE_0D_RL( GM_facTrL2dz, INDEX_NONE, & 'GM_facTrL2dz =', & ' /* Minimum Trans.Layer Thick. (factor of dz) */') CALL WRITE_0D_RL( GM_facTrL2ML, INDEX_NONE, & 'GM_facTrL2ML =', & ' /* Max.Trans.Layer Thick. (factor of MxL Depth)*/') CALL WRITE_0D_RL( GM_maxTransLay, INDEX_NONE, & 'GM_maxTransLay =', & ' /* Maximum Transition Layer Thickness [m] */') C-- Check parameters: C- GM/Redi needs implicit diffusion (will be packaged later) IF ( .NOT.implicitDiffusion ) THEN WRITE(msgBuf,'(A)') 'GM/Redi needs implicitDiffusion=.true.' CALL PRINT_ERROR( msgBuf , myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' ENDIF #ifndef GM_VISBECK_VARIABLE_K C Make sure we are not trying to use something that is unavailable IF ( GM_Visbeck_alpha.NE.0. ) THEN WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: Visbeck variables used in data.gmredi' CALL PRINT_ERROR( msgBuf, myThid ) WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: without #define GM_VISBECK_VARIABLE_K' CALL PRINT_ERROR( msgBuf, myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' ENDIF #endif #ifndef GM_BOLUS_ADVEC C Make sure we are not trying to use some arrays that are unavailable IF ( GM_AdvForm ) THEN WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: GM Advection form used in data.gmredi' CALL PRINT_ERROR( msgBuf, myThid ) WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: without #define GM_BOLUS_ADVEC' CALL PRINT_ERROR( msgBuf, myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' ENDIF #endif #ifndef GM_EXTRA_DIAGONAL C Make sure we are not trying to use some arrays that are unavailable IF ( GM_ExtraDiag ) THEN WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: GM_skew_Flux_K & GM_isopycK not equal' CALL PRINT_ERROR( msgBuf, myThid ) WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: without #define GM_EXTRA_DIAGONAL' CALL PRINT_ERROR( msgBuf, myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' ENDIF #endif #ifdef GM_SUBMESO IF (GM_SM_Ce .gt. 0 _d 0) THEN C Make sure we are not trying to use some arrays that are unavailable IF ((.not.GM_ExtraDiag ).and.(.not.GM_AdvForm)) THEN WRITE(msgBuf,'(A)') & ' GMREDI: GM_SUBMESO needs GM_EXTRA_DIAGONAL or GM_BOLUS_ADVEC' CALL PRINT_ERROR( msgBuf, myThid ) WRITE(msgBuf,'(A)') & ' GMREDI_CHECK: add #define GM_EXTRA_DIAGONAL' CALL PRINT_ERROR( msgBuf, myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' ENDIF ENDIF #endif #ifdef ALLOW_PTRACERS IF ( GM_AdvForm .AND. .NOT.GM_AdvSeparate & .AND. usePTRACERS ) THEN redFlag = .FALSE. DO iTr=1,PTRACERS_numInUse IF ( .NOT.PTRACERS_useGMRedi(iTr) ) THEN redFlag = .TRUE. WRITE(msgBuf,'(2A,I3,A,L5)') ' GMREDI_CHECK:', & ' pTracers_useGMRedi(',iTr,' )=', PTRACERS_useGMRedi(iTr) CALL PRINT_ERROR( msgBuf, myThid ) ENDIF ENDDO IF ( redFlag ) THEN WRITE(msgBuf,'(2A)') ' GMREDI_CHECK:', & ' but GM Advective Form applies to all tracers !' CALL PRINT_ERROR( msgBuf, myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' ENDIF ENDIF #endif /* ALLOW_PTRACERS */ #ifdef ALLOW_GENERIC_ADVDIFF C Check size of overlap region IF ( GM_AdvForm .AND. .NOT.GM_AdvSeparate & .AND. GM_Visbeck_alpha.NE.0. & .AND. useMultiDimAdvec & .AND. (Olx.LT.3 .OR. Oly.LT.3) ) THEN C Visbeck variable K requires 1 more row/column in the overlap: C might need to increase Olx,Oly from 2 to 3 if GM advective C form & multi-dim advection are used. This happens when: C a) using a 5 points stencil advection scheme ; or C b) using a 3 points stencil advection scheme on CS-grid C note: not clear how to check (b) since none of the advection scheme C currently implemented falls in this category, except if C GAD_FLUX_LIMITER.h is changed to use a "constant" flux-limiter C (from Lax-Wendroff to 1rst Order upwind). C------- c IF ( (useCubedSphereExchange c & .AND.( tempAdvScheme.EQ.ENUM_LAXWENDROFF c & .OR. saltAdvScheme.EQ.ENUM_LAXWENDROFF ) c & ).OR.( tempAdvScheme.EQ.ENUM_FLUX_LIMIT c & .OR. saltAdvScheme.EQ.ENUM_FLUX_LIMIT c & .OR. tempAdvScheme.EQ.ENUM_DST3_FLUX_LIMIT c & .OR. saltAdvScheme.EQ.ENUM_DST3_FLUX_LIMIT c & .OR. tempAdvScheme.EQ.ENUM_DST3 c & .OR. saltAdvScheme.EQ.ENUM_DST3 ) c & ) THEN WRITE(msgBuf,'(A,A)') & 'GMREDI_CHECK: Visbeck + GM_AdvForm in MultiDimAdvec' CALL PRINT_ERROR( msgBuf , myThid ) WRITE(msgBuf,'(A)') 'GMREDI_CHECK: need at least Olx,Oly = 3' CALL PRINT_ERROR( msgBuf , myThid ) STOP 'ABNORMAL END: S/R GMREDI_CHECK' c ENDIF ENDIF #endif /* ALLOW_GENERIC_ADVDIFF */ _END_MASTER(myThid) #endif /* ALLOW_GMREDI */ RETURN END