1 |
jmc |
1.6 |
C $Header: /u/gcmpack/MITgcm/pkg/mypackage/mypackage_check.F,v 1.5 2009/12/27 23:40:03 jmc Exp $ |
2 |
heimbach |
1.1 |
C $Name: $ |
3 |
|
|
|
4 |
|
|
#include "MYPACKAGE_OPTIONS.h" |
5 |
|
|
|
6 |
edhill |
1.2 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
7 |
|
|
CBOP 0 |
8 |
|
|
C !ROUTINE: MYPACKAGE_CHECK |
9 |
|
|
|
10 |
|
|
C !INTERFACE: |
11 |
heimbach |
1.1 |
SUBROUTINE MYPACKAGE_CHECK( myThid ) |
12 |
edhill |
1.2 |
|
13 |
|
|
C !DESCRIPTION: |
14 |
|
|
C Check dependances with other packages |
15 |
|
|
|
16 |
|
|
C !USES: |
17 |
heimbach |
1.1 |
IMPLICIT NONE |
18 |
|
|
#include "SIZE.h" |
19 |
|
|
#include "EEPARAMS.h" |
20 |
|
|
#include "PARAMS.h" |
21 |
|
|
#include "MYPACKAGE.h" |
22 |
|
|
|
23 |
edhill |
1.2 |
C !INPUT PARAMETERS: |
24 |
jmc |
1.3 |
C myThid :: my Thread Id number |
25 |
heimbach |
1.1 |
INTEGER myThid |
26 |
edhill |
1.2 |
CEOP |
27 |
heimbach |
1.1 |
|
28 |
jmc |
1.5 |
#ifdef ALLOW_MYPACKAGE |
29 |
edhill |
1.2 |
C !LOCAL VARIABLES: |
30 |
jmc |
1.5 |
C msgBuf :: Informational/error message buffer |
31 |
heimbach |
1.1 |
CHARACTER*(MAX_LEN_MBUF) msgBuf |
32 |
|
|
|
33 |
jmc |
1.3 |
_BEGIN_MASTER(myThid) |
34 |
heimbach |
1.1 |
|
35 |
|
|
WRITE(msgBuf,'(A)') 'MYPACKAGE_CHECK: #define MYPACKAGE' |
36 |
|
|
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, |
37 |
jmc |
1.3 |
& SQUEEZE_RIGHT , 1) |
38 |
|
|
|
39 |
|
|
C-- Print out some kee parameters : |
40 |
|
|
CALL WRITE_0D_L( myPa_StaV_Cgrid, INDEX_NONE, |
41 |
|
|
& 'myPa_StaV_Cgrid =', ' /* state vector on C-grid */') |
42 |
|
|
CALL WRITE_0D_L( myPa_Tend_Cgrid, INDEX_NONE, |
43 |
|
|
& 'myPa_Tend_Cgrid =', ' /* vector tendency on C-grid */') |
44 |
|
|
CALL WRITE_0D_L( myPa_applyTendT, INDEX_NONE, |
45 |
|
|
& 'myPa_applyTendT =', |
46 |
|
|
& ' /* apply MYPA tendency to Temperature Eq.*/') |
47 |
|
|
CALL WRITE_0D_L( myPa_applyTendS, INDEX_NONE, |
48 |
|
|
& 'myPa_applyTendS =', |
49 |
|
|
& ' /* apply MYPA tendency to Salinity Eq.*/') |
50 |
|
|
CALL WRITE_0D_L( myPa_applyTendU, INDEX_NONE, |
51 |
|
|
& 'myPa_applyTendU =', |
52 |
|
|
& ' /* apply MYPA tendency to U momentum Eq.*/') |
53 |
|
|
CALL WRITE_0D_L( myPa_applyTendV, INDEX_NONE, |
54 |
|
|
& 'myPa_applyTendV =', |
55 |
|
|
& ' /* apply MYPA tendency to V momentum Eq.*/') |
56 |
|
|
C- add some other as example: |
57 |
|
|
CALL WRITE_0D_I( myPa_index1, INDEX_NONE, ' myPa_index1 =', |
58 |
|
|
& ' /* user defined parameter */') |
59 |
jmc |
1.4 |
CALL WRITE_0D_RL( myPa_param1, INDEX_NONE, ' myPa_param1 =', |
60 |
jmc |
1.3 |
& ' /* user defined parameter */') |
61 |
|
|
CALL WRITE_0D_C( myPa_string1,-1,INDEX_NONE,'myPa_string1 =', |
62 |
|
|
& ' /* user defined parameter */') |
63 |
heimbach |
1.1 |
|
64 |
|
|
C-- Check parameters: |
65 |
|
|
|
66 |
|
|
C- Put stops here if some flags are wrongly chosen. |
67 |
|
|
C- For example, require this package to use tempStepping |
68 |
jmc |
1.3 |
IF ( .NOT.tempStepping .AND. myPa_applyTendT ) THEN |
69 |
heimbach |
1.1 |
WRITE(msgBuf,'(A)') 'An example requirement is:' |
70 |
|
|
CALL PRINT_ERROR( msgBuf , 1) |
71 |
jmc |
1.3 |
WRITE(msgBuf,'(A)') 'myPa_applyTendT needs tempStepping=.true.' |
72 |
heimbach |
1.1 |
CALL PRINT_ERROR( msgBuf , 1) |
73 |
jmc |
1.6 |
CALL ALL_PROC_DIE( 0 ) |
74 |
heimbach |
1.1 |
STOP 'ABNORMAL END: S/R MYPACKAGE_CHECK' |
75 |
|
|
ENDIF |
76 |
|
|
|
77 |
|
|
_END_MASTER(myThid) |
78 |
|
|
|
79 |
|
|
#endif /* ALLOW_MYPACKAGE */ |
80 |
jmc |
1.3 |
|
81 |
heimbach |
1.1 |
RETURN |
82 |
|
|
END |