/[MITgcm]/manual/s_autodiff/doc_ad_examples.tex
ViewVC logotype

Diff of /manual/s_autodiff/doc_ad_examples.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.4 by adcroft, Wed Apr 24 19:23:58 2002 UTC revision 1.5 by adcroft, Thu May 16 15:54:37 2002 UTC
# Line 3  Line 3 
3    
4  %**********************************************************************  %**********************************************************************
5  \section{Sensitivity of Air-Sea Exchange to Tracer Injection Site }  \section{Sensitivity of Air-Sea Exchange to Tracer Injection Site }
6    \label{www:tutorials}
7  \label{sect:eg-simple-tracer-adjoint}  \label{sect:eg-simple-tracer-adjoint}
8  \label{sec_ad_setup_ex}  \label{sec_ad_setup_ex}
9  \label{sect:tutorialIII}  \label{sect:tutorialIII}
# Line 19  The AD-relevant hooks in the code are sk Line 20  The AD-relevant hooks in the code are sk
20  \ref{fig:adthemodel}, \ref{fig:adthemain}.  \ref{fig:adthemodel}, \ref{fig:adthemain}.
21    
22  \subsection{Overview of the experiment}  \subsection{Overview of the experiment}
23    \label{www:tutorials}
24    
25  We describe an adjoint sensitivity analysis of out-gassing from  We describe an adjoint sensitivity analysis of out-gassing from
26  the ocean into the atmosphere of a carbon-like tracer injected  the ocean into the atmosphere of a carbon-like tracer injected
27  into the ocean interior (see \cite{hil-eta:01}).  into the ocean interior (see \cite{hil-eta:01}).
28    
29  \subsubsection{Passive tracer equation}  \subsubsection{Passive tracer equation}
30    \label{www:tutorials}
31    
32  For this work the MITGCM was augmented with a thermodynamically  For this work the MITGCM was augmented with a thermodynamically
33  inactive tracer, $C$. Tracer residing in the ocean  inactive tracer, $C$. Tracer residing in the ocean
# Line 59  As source we choose a constant in time i Line 62  As source we choose a constant in time i
62  $ S = 1 \,\, {\rm mol / s}$.  $ S = 1 \,\, {\rm mol / s}$.
63    
64  \subsubsection{Model configuration}  \subsubsection{Model configuration}
65    \label{www:tutorials}
66    
67  The model configuration employed has a constant  The model configuration employed has a constant
68  $4^\circ \times 4^\circ$ resolution horizontal grid and realistic  $4^\circ \times 4^\circ$ resolution horizontal grid and realistic
# Line 70  fresh-water forcing the model reproduces Line 74  fresh-water forcing the model reproduces
74  features of the ocean general circulation.  features of the ocean general circulation.
75    
76  \subsubsection{Out-gassing cost function}  \subsubsection{Out-gassing cost function}
77    \label{www:tutorials}
78    
79  To quantify and understand out-gassing due to injections of $C$  To quantify and understand out-gassing due to injections of $C$
80  in eqn. (\ref{carbon_ddt}),  in eqn. (\ref{carbon_ddt}),
# Line 96  and regions in which $CO_2$ injections w Line 101  and regions in which $CO_2$ injections w
101  sequestered within the ocean.  sequestered within the ocean.
102    
103  \subsection{Code configuration}  \subsection{Code configuration}
104    \label{www:tutorials}
105    
106  The model configuration for this experiment resides under the  The model configuration for this experiment resides under the
107  directory {\it verification/carbon/}.  directory {\it verification/carbon/}.
# Line 171  Below we describe the customizations of Line 177  Below we describe the customizations of
177  specific to this experiment.  specific to this experiment.
178    
179  \subsubsection{File {\it .genmakerc}}  \subsubsection{File {\it .genmakerc}}
180    \label{www:tutorials}
181  This file overwrites default settings of {\it genmake}.  This file overwrites default settings of {\it genmake}.
182  In the present example it is used to switch on the following  In the present example it is used to switch on the following
183  packages which are related to automatic differentiation  packages which are related to automatic differentiation
# Line 180  Other packages which are not needed are Line 187  Other packages which are not needed are
187  \hspace*{4ex} {\tt set DISABLE=( aim obcs zonal\_filt shap\_filt cal exf )}  \hspace*{4ex} {\tt set DISABLE=( aim obcs zonal\_filt shap\_filt cal exf )}
188    
189  \subsubsection{File {\it COST\_CPPOPTIONS.h,  CTRL\_OPTIONS.h}}  \subsubsection{File {\it COST\_CPPOPTIONS.h,  CTRL\_OPTIONS.h}}
190    \label{www:tutorials}
191    
192  These files used to contain package-specific CPP-options  These files used to contain package-specific CPP-options
193  (see Section \ref{???}).  (see Section \ref{???}).
# Line 189  To retain the modularity, the files have Line 197  To retain the modularity, the files have
197  the standard include of the {\it CPP\_OPTIONS.h} file.  the standard include of the {\it CPP\_OPTIONS.h} file.
198    
199  \subsubsection{File {\it CPP\_EEOPTIONS.h}}  \subsubsection{File {\it CPP\_EEOPTIONS.h}}
200    \label{www:tutorials}
201    
202  This file contains 'wrapper'-specific CPP options.  This file contains 'wrapper'-specific CPP options.
203  It only needs to be changed if the code is to be run  It only needs to be changed if the code is to be run
204  in a parallel environment (see Section \ref{???}).  in a parallel environment (see Section \ref{???}).
205    
206  \subsubsection{File {\it CPP\_OPTIONS.h}}  \subsubsection{File {\it CPP\_OPTIONS.h}}
207    \label{www:tutorials}
208    
209  This file contains model-specific CPP options  This file contains model-specific CPP options
210  (see Section \ref{???}).  (see Section \ref{???}).
# Line 226  adjoint-generated gradient. Line 236  adjoint-generated gradient.
236  The gradient check package is further described in Section ???.  The gradient check package is further described in Section ???.
237    
238  \subsubsection{File {\it ECCO\_OPTIONS.h}}  \subsubsection{File {\it ECCO\_OPTIONS.h}}
239    \label{www:tutorials}
240    
241  The CPP options of several AD-related packages are grouped  The CPP options of several AD-related packages are grouped
242  in this file:  in this file:
# Line 308  isopycnal diffusivity \\ Line 319  isopycnal diffusivity \\
319  \end{itemize}  \end{itemize}
320    
321  \subsubsection{File {\it SIZE.h}}  \subsubsection{File {\it SIZE.h}}
322    \label{www:tutorials}
323    
324  The file contains the grid point dimensions of the forward  The file contains the grid point dimensions of the forward
325  model. It is identical to the {\it verification/exp2/}: \\  model. It is identical to the {\it verification/exp2/}: \\
# Line 320  with standard overlap dimensioning Line 332  with standard overlap dimensioning
332  {\tt OLx = OLy = 3}.  {\tt OLx = OLy = 3}.
333    
334  \subsubsection{File {\it adcommon.h}}  \subsubsection{File {\it adcommon.h}}
335    \label{www:tutorials}
336    
337  This file contains common blocks of some adjoint variables  This file contains common blocks of some adjoint variables
338  that are generated by TAMC.  that are generated by TAMC.
# Line 352  The header file is enabled via the CPP-o Line 365  The header file is enabled via the CPP-o
365  {\bf ALLOW\_AUTODIFF\_MONITOR}.  {\bf ALLOW\_AUTODIFF\_MONITOR}.
366    
367  \subsubsection{File {\it tamc.h}}  \subsubsection{File {\it tamc.h}}
368    \label{www:tutorials}
369    
370  This routine contains the dimensions for TAMC checkpointing  This routine contains the dimensions for TAMC checkpointing
371  and some indices relevant for storing ky computations.  and some indices relevant for storing ky computations.
# Line 395  The following parameters may be worth de Line 409  The following parameters may be worth de
409  ~  ~
410    
411  \subsubsection{File {\it makefile}}  \subsubsection{File {\it makefile}}
412    \label{www:tutorials}
413    
414  This file contains all relevant parameter flags and  This file contains all relevant parameter flags and
415  lists to run TAMC or TAF.  lists to run TAMC or TAF.
# Line 478  adjoint routines refer to the TAMC defau Line 493  adjoint routines refer to the TAMC defau
493    
494    
495  \subsubsection{The input parameter files}  \subsubsection{The input parameter files}
496    \label{www:tutorials}
497    
498  \paragraph{File {\it data}}  \paragraph{File {\it data}}
499    
# Line 513  surface boundary values (surface wind st Line 529  surface boundary values (surface wind st
529  Contains model state after model spinup.  Contains model state after model spinup.
530    
531  \subsection{Compiling the model and its adjoint}  \subsection{Compiling the model and its adjoint}
532    \label{www:tutorials}
533    
534  The built process of the adjoint model is slightly more  The built process of the adjoint model is slightly more
535  complex than that of compiling the forward code.  complex than that of compiling the forward code.

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

  ViewVC Help
Powered by ViewVC 1.1.22