model/src/config_summary.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/config_summary.F,v 1.4 1998/04/24 02:08:39 cnh Exp $

#include "CPP_EEOPTIONS.h"

CStartOfInterface
      SUBROUTINE CONFIG_SUMMARY( myThid )
C     /==========================================================\
C     | SUBROUTINE CONFIG_SUMMARY                                |
C     | o Summarize model prognostic variables.                  |
C     |==========================================================|
C     | This routine writes a tabulated summary of the model     |
C     | configuration.                                           |
C     | Note                                                     |
C     |  1. Under multi-process parallelism the summary          |
C     |     is only given for the per-process data.              |
C     |  2. Under multi-threading the summary is produced by     |
C     |     the master thread. This threads reads data managed by|
C     |     other threads.                                       |
C     \==========================================================/

C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"

C     == Routine arguments ==
C     myThid -  Number of this instance of CONFIG_SUMMARY
      INTEGER myThid
CEndOfInterface

C     == Local variables ==
      CHARACTER*(MAX_LEN_MBUF) msgBuf
      INTEGER                  I,J,K
      INTEGER                  bi, bj
      REAL                     xcoord(Nx)
      REAL                     ycoord(Ny)
      REAL                     zcoord(Nz)


      _BARRIER
      _BEGIN_MASTER(myThid)

      WRITE(msgBuf,'(A)')
     &'// ======================================================='
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '// Model configuration'
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)')
     &'// ======================================================='
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &  SQUEEZE_RIGHT , 1)

      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '// "Physical" paramters ( PARM01 in namelist ) '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      CALL WRITE_1D_R8( tRef, Nz, INDEX_K,'tRef =',
     &'   /* Reference temperature profile ( oC or oK ) */')
      CALL WRITE_1D_R8( sRef, Nz, INDEX_K,'sRef =',
     &'   /* Reference salinity profile ( ppt ) */')
      CALL WRITE_1D_R8( viscAh, 1, INDEX_NONE,'viscAh =',
     &'   /* Lateral eddy viscosity ( m^2/s ) */')
      CALL WRITE_1D_R8( viscAz, 1, INDEX_NONE,'viscAz =',
     &'   /* Vertical eddy viscosity ( m^2/s ) */')
      CALL WRITE_1D_R8( diffKhT, 1, INDEX_NONE,'diffKhT =',
     &'   /* Laplacian diffusion of heat laterally ( m^2/s ) */')
      CALL WRITE_1D_R8( diffKzT, 1, INDEX_NONE,'diffKzT =',
     &'   /* Laplacian diffusion of heat vertically ( m^2/s ) */')
      CALL WRITE_1D_R8( diffK4T, 1, INDEX_NONE,'diffK4T =',
     &'   /* Bihaarmonic diffusion of heat laterally ( m^4/s ) */')
      CALL WRITE_1D_R8( diffKhS, 1, INDEX_NONE,'diffKhS =',
     &'   /* Laplacian diffusion of salt laterally ( m^2/s ) */')
      CALL WRITE_1D_R8( diffKzS, 1, INDEX_NONE,'diffKzS =',
     &'   /* Laplacian diffusion of salt vertically ( m^2/s ) */')
      CALL WRITE_1D_R8( diffK4S, 1, INDEX_NONE,'diffK4S =',
     &'   /* Bihaarmonic diffusion of salt laterally ( m^4/s ) */')
      CALL WRITE_1D_R8( tAlpha,1, INDEX_NONE,'tAlpha =',
     &'   /* Linear EOS thermal expansion coefficient ( 1/degree ) */')
      CALL WRITE_1D_R8( sBeta, 1, INDEX_NONE,'sBeta =',
     &'   /* Linear EOS haline contraction coefficient ( 1/ppt ) */')
      CALL WRITE_1D_R8( rhonil,1, INDEX_NONE,'rhonil =',
     &'   /* Reference density ( kg/m^3 ) */')
      CALL WRITE_1D_R8( gravity,1, INDEX_NONE,'gravity =',
     &'   /* Gravitational acceleration ( m/s^2 ) */')
      CALL WRITE_1D_R8( f0,1, INDEX_NONE,'f0 =',
     &'   /* Reference coriolis parameter ( 1/s ) */')
      CALL WRITE_1D_R8( beta,1, INDEX_NONE,'beta =',
     &'   /* Beta ( 1/(m.s) ) */')
      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '// Elliptic solver(s) paramters ( PARM02 in namelist ) '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      CALL WRITE_1D_I( cg2dMaxIters,1, INDEX_NONE,'cg2dMaxIters =',
     &'   /* Upper limit on 2d con. grad iterations  */')
      CALL WRITE_1D_I( cg2dChkResFreq,1, INDEX_NONE,'cg2dChkResFreq =',
     &'   /* 2d con. grad convergence test frequency */')
      CALL WRITE_1D_R8( cg2dTargetResidual,1, INDEX_NONE,'cg2dTargetResidual =',
     &'   /* 2d con. grad target residual  */')

      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '// Time stepping paramters ( PARM03 in namelist ) '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      CALL WRITE_1D_I( nIter0,1, INDEX_NONE,'nIter0 =',
     &'   /* Base timestep number  */')
      CALL WRITE_1D_I( nTimeSteps,1, INDEX_NONE,'nTimeSteps =',
     &'   /* Number of timesteps */')
      CALL WRITE_1D_R8( deltaTmom,1, INDEX_NONE,'deltatTmom =',
     &'   /* Momentum equation timestep ( s ) */')
      CALL WRITE_1D_R8( deltaTtracer,1, INDEX_NONE,'deltatTtracer =',
     &'   /* Tracer equation timestep ( s ) */')
      CALL WRITE_1D_R8( abEps,1, INDEX_NONE,'abEps =',
     &'   /* Adams-Bashforth stabilizing weight */')
      CALL WRITE_1D_R8( tauCD,1, INDEX_NONE,'tauCD =',
     &'   /* CD coupling time-scale ( s ) */')
      CALL WRITE_1D_R8( rCD,1, INDEX_NONE,'rCD =',
     &'   /* Normalised CD coupling parameter */')
      CALL WRITE_1D_R8( startTime,1, INDEX_NONE,'startTime =',
     &'   /* Run start time ( s ). */')
      CALL WRITE_1D_R8( endTime,1, INDEX_NONE,'endTime =',
     &'   /* Integration ending time ( s ). */')
      CALL WRITE_1D_R8( chkPtFreq,1, INDEX_NONE,'chkPtFreq =',
     &'   /* Restart/checkpoint file interval ( s ). */')
      CALL WRITE_1D_R8( dumpFreq,1, INDEX_NONE,'dumpFreq =',
     &'   /* Model state write out interval ( s ). */')

      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '// Gridding paramters ( PARM04 in namelist ) '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      WRITE(msgBuf,'(A)') '//  '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
      CALL WRITE_1D_L( usingCartesianGrid,1, INDEX_NONE,'usingCartesianGrid =',
     &'   /* Cartesian coordinates flag ( True / False ) */')
      CALL WRITE_1D_L( usingSphericalPolarGrid,1, INDEX_NONE,'usingSphericalPolarGrid =',
     &'   /* Spherical coordinates flag ( True / False ) */')
      CALL WRITE_1D_R8( delZ,Nz, INDEX_K,'delZ = ',
     &'   /* W spacing ( m ) */')
      CALL WRITE_1D_R8( delX, Nx, INDEX_I,'delX = ',
     &'   /* U spacing ( m - cartesian, degrees - spherical ) */')
      CALL WRITE_1D_R8( delY, Ny, INDEX_J,'delY = ',
     &'   /* V spacing ( m - cartesian, degrees - spherical ) */')
      CALL WRITE_1D_R8( phiMin, 1, INDEX_NONE,'phiMin = ',
     &'   /* Southern boundary ( ignored - cartesian, degrees - spherical ) */')
      CALL WRITE_1D_R8( thetaMin, 1, INDEX_NONE,'thetaMin = ',
     &'   /* Western boundary ( ignored - cartesian, degrees - spherical ) */')
      CALL WRITE_1D_R8( rSphere, 1, INDEX_NONE,'rSphere = ',
     &'   /* Radius ( ignored - cartesian, m - spherical ) */')
      DO bi=1,nSx
       DO I=1,sNx
        xcoord((bi-1)*sNx+I) = xc(I,1,bi,1)
       ENDDO
      ENDDO
      CALL WRITE_1D_R8( xcoord, Nx, INDEX_I,'xcoord = ',
     &'   /* P-point X coordinate (  m - cartesian, degrees - spherical ) */')
      DO bj=1,nSy
       DO J=1,sNy
        ycoord((bj-1)*sNy+J) = yc(1,J,1,bj)
       ENDDO
      ENDDO
      CALL WRITE_1D_R8( ycoord, Ny, INDEX_J,'ycoord = ',
     &'   /* P-point Y coordinate (  m - cartesian, degrees - spherical ) */')
      DO K=1,Nz
       zcoord(K) = zc(K)
      ENDDO
      CALL WRITE_1D_R8( zcoord, Nz, INDEX_K,'zcoord = ',
     &'   /* P-point Z coordinate (  m ) */')


      WRITE(msgBuf,'(A)') ' '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &  SQUEEZE_RIGHT , 1)

      _END_MASTER(myThid)
      _BARRIER


      RETURN
  100 FORMAT(A,
     &' '
     &)
      END

1	C $Header: /u/gcmpack/models/MITgcmUV/model/src/config_summary.F,v 1.4 1998/04/24 02:08:39 cnh Exp $
2
3	#include "CPP_EEOPTIONS.h"
4
5	CStartOfInterface
6	SUBROUTINE CONFIG_SUMMARY( myThid )
7	C /==========================================================\
8	C \| SUBROUTINE CONFIG_SUMMARY \|
9	C \| o Summarize model prognostic variables. \|
10	C \|==========================================================\|
11	C \| This routine writes a tabulated summary of the model \|
12	C \| configuration. \|
13	C \| Note \|
14	C \| 1. Under multi-process parallelism the summary \|
15	C \| is only given for the per-process data. \|
16	C \| 2. Under multi-threading the summary is produced by \|
17	C \| the master thread. This threads reads data managed by\|
18	C \| other threads. \|
19	C \==========================================================/
20
21	C === Global variables ===
22	#include "SIZE.h"
23	#include "EEPARAMS.h"
24	#include "PARAMS.h"
25	#include "GRID.h"
26	#include "DYNVARS.h"
27
28	C == Routine arguments ==
29	C myThid - Number of this instance of CONFIG_SUMMARY
30	INTEGER myThid
31	CEndOfInterface
32
33	C == Local variables ==
34	CHARACTER*(MAX_LEN_MBUF) msgBuf
35	INTEGER I,J,K
36	INTEGER bi, bj
37	REAL xcoord(Nx)
38	REAL ycoord(Ny)
39	REAL zcoord(Nz)
40
41
42	_BARRIER
43	_BEGIN_MASTER(myThid)
44
45	WRITE(msgBuf,'(A)')
46	&'// ======================================================='
47	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
48	WRITE(msgBuf,'(A)') '// Model configuration'
49	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
50	WRITE(msgBuf,'(A)')
51	&'// ======================================================='
52	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
53	& SQUEEZE_RIGHT , 1)
54
55	WRITE(msgBuf,'(A)') '// '
56	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
57	WRITE(msgBuf,'(A)') '// "Physical" paramters ( PARM01 in namelist ) '
58	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
59	WRITE(msgBuf,'(A)') '// '
60	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
61	CALL WRITE_1D_R8( tRef, Nz, INDEX_K,'tRef =',
62	&' /* Reference temperature profile ( oC or oK ) */')
63	CALL WRITE_1D_R8( sRef, Nz, INDEX_K,'sRef =',
64	&' /* Reference salinity profile ( ppt ) */')
65	CALL WRITE_1D_R8( viscAh, 1, INDEX_NONE,'viscAh =',
66	&' /* Lateral eddy viscosity ( m^2/s ) */')
67	CALL WRITE_1D_R8( viscAz, 1, INDEX_NONE,'viscAz =',
68	&' /* Vertical eddy viscosity ( m^2/s ) */')
69	CALL WRITE_1D_R8( diffKhT, 1, INDEX_NONE,'diffKhT =',
70	&' /* Laplacian diffusion of heat laterally ( m^2/s ) */')
71	CALL WRITE_1D_R8( diffKzT, 1, INDEX_NONE,'diffKzT =',
72	&' /* Laplacian diffusion of heat vertically ( m^2/s ) */')
73	CALL WRITE_1D_R8( diffK4T, 1, INDEX_NONE,'diffK4T =',
74	&' /* Bihaarmonic diffusion of heat laterally ( m^4/s ) */')
75	CALL WRITE_1D_R8( diffKhS, 1, INDEX_NONE,'diffKhS =',
76	&' /* Laplacian diffusion of salt laterally ( m^2/s ) */')
77	CALL WRITE_1D_R8( diffKzS, 1, INDEX_NONE,'diffKzS =',
78	&' /* Laplacian diffusion of salt vertically ( m^2/s ) */')
79	CALL WRITE_1D_R8( diffK4S, 1, INDEX_NONE,'diffK4S =',
80	&' /* Bihaarmonic diffusion of salt laterally ( m^4/s ) */')
81	CALL WRITE_1D_R8( tAlpha,1, INDEX_NONE,'tAlpha =',
82	&' /* Linear EOS thermal expansion coefficient ( 1/degree ) */')
83	CALL WRITE_1D_R8( sBeta, 1, INDEX_NONE,'sBeta =',
84	&' /* Linear EOS haline contraction coefficient ( 1/ppt ) */')
85	CALL WRITE_1D_R8( rhonil,1, INDEX_NONE,'rhonil =',
86	&' /* Reference density ( kg/m^3 ) */')
87	CALL WRITE_1D_R8( gravity,1, INDEX_NONE,'gravity =',
88	&' /* Gravitational acceleration ( m/s^2 ) */')
89	CALL WRITE_1D_R8( f0,1, INDEX_NONE,'f0 =',
90	&' /* Reference coriolis parameter ( 1/s ) */')
91	CALL WRITE_1D_R8( beta,1, INDEX_NONE,'beta =',
92	&' /* Beta ( 1/(m.s) ) */')
93	WRITE(msgBuf,'(A)') '// '
94	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
95	WRITE(msgBuf,'(A)') '// Elliptic solver(s) paramters ( PARM02 in namelist ) '
96	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
97	WRITE(msgBuf,'(A)') '// '
98	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
99	CALL WRITE_1D_I( cg2dMaxIters,1, INDEX_NONE,'cg2dMaxIters =',
100	&' /* Upper limit on 2d con. grad iterations */')
101	CALL WRITE_1D_I( cg2dChkResFreq,1, INDEX_NONE,'cg2dChkResFreq =',
102	&' /* 2d con. grad convergence test frequency */')
103	CALL WRITE_1D_R8( cg2dTargetResidual,1, INDEX_NONE,'cg2dTargetResidual =',
104	&' /* 2d con. grad target residual */')
105
106	WRITE(msgBuf,'(A)') '// '
107	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
108	WRITE(msgBuf,'(A)') '// Time stepping paramters ( PARM03 in namelist ) '
109	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
110	WRITE(msgBuf,'(A)') '// '
111	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
112	CALL WRITE_1D_I( nIter0,1, INDEX_NONE,'nIter0 =',
113	&' /* Base timestep number */')
114	CALL WRITE_1D_I( nTimeSteps,1, INDEX_NONE,'nTimeSteps =',
115	&' /* Number of timesteps */')
116	CALL WRITE_1D_R8( deltaTmom,1, INDEX_NONE,'deltatTmom =',
117	&' /* Momentum equation timestep ( s ) */')
118	CALL WRITE_1D_R8( deltaTtracer,1, INDEX_NONE,'deltatTtracer =',
119	&' /* Tracer equation timestep ( s ) */')
120	CALL WRITE_1D_R8( abEps,1, INDEX_NONE,'abEps =',
121	&' /* Adams-Bashforth stabilizing weight */')
122	CALL WRITE_1D_R8( tauCD,1, INDEX_NONE,'tauCD =',
123	&' /* CD coupling time-scale ( s ) */')
124	CALL WRITE_1D_R8( rCD,1, INDEX_NONE,'rCD =',
125	&' /* Normalised CD coupling parameter */')
126	CALL WRITE_1D_R8( startTime,1, INDEX_NONE,'startTime =',
127	&' /* Run start time ( s ). */')
128	CALL WRITE_1D_R8( endTime,1, INDEX_NONE,'endTime =',
129	&' /* Integration ending time ( s ). */')
130	CALL WRITE_1D_R8( chkPtFreq,1, INDEX_NONE,'chkPtFreq =',
131	&' /* Restart/checkpoint file interval ( s ). */')
132	CALL WRITE_1D_R8( dumpFreq,1, INDEX_NONE,'dumpFreq =',
133	&' /* Model state write out interval ( s ). */')
134
135	WRITE(msgBuf,'(A)') '// '
136	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
137	WRITE(msgBuf,'(A)') '// Gridding paramters ( PARM04 in namelist ) '
138	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
139	WRITE(msgBuf,'(A)') '// '
140	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1)
141	CALL WRITE_1D_L( usingCartesianGrid,1, INDEX_NONE,'usingCartesianGrid =',
142	&' /* Cartesian coordinates flag ( True / False ) */')
143	CALL WRITE_1D_L( usingSphericalPolarGrid,1, INDEX_NONE,'usingSphericalPolarGrid =',
144	&' /* Spherical coordinates flag ( True / False ) */')
145	CALL WRITE_1D_R8( delZ,Nz, INDEX_K,'delZ = ',
146	&' /* W spacing ( m ) */')
147	CALL WRITE_1D_R8( delX, Nx, INDEX_I,'delX = ',
148	&' /* U spacing ( m - cartesian, degrees - spherical ) */')
149	CALL WRITE_1D_R8( delY, Ny, INDEX_J,'delY = ',
150	&' /* V spacing ( m - cartesian, degrees - spherical ) */')
151	CALL WRITE_1D_R8( phiMin, 1, INDEX_NONE,'phiMin = ',
152	&' /* Southern boundary ( ignored - cartesian, degrees - spherical ) */')
153	CALL WRITE_1D_R8( thetaMin, 1, INDEX_NONE,'thetaMin = ',
154	&' /* Western boundary ( ignored - cartesian, degrees - spherical ) */')
155	CALL WRITE_1D_R8( rSphere, 1, INDEX_NONE,'rSphere = ',
156	&' /* Radius ( ignored - cartesian, m - spherical ) */')
157	DO bi=1,nSx
158	DO I=1,sNx
159	xcoord((bi-1)*sNx+I) = xc(I,1,bi,1)
160	ENDDO
161	ENDDO
162	CALL WRITE_1D_R8( xcoord, Nx, INDEX_I,'xcoord = ',
163	&' /* P-point X coordinate ( m - cartesian, degrees - spherical ) */')
164	DO bj=1,nSy
165	DO J=1,sNy
166	ycoord((bj-1)*sNy+J) = yc(1,J,1,bj)
167	ENDDO
168	ENDDO
169	CALL WRITE_1D_R8( ycoord, Ny, INDEX_J,'ycoord = ',
170	&' /* P-point Y coordinate ( m - cartesian, degrees - spherical ) */')
171	DO K=1,Nz
172	zcoord(K) = zc(K)
173	ENDDO
174	CALL WRITE_1D_R8( zcoord, Nz, INDEX_K,'zcoord = ',
175	&' /* P-point Z coordinate ( m ) */')
176
177
178
179	WRITE(msgBuf,'(A)') ' '
180	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
181	& SQUEEZE_RIGHT , 1)
182
183	_END_MASTER(myThid)
184	_BARRIER
185
186
187	RETURN
188	100 FORMAT(A,
189	&' '
190	&)
191	END
192