C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/pkg/mom_common/mom_diagnostics_init.F,v 1.9 2006/07/13 21:30:12 jmc Exp $ C $Name: $ #include "MOM_COMMON_OPTIONS.h" CBOP C !ROUTINE: MOM_DIAGNOSTICS_INIT C !INTERFACE: SUBROUTINE MOM_DIAGNOSTICS_INIT( myThid ) C !DESCRIPTION: C Routine to initialize Momentum diagnostics C (from mom_common, mom_fluxform & mom_vecinv packages) C !USES: IMPLICIT NONE C === Global variables === #include "SIZE.h" #include "EEPARAMS.h" #include "PARAMS.h" C !INPUT/OUTPUT PARAMETERS: C === Routine arguments === C myThid - Number of this instance of GAD_INIT INTEGER myThid CEOP #ifdef ALLOW_DIAGNOSTICS #ifdef ALLOW_MOM_COMMON C !LOCAL VARIABLES: C === Local variables === C msgBuf - Informational/error meesage buffer c CHARACTER*(MAX_LEN_MBUF) msgBuf INTEGER diagNum CHARACTER*8 diagName CHARACTER*16 diagCode CHARACTER*16 diagUnits CHARACTER*(80) diagTitle C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| C--- Add diagnostics to the (long) list of available diagnostics: C-- add diagnostics for viscosity coefficients: diagName = 'VISCAHZ ' diagTitle = 'Harmonic Visc Coefficient (m2/s) (Zeta Pt)' diagUnits = 'm^2/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCA4Z ' diagTitle = 'Biharmonic Visc Coefficient (m4/s) (Zeta Pt)' diagUnits = 'm^4/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCAHD ' diagTitle = 'Harmonic Viscosity Coefficient (m2/s) (Div Pt)' diagUnits = 'm^2/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCA4D ' diagTitle = 'Biharmonic Viscosity Coefficient (m4/s) (Div Pt)' diagUnits = 'm^4/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCAHW ' diagTitle = 'Harmonic Viscosity Coefficient (m2/s) (W Pt)' diagUnits = 'm^2/s ' diagCode = 'WM LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCA4W ' diagTitle = 'Biharmonic Viscosity Coefficient (m4/s) (W Pt)' diagUnits = 'm^4/s ' diagCode = 'WM LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHZMAX ' diagTitle = 'CFL-MAX Harm Visc Coefficient (m2/s) (Zeta Pt)' diagUnits = 'm^2/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4ZMAX ' diagTitle = 'CFL-MAX Biharm Visc Coefficient (m4/s) (Zeta Pt)' diagUnits = 'm^4/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHDMAX ' diagTitle = 'CFL-MAX Harm Visc Coefficient (m2/s) (Div Pt)' diagUnits = 'm^2/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4DMAX ' diagTitle = 'CFL-MAX Biharm Visc Coefficient (m4/s) (Div Pt)' diagUnits = 'm^4/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHZMIN ' diagTitle = 'RE-MIN Harm Visc Coefficient (m2/s) (Zeta Pt)' diagUnits = 'm^2/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4ZMIN ' diagTitle = 'RE-MIN Biharm Visc Coefficient (m4/s) (Zeta Pt)' diagUnits = 'm^4/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHDMIN ' diagTitle = 'RE-MIN Harm Visc Coefficient (m2/s) (Div Pt)' diagUnits = 'm^2/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4DMIN ' diagTitle = 'RE-MIN Biharm Visc Coefficient (m4/s) (Div Pt)' diagUnits = 'm^4/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHZLTH ' diagTitle = 'Leith Harm Visc Coefficient (m2/s) (Zeta Pt)' diagUnits = 'm^2/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4ZLTH ' diagTitle = 'Leith Biharm Visc Coefficient (m4/s) (Zeta Pt)' diagUnits = 'm^4/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHDLTH ' diagTitle = 'Leith Harm Visc Coefficient (m2/s) (Div Pt)' diagUnits = 'm^2/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4DLTH ' diagTitle = 'Leith Biharm Visc Coefficient (m4/s) (Div Pt)' diagUnits = 'm^4/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHZLTHD' diagTitle = 'LeithD Harm Visc Coefficient (m2/s) (Zeta Pt)' diagUnits = 'm^2/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4ZLTHD' diagTitle = 'LeithD Biharm Visc Coefficient (m4/s) (Zeta Pt)' diagUnits = 'm^4/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHDLTHD' diagTitle = 'LeithD Harm Visc Coefficient (m2/s) (Div Pt)' diagUnits = 'm^2/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4DLTHD' diagTitle = 'LeithD Biharm Visc Coefficient (m4/s) (Div Pt)' diagUnits = 'm^4/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHZSMAG' diagTitle = 'Smagorinsky Harm Visc Coefficient (m2/s) (Zeta Pt)' diagUnits = 'm^2/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4ZSMAG' diagTitle = 'Smagorinsky Biharm Visc Coeff. (m4/s) (Zeta Pt)' diagUnits = 'm^4/s ' diagCode = 'SZ MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VAHDSMAG' diagTitle = 'Smagorinsky Harm Visc Coefficient (m2/s) (Div Pt)' diagUnits = 'm^2/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VA4DSMAG' diagTitle = 'Smagorinsky Biharm Visc Coeff. (m4/s) (Div Pt)' diagUnits = 'm^4/s ' diagCode = 'SM MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) C-- add diagnostics of simple derivative quantities: diagName = 'momKE ' diagTitle = 'Kinetic Energy (in momentum Eq.)' diagCode = 'SM MR ' diagUnits = 'm^2/s^2 ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #ifdef ALLOW_MOM_VECINV diagName = 'momHDiv ' diagTitle = 'Horizontal Divergence (in momentum Eq.)' diagCode = 'SM MR ' diagUnits = 's^-1 ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'momVort3' diagTitle = '3rd component (vertical) of Vorticity' diagCode = 'SZ MR ' diagUnits = 's^-1 ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Strain ' diagTitle = 'Horizontal Strain of Horizontal Velocities' diagCode = 'SZ MR ' diagUnits = 's^-1 ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Tension ' diagTitle = 'Horizontal Tension of Horizontal Velocities' diagCode = 'SM MR ' diagUnits = 's^-1 ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_MOM_VECINV */ C-- add diagnostics of tendencies from each terms diagUnits = 'm/s^2 ' diagName = 'UBotDrag' diagTitle = 'U momentum tendency from Bottom Drag' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VBotDrag' diagTitle = 'V momentum tendency from Bottom Drag' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'USidDrag' diagTitle = 'U momentum tendency from Side Drag' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VSidDrag' diagTitle = 'V momentum tendency from Side Drag' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Um_Diss ' diagTitle = 'U momentum tendency from Dissipation' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Vm_Diss ' diagTitle = 'V momentum tendency from Dissipation' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Um_Advec' diagTitle = 'U momentum tendency from Advection terms' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Vm_Advec' diagTitle = 'V momentum tendency from Advection terms' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Um_Cori ' diagTitle = 'U momentum tendency from Coriolis term' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Vm_Cori ' diagTitle = 'V momentum tendency from Coriolis term' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Um_Ext ' diagTitle = 'U momentum tendency from external forcing' WRITE(diagCode,'(A,I3.3,A)') 'UU ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Vm_Ext ' diagTitle = 'V momentum tendency from external forcing' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #ifdef ALLOW_MOM_VECINV diagName = 'Um_AdvZ3' diagTitle = 'U momentum tendency from Vorticity Advection' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Vm_AdvZ3' diagTitle = 'V momentum tendency from Vorticity Advection' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Um_AdvRe' diagTitle = 'U momentum tendency from vertical Advection' & //' (Explicit part)' WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'Vm_AdvRe' diagTitle = 'V momentum tendency from vertical Advection' & //' (Explicit part)' WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_MOM_VECINV */ #ifdef ALLOW_NONHYDROSTATIC C- vertical momentum tendencies IF ( usingPCoords ) THEN diagUnits = 'Pa/s^2 ' ELSE diagUnits = 'm/s^2 ' ENDIF diagName = 'WSidDrag' diagTitle = 'Vertical momentum tendency from Side Drag' diagCode = 'WM LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_NONHYDROSTATIC */ C-- add diagnostics of advective & viscous flux : IF ( usingPCoords ) THEN diagUnits = 'Pa.m^3/s^2 ' ELSE diagUnits = 'm^4/s^2 ' ENDIF C- Advective flux of Zonal momentum: #ifdef ALLOW_MOM_FLUXFORM diagName = 'ADVx_Um ' diagTitle = 'Zonal Advective Flux of U momentum' WRITE(diagCode,'(A,I3.3,A)') 'UM ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'ADVy_Um ' diagTitle = 'Meridional Advective Flux of U momentum' WRITE(diagCode,'(A,I3.3,A)') 'VZ ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'ADVrE_Um' diagTitle = 'Vertical Advective Flux of U momentum' & //' (Explicit part)' diagCode = 'WU LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_MOM_FLUXFORM */ c diagName = 'ADVrI_Um' c diagTitle = 'Vertical Advective Flux of U momentum' c & //' (Implicit part)' c diagCode = 'WU LR ' c CALL DIAGNOSTICS_ADD2LIST( diagNum, c I diagName, diagCode, diagUnits, diagTitle, myThid ) C- Advective flux of Meridional momentum: #ifdef ALLOW_MOM_FLUXFORM diagName = 'ADVx_Vm ' diagTitle = 'Zonal Advective Flux of V momentum' WRITE(diagCode,'(A,I3.3,A)') 'UZ ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'ADVy_Vm ' diagTitle = 'Meridional Advective Flux of V momentum' WRITE(diagCode,'(A,I3.3,A)') 'VM ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'ADVrE_Vm' diagTitle = 'Vertical Advective Flux of V momentum' & //' (Explicit part)' diagCode = 'WV LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_MOM_FLUXFORM */ c diagName = 'ADVrI_Vm' c diagTitle = 'Vertical Advective Flux of V momentum' c & //' (Implicit part)' c diagCode = 'WV LR ' c CALL DIAGNOSTICS_ADD2LIST( diagNum, c I diagName, diagCode, diagUnits, diagTitle, myThid ) c- Viscous flux of Zonal momentum : #ifdef ALLOW_MOM_FLUXFORM diagName = 'VISCx_Um' diagTitle = 'Zonal Viscous Flux of U momentum' WRITE(diagCode,'(A,I3.3,A)') 'UM ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCy_Um' diagTitle = 'Meridional Viscous Flux of U momentum' WRITE(diagCode,'(A,I3.3,A)') 'VZ ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISrE_Um' diagTitle = 'Vertical Viscous Flux of U momentum' & //' (Explicit part)' diagCode = 'WU LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_MOM_FLUXFORM */ diagName = 'VISrI_Um' diagTitle = 'Vertical Viscous Flux of U momentum' & //' (Implicit part)' diagCode = 'WU LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) c- Viscous flux of Meridional momentum : #ifdef ALLOW_MOM_FLUXFORM diagName = 'VISCx_Vm' diagTitle = 'Zonal Viscous Flux of V momentum' WRITE(diagCode,'(A,I3.3,A)') 'UZ ',diagNum+2,'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISCy_Vm' diagTitle = 'Meridional Viscous Flux of V momentum' WRITE(diagCode,'(A,I3.3,A)') 'VM ', diagNum, 'MR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) diagName = 'VISrE_Vm' diagTitle = 'Vertical Viscous Flux of V momentum' & //' (Explicit part)' diagCode = 'WV LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) #endif /* ALLOW_MOM_FLUXFORM */ diagName = 'VISrI_Vm' diagTitle = 'Vertical Viscous Flux of V momentum' & //' (Implicit part)' diagCode = 'WV LR ' CALL DIAGNOSTICS_ADD2LIST( diagNum, I diagName, diagCode, diagUnits, diagTitle, myThid ) C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| #endif /* ALLOW_MOM_COMMON */ #endif /* ALLOW_DIAGNOSTICS */ RETURN END