pkg/mypackage/mypackage_check.F

C $Header: /u/gcmpack/MITgcm/pkg/mypackage/mypackage_check.F,v 1.1 2006/06/28 21:26:21 heimbach Exp $
C $Name:  $

#include "MYPACKAGE_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP 0
C !ROUTINE: MYPACKAGE_CHECK

C !INTERFACE:
      SUBROUTINE MYPACKAGE_CHECK( myThid )

C     !DESCRIPTION:
C     Check dependances with other packages

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "MYPACKAGE.h"

C     !INPUT PARAMETERS:
C     myThid -  Number of this instances
      INTEGER myThid
CEOP

C     !LOCAL VARIABLES:
C     msgBuf      - Informational/error meesage buffer
      CHARACTER*(MAX_LEN_MBUF) msgBuf


#ifdef ALLOW_MYPACKAGE

       WRITE(msgBuf,'(A)') 'MYPACKAGE_CHECK: #define MYPACKAGE'
       CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                    SQUEEZE_RIGHT , 1)

C--  Check parameters:

      _BEGIN_MASTER(myThid)

C-     Put stops here if some flags are wrongly chosen.
C-     For example, require this package to use tempStepping
       IF (.NOT.tempStepping) THEN
        WRITE(msgBuf,'(A)') 'An example requirement is:'
        CALL PRINT_ERROR( msgBuf , 1)
        WRITE(msgBuf,'(A)') 'mypackage needs tempStepping=.true.'
        CALL PRINT_ERROR( msgBuf , 1)
        STOP 'ABNORMAL END: S/R MYPACKAGE_CHECK'
       ENDIF

      _END_MASTER(myThid)

#endif /* ALLOW_MYPACKAGE */
      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/pkg/mypackage/mypackage_check.F,v 1.1 2006/06/28 21:26:21 heimbach Exp $
2	C $Name: $
3
4	#include "MYPACKAGE_OPTIONS.h"
5
6	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7	CBOP 0
8	C !ROUTINE: MYPACKAGE_CHECK
9
10	C !INTERFACE:
11	SUBROUTINE MYPACKAGE_CHECK( myThid )
12
13	C !DESCRIPTION:
14	C Check dependances with other packages
15
16	C !USES:
17	IMPLICIT NONE
18	#include "SIZE.h"
19	#include "EEPARAMS.h"
20	#include "PARAMS.h"
21	#include "MYPACKAGE.h"
22
23	C !INPUT PARAMETERS:
24	C myThid - Number of this instances
25	INTEGER myThid
26	CEOP
27
28	C !LOCAL VARIABLES:
29	C msgBuf - Informational/error meesage buffer
30	CHARACTER*(MAX_LEN_MBUF) msgBuf
31
32
33	#ifdef ALLOW_MYPACKAGE
34
35	WRITE(msgBuf,'(A)') 'MYPACKAGE_CHECK: #define MYPACKAGE'
36	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
37	& SQUEEZE_RIGHT , 1)
38
39	C-- Check parameters:
40
41	_BEGIN_MASTER(myThid)
42
43	C- Put stops here if some flags are wrongly chosen.
44	C- For example, require this package to use tempStepping
45	IF (.NOT.tempStepping) THEN
46	WRITE(msgBuf,'(A)') 'An example requirement is:'
47	CALL PRINT_ERROR( msgBuf , 1)
48	WRITE(msgBuf,'(A)') 'mypackage needs tempStepping=.true.'
49	CALL PRINT_ERROR( msgBuf , 1)
50	STOP 'ABNORMAL END: S/R MYPACKAGE_CHECK'
51	ENDIF
52
53	_END_MASTER(myThid)
54
55	#endif /* ALLOW_MYPACKAGE */
56	RETURN
57	END