pkg/cost/cost_final.F

C $Header: /u/gcmpack/MITgcm/pkg/cost/cost_final.F,v 1.22 2010/05/09 16:23:01 jmc Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "COST_CPPOPTIONS.h"

      subroutine cost_final( mythid )

c     ==================================================================
c     SUBROUTINE cost_final
c     ==================================================================
c
c     o Sum of all cost function contributions.
c
c     ==================================================================
c     SUBROUTINE cost_final
c     ==================================================================

      implicit none

c     == global variables ==

#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"

#include "cost.h"
#ifdef ALLOW_CTRL
# include "ctrl.h"
#endif
#ifdef ALLOW_DIC
# include "DIC_COST.h"
#endif
#ifdef ALLOW_COST_SHELFICE
# include "SHELFICE_COST.h"
#endif


c     == routine arguments ==

      integer mythid

#ifdef ALLOW_COST
c     == local variables ==

      integer i,j,k
      integer bi,bj
      integer itlo,ithi
      integer jtlo,jthi

c     == end of interface ==

      jtlo = mybylo(mythid)
      jthi = mybyhi(mythid)
      itlo = mybxlo(mythid)
      ithi = mybxhi(mythid)

#ifdef ALLOW_SEAICE
      CALL SEAICE_COST_FINAL (myThid)
#endif

#if (defined (ALLOW_ECCO))
      CALL ECCO_COST_FINAL (myThid)

#elif (defined (ALLOW_COST_VECTOR))
      CALL COST_VECTOR (myThid)

#elif (defined (ALLOW_COST_STATE_FINAL))
      CALL COST_STATE_FINAL (myThid)

#endif /* above stuff undef */

#ifndef ALLOW_ECCO

# ifdef ALLOW_COST_TEST
      CALL COST_TEST (myThid)
# endif
# ifdef ALLOW_COST_ATLANTIC_HEAT
      CALL COST_ATLANTIC_HEAT (myThid)
# endif
#ifdef ALLOW_COST_HFLUXM
      CALL COST_HFLUX (myThid)
#endif
#ifdef ALLOW_COST_TEMP
      CALL COST_TEMP (myThid)
#endif
#ifdef ALLOW_SHELFICE
# ifdef ALLOW_COST_SHELFICE
      CALL SHELFICE_COST_FINAL (myThid)
# endif
#endif

c--   Sum up all contributions.
      do bj = jtlo,jthi
        do bi = itlo,ithi

          write(standardmessageunit,'(A,D22.15)')
     &          ' --> objf_test(bi,bj)   = ', objf_test(bi,bj)
          write(standardmessageunit,'(A,D22.15)')
     &         ' --> objf_tracer(bi,bj) = ', objf_tracer(bi,bj)
          write(standardmessageunit,'(A,D22.15)')
     &         ' --> objf_atl(bi,bj)    = ', objf_atl(bi,bj)
#ifdef ALLOW_COST_TEMP
          write(standardmessageunit,'(A,D22.15)')
     &          ' --> objf_temp_tut(bi,bj)   = ', objf_temp_tut(bi,bj)
#endif
#ifdef ALLOW_COST_HFLUXM
          write(standardmessageunit,'(A,D22.15)')
     &         ' --> objf_hflux_tut(bi,bj) = ', objf_hflux_tut(bi,bj)
#endif
#ifdef ALLOW_COST_TRANSPORT
          write(standardmessageunit,'(A,D22.15)')
     &         ' --> objf_transport(bi,bj) = ', objf_transport(bi,bj)
#endif
#ifdef ALLOW_COST_SHELFICE
          write(standardmessageunit,'(A,D22.15)')
     &         ' --> objf_shelfice(bi,bj) = ', objf_shelfice(bi,bj)
#endif

          fc = fc
     &            + mult_test   * objf_test(bi,bj)
     &            + mult_tracer * objf_tracer(bi,bj)
     &            + mult_atl    * objf_atl(bi,bj)
#ifdef ALLOW_COST_TRANSPORT
     &            + mult_transport * objf_transport(bi,bj)
#endif
#ifdef ALLOW_COST_TEMP
     &            + mult_temp_tut  * objf_temp_tut(bi,bj)
#endif
#ifdef ALLOW_COST_HFLUXM
     &            + mult_hflux_tut * objf_hflux_tut(bi,bj)
#endif
#ifdef ALLOW_COST_SHELFICE
     &            + mult_shelfice * objf_shelfice(bi,bj)
#endif
        enddo
      enddo

      write(standardmessageunit,'(A,D22.15)') '  local fc = ', fc

c--   Do global summation.
      _GLOBAL_SUM_RL( fc , myThid )

#ifdef ALLOW_DIC
cph-- quickly for testing
      fc = totcost
#endif

      write(standardmessageunit,'(A,D22.15)') ' global fc = ', fc

#endif /* ALLOW_ECCO */

c--   to avoid re-write of output in reverse checkpointing loops,
c--   switch off output flag :
      CALL TURNOFF_MODEL_IO( 0, myThid )

#endif /* ALLOW_COST */

      return
      end
1	heimbach	1.23	C $Header: /u/gcmpack/MITgcm/pkg/cost/cost_final.F,v 1.22 2010/05/09 16:23:01 jmc Exp $
2	jmc	1.16	C $Name: $
3	heimbach	1.1
4	heimbach	1.7	#include "PACKAGES_CONFIG.h"
5	heimbach	1.1	#include "COST_CPPOPTIONS.h"
6
7	heimbach	1.3	subroutine cost_final( mythid )
8	heimbach	1.1
9			c ==================================================================
10	heimbach	1.3	c SUBROUTINE cost_final
11	heimbach	1.1	c ==================================================================
12			c
13			c o Sum of all cost function contributions.
14			c
15			c ==================================================================
16	heimbach	1.3	c SUBROUTINE cost_final
17	heimbach	1.1	c ==================================================================
18
19			implicit none
20
21			c == global variables ==
22
23			#include "EEPARAMS.h"
24			#include "SIZE.h"
25	heimbach	1.5	#include "PARAMS.h"
26	heimbach	1.1
27			#include "cost.h"
28	heimbach	1.14	#ifdef ALLOW_CTRL
29			# include "ctrl.h"
30			#endif
31	heimbach	1.20	#ifdef ALLOW_DIC
32			# include "DIC_COST.h"
33			#endif
34	heimbach	1.23	#ifdef ALLOW_COST_SHELFICE
35			# include "SHELFICE_COST.h"
36			#endif
37
38	heimbach	1.1
39			c == routine arguments ==
40
41			integer mythid
42
43	heimbach	1.2	#ifdef ALLOW_COST
44	heimbach	1.1	c == local variables ==
45
46	heimbach	1.3	integer i,j,k
47	heimbach	1.1	integer bi,bj
48			integer itlo,ithi
49			integer jtlo,jthi
50
51			c == end of interface ==
52
53			jtlo = mybylo(mythid)
54			jthi = mybyhi(mythid)
55			itlo = mybxlo(mythid)
56			ithi = mybxhi(mythid)
57
58	heimbach	1.13	#ifdef ALLOW_SEAICE
59			CALL SEAICE_COST_FINAL (myThid)
60			#endif
61
62	heimbach	1.7	#if (defined (ALLOW_ECCO))
63			CALL ECCO_COST_FINAL (myThid)
64	heimbach	1.3
65	heimbach	1.7	#elif (defined (ALLOW_COST_VECTOR))
66	heimbach	1.3	CALL COST_VECTOR (myThid)
67
68	heimbach	1.6	#elif (defined (ALLOW_COST_STATE_FINAL))
69			CALL COST_STATE_FINAL (myThid)
70	heimbach	1.3
71	heimbach	1.8	#endif /* above stuff undef */
72
73			#ifndef ALLOW_ECCO
74	heimbach	1.3
75	heimbach	1.7	# ifdef ALLOW_COST_TEST
76	heimbach	1.2	CALL COST_TEST (myThid)
77	heimbach	1.7	# endif
78			# ifdef ALLOW_COST_ATLANTIC_HEAT
79	heimbach	1.3	CALL COST_ATLANTIC_HEAT (myThid)
80	heimbach	1.7	# endif
81	dfer	1.17	#ifdef ALLOW_COST_HFLUXM
82			CALL COST_HFLUX (myThid)
83			#endif
84			#ifdef ALLOW_COST_TEMP
85			CALL COST_TEMP (myThid)
86			#endif
87	heimbach	1.23	#ifdef ALLOW_SHELFICE
88			# ifdef ALLOW_COST_SHELFICE
89			CALL SHELFICE_COST_FINAL (myThid)
90			# endif
91			#endif
92	heimbach	1.3
93	heimbach	1.1	c-- Sum up all contributions.
94			do bj = jtlo,jthi
95			do bi = itlo,ithi
96
97	jmc	1.16	write(standardmessageunit,'(A,D22.15)')
98	heimbach	1.11	& ' --> objf_test(bi,bj) = ', objf_test(bi,bj)
99	jmc	1.16	write(standardmessageunit,'(A,D22.15)')
100	heimbach	1.11	& ' --> objf_tracer(bi,bj) = ', objf_tracer(bi,bj)
101	jmc	1.16	write(standardmessageunit,'(A,D22.15)')
102	heimbach	1.11	& ' --> objf_atl(bi,bj) = ', objf_atl(bi,bj)
103	dfer	1.17	#ifdef ALLOW_COST_TEMP
104			write(standardmessageunit,'(A,D22.15)')
105	dfer	1.18	& ' --> objf_temp_tut(bi,bj) = ', objf_temp_tut(bi,bj)
106	dfer	1.17	#endif
107			#ifdef ALLOW_COST_HFLUXM
108			write(standardmessageunit,'(A,D22.15)')
109	dfer	1.18	& ' --> objf_hflux_tut(bi,bj) = ', objf_hflux_tut(bi,bj)
110	dfer	1.17	#endif
111	heimbach	1.15	#ifdef ALLOW_COST_TRANSPORT
112	jmc	1.16	write(standardmessageunit,'(A,D22.15)')
113	heimbach	1.15	& ' --> objf_transport(bi,bj) = ', objf_transport(bi,bj)
114			#endif
115	heimbach	1.23	#ifdef ALLOW_COST_SHELFICE
116			write(standardmessageunit,'(A,D22.15)')
117			& ' --> objf_shelfice(bi,bj) = ', objf_shelfice(bi,bj)
118			#endif
119	heimbach	1.1
120			fc = fc
121	heimbach	1.2	& + mult_test * objf_test(bi,bj)
122			& + mult_tracer * objf_tracer(bi,bj)
123	heimbach	1.3	& + mult_atl * objf_atl(bi,bj)
124	heimbach	1.15	#ifdef ALLOW_COST_TRANSPORT
125			& + mult_transport * objf_transport(bi,bj)
126			#endif
127	dfer	1.17	#ifdef ALLOW_COST_TEMP
128	dfer	1.18	& + mult_temp_tut * objf_temp_tut(bi,bj)
129	dfer	1.17	#endif
130			#ifdef ALLOW_COST_HFLUXM
131	dfer	1.18	& + mult_hflux_tut * objf_hflux_tut(bi,bj)
132	dfer	1.17	#endif
133	heimbach	1.23	#ifdef ALLOW_COST_SHELFICE
134			& + mult_shelfice * objf_shelfice(bi,bj)
135			#endif
136	heimbach	1.1	enddo
137			enddo
138
139	heimbach	1.12	write(standardmessageunit,'(A,D22.15)') ' local fc = ', fc
140	heimbach	1.1
141			c-- Do global summation.
142	jmc	1.19	_GLOBAL_SUM_RL( fc , myThid )
143	heimbach	1.3
144	heimbach	1.20	#ifdef ALLOW_DIC
145			cph-- quickly for testing
146			fc = totcost
147			#endif
148
149	heimbach	1.12	write(standardmessageunit,'(A,D22.15)') ' global fc = ', fc
150	heimbach	1.6
151	heimbach	1.7	#endif /* ALLOW_ECCO */
152	heimbach	1.5
153	jmc	1.22	c-- to avoid re-write of output in reverse checkpointing loops,
154			c-- switch off output flag :
155			CALL TURNOFF_MODEL_IO( 0, myThid )
156	heimbach	1.1
157	heimbach	1.2	#endif /* ALLOW_COST */
158	heimbach	1.1
159			return
160			end