pkg/mypackage/mypackage_check.F

0dc94a8572 Patr*0001 #include "MYPACKAGE_OPTIONS.h"
                0002
3d0c17158b Ed H*0003 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
64811cb024 Jean*0004 CBOP
3d0c17158b Ed H*0005 C !ROUTINE: MYPACKAGE_CHECK
                0006
                0007 C !INTERFACE:
0dc94a8572 Patr*0008       SUBROUTINE MYPACKAGE_CHECK( myThid )
                0009
3d0c17158b Ed H*0010 C     !DESCRIPTION:
                0011 C     Check dependances with other packages
                0012
                0013 C     !USES:
                0014       IMPLICIT NONE
64811cb024 Jean*0015 C     == Global variables ===
0dc94a8572 Patr*0016 #include "SIZE.h"
                0017 #include "EEPARAMS.h"
                0018 #include "PARAMS.h"
                0019 #include "MYPACKAGE.h"
                0020
3d0c17158b Ed H*0021 C     !INPUT PARAMETERS:
5b141690f8 Jean*0022 C     myThid   :: my Thread Id number
0dc94a8572 Patr*0023       INTEGER myThid
3d0c17158b Ed H*0024 CEOP
0dc94a8572 Patr*0025
3d0c17158b Ed H*0026 C     !LOCAL VARIABLES:
dbd9426b2e Jean*0027 C     msgBuf   :: Informational/error message buffer
0dc94a8572 Patr*0028       CHARACTER*(MAX_LEN_MBUF) msgBuf
                0029
5b141690f8 Jean*0030       _BEGIN_MASTER(myThid)
                0031
0dc94a8572 Patr*0032        WRITE(msgBuf,'(A)') 'MYPACKAGE_CHECK: #define MYPACKAGE'
                0033        CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
64811cb024 Jean*0034      &                     SQUEEZE_RIGHT, myThid )
5b141690f8 Jean*0035
                0036 C--  Print out some kee parameters :
                0037        CALL WRITE_0D_L( myPa_StaV_Cgrid, INDEX_NONE,
                0038      &  'myPa_StaV_Cgrid =', ' /* state vector on C-grid */')
                0039        CALL WRITE_0D_L( myPa_Tend_Cgrid, INDEX_NONE,
                0040      &  'myPa_Tend_Cgrid =', ' /* vector tendency on C-grid */')
                0041        CALL WRITE_0D_L( myPa_applyTendT, INDEX_NONE,
                0042      &  'myPa_applyTendT =',
                0043      &  ' /* apply MYPA tendency to Temperature Eq.*/')
                0044        CALL WRITE_0D_L( myPa_applyTendS, INDEX_NONE,
                0045      &  'myPa_applyTendS =',
                0046      &  ' /* apply MYPA tendency to Salinity Eq.*/')
                0047        CALL WRITE_0D_L( myPa_applyTendU, INDEX_NONE,
                0048      &  'myPa_applyTendU =',
                0049      &  ' /* apply MYPA tendency to U momentum Eq.*/')
                0050        CALL WRITE_0D_L( myPa_applyTendV, INDEX_NONE,
                0051      &  'myPa_applyTendV =',
                0052      &  ' /* apply MYPA tendency to V momentum Eq.*/')
                0053 C-   add some other as example:
                0054        CALL WRITE_0D_I( myPa_index1, INDEX_NONE, ' myPa_index1 =',
                0055      &  ' /* user defined parameter */')
4da4b49499 Jean*0056        CALL WRITE_0D_RL( myPa_param1, INDEX_NONE, ' myPa_param1 =',
5b141690f8 Jean*0057      &  ' /* user defined parameter */')
                0058        CALL WRITE_0D_C( myPa_string1,-1,INDEX_NONE,'myPa_string1 =',
                0059      &  ' /* user defined parameter */')
0dc94a8572 Patr*0060
                0061 C--  Check parameters:
                0062
                0063 C-     Put stops here if some flags are wrongly chosen.
                0064 C-     For example, require this package to use tempStepping
5b141690f8 Jean*0065        IF ( .NOT.tempStepping .AND. myPa_applyTendT ) THEN
0dc94a8572 Patr*0066         WRITE(msgBuf,'(A)') 'An example requirement is:'
64811cb024 Jean*0067         CALL PRINT_ERROR( msgBuf, myThid )
5b141690f8 Jean*0068         WRITE(msgBuf,'(A)') 'myPa_applyTendT needs tempStepping=.true.'
64811cb024 Jean*0069         CALL PRINT_ERROR( msgBuf, myThid )
7610a0b85a Jean*0070         CALL ALL_PROC_DIE( 0 )
0dc94a8572 Patr*0071         STOP 'ABNORMAL END: S/R MYPACKAGE_CHECK'
                0072        ENDIF
                0073
                0074       _END_MASTER(myThid)
                0075
                0076       RETURN
                0077       END