/[MITgcm]/manual/s_phys_pkgs/text/obcs.tex

Diff of /manual/s_phys_pkgs/text/obcs.tex

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

-revision 1.1 by heimbach,
Thu Aug 11 23:58:07 2005 UTC
+revision 1.5 by jmc,
Mon Aug 30 23:09:21 2010 UTC
 Line 5
  <!-- CMIREDIR:package_obcs: -->
  \end{rawhtml}
- Authors: Martin Losch and Patrick Heimbach
+ Authors:
+ Alistair Adcroft, Patrick Heimbach, Samar Katiwala, Martin Losch
  \subsubsection{Introduction
  \label{sec:pkg:obcs:intro}}
-Line 15 
 Authors: Martin Losch and Patrick Heimba
+Line 16 
 Authors: Martin Losch and Patrick Heimba
  %----------------------------------------------------------------------
  \subsubsection{OBCS configuration and compiling
- \label{sec:pkg:kpp:comp}}
+ \label{sec:pkg:obcs:comp}}
  As with all MITgcm packages, OBCS can be turned on or off
  at compile time
-Line 43 
 The latter case requires
+Line 44 
 The latter case requires
  packages \texttt{cal} and \texttt{exf} to be enabled.
  %
  \end{itemize}
- (see also Section \ref{sect:buildingCode}).
+ (see also Section \ref{sec:buildingCode}).
  Parts of the OBCS code can be enabled or disabled at compile time
  via CPP preprocessor flags. These options are set in
  \texttt{OBCS\_OPTIONS.h}. Table \ref{tab:pkg:obcs:cpp} summarizes them.
- \begin{table}[h!]
+ \begin{table}[!ht]
  \centering
    \label{tab:pkg:obcs:cpp}
    {\footnotesize
-Line 111 
 Table \ref{tab:pkg:obcs:runtime_flags} s
+Line 112 
 Table \ref{tab:pkg:obcs:runtime_flags} s
  runtime flags that are set in \texttt{data.obcs}, and
  their default values.
- \begin{table}[h!]
+ \begin{table}[!ht]
  \centering
-   \label{tab:pkg:obcs:runtime_flags}
    {\footnotesize
      \begin{tabular}{|l|c|l|}
        \hline
 Line 181 
 their default values.
        \hline
      \end{tabular}
    }
-   \caption{~}
+   \caption{pkg OBCS run-time parameters}
+   \label{tab:pkg:obcs:runtime_flags}
  \end{table}
  %----------------------------------------------------------------------
+ \subsubsection{Defining open boundary positions
+ \label{sec:pkg:obcs:defining}}
+ There are four open boundaries (OBs), a
+ Northern, Southern, Eastern, and Western.
+ All OB locations are specified by their absolute
+ meridional (Northern/Southern) or zonal (Eastern/Western) indices.
+ Thus, for each zonal position $i=1,\ldots,Nx$ a meridional index
+ $j$ specifies the Northern/Southern OB position,
+ and for each meridional position $j=1,\ldots,Ny$, a zonal index
+ $i$ specifies the Eastern/Western OB position.
+ For Northern/Southern OB this defines an $Nx$-dimensional
+ ``row'' array $\tt OB\_Jnorth(Ny)$ / $\tt OB\_Jsouth(Ny)$,
+ and an $Ny$-dimenisonal
+ ``column'' array $\tt OB\_Ieast(Nx)$ / $\tt OB\_Iwest(Nx)$
+ Positions determined in this way allows Northern/Southern
+ OBs to be at variable $j$ (or $y$) positions, and Eastern/Western
+ OBs at variable $i$ (or $x$) positions.
+ Here, indices refer to tracer points on the C-grid.
+ A zero (0) element in $\tt OB\_I\ldots$, $\tt OB\_J\ldots$
+ means there is no corresponding OB in that column/row.
+ For a Northern/Southern OB, the OB V point is to the South/North.
+ For an Eastern/Western OB, the OB U point is to the West/East.
+ \begin{verbatim}
+  For example
+      OB_Jnorth(3)=34  means that:
+           T( 3 ,34) is a an OB point
+           U(3:4,34) is a an OB point
+           V( 4 ,34) is a an OB point
+  while
+      OB_Jsouth(3)=1  means that:
+           T( 3 ,1) is a an OB point
+           U(3:4,1) is a an OB point
+           V( 4 ,2) is a an OB point
+ \end{verbatim}
+ For convenience, negative values for Jnorth/Ieast refer to
+ points relative to the Northern/Eastern edges of the model
+ eg. $\tt OB\_Jnorth(3)=-1$  means that the point $\tt (3,Ny)$
+ is a northern OB.
+ \noindent
+ \textsf{Add special comments for case \#define NONLIN\_FRSURF,
+ see obcs\_ini\_fixed.F}
+ %----------------------------------------------------------------------
  \subsubsection{Equations and key routines
  \label{sec:pkg:obcs:equations}}
- \paragraph{OBCS\_READPARMS:} Setting OB positions \\
+ \paragraph{OBCS\_READPARMS:} ~ \\
- ~
+ Set OB positions through arrays
+ {\tt OB\_Jnorth(Ny), OB\_Jsouth(Ny), OB\_Ieast(Nx), OB\_Iwest(Nx)},
+ and runtime flags (see Table \ref{tab:pkg:obcs:runtime_flags}).
  \paragraph{OBCS\_CALC:} ~ \\
- ~
+ %
+ Top-level routine for filling values to be applied at OB for
+ $T,S,U,V,\eta$ into corresponding
+ ``slice'' arrays $(x,z)$, $(y,z)$ for each OB:
+ $\tt OB[N/S/E/W][t/s/u/v]$; e.g. for salinity array at
+ Southern OB, array name is $\tt OBSt$.
+ Values filled are either
+ %
+ \begin{itemize}
+ %
+ \item
+ constant vertical $T,S$ profiles as specified in file
+ {\tt data} ({\tt tRef(Nr), sRef(Nr)}) with zero velocities $U,V$,
+ %
+ \item
+ $T,S,U,V$ values determined via Orlanski radiation conditions
+ (see below),
+ %
+ \item
+ prescribed time-constant or time-varying fields (see below).
+ %
+ \end{itemize}
- \paragraph{OBCS\_APPLY\_*:} ~ \\
- ~
- \paragraph{OBCS\_PRESCRIBE\_READ} Setting OB fields and updates \\
+ \paragraph{ORLANSKI} ~ \\
  %
- ~
+ Orlanski radiation conditions \citep{orl:76}
- \paragraph{OBCS\_SPONGE} Setting sponge layer characteristics \\
+ \paragraph{OBCS\_PRESCRIBE\_READ} Setting OB fields and updates \\
  %
  ~
-Line 212 
 their default values.
+Line 282 
 their default values.
  %
  ~
- \paragraph{ORLANSKI} Orlanski radiation conditions \\
+ \paragraph{OBCS\_APPLY\_*:} ~ \\
+ ~
+ \paragraph{OBCS\_SPONGE} Setting sponge layer characteristics \\
  %
  ~
-Line 246 
 Diagnostics output is available via the
+Line 319 
 Diagnostics output is available via the
  Available output fields are summarized in
  Table \ref{tab:pkg:obcs:diagnostics}.
- \begin{table}[h!]
+ \begin{table}[!ht]
  \centering
  \label{tab:pkg:obcs:diagnostics}
  {\footnotesize
-Line 270 
 Table \ref{tab:pkg:obcs:diagnostics}.
+Line 343 
 Table \ref{tab:pkg:obcs:diagnostics}.
  \subsubsection{References}
+ \subsubsection{Experiments and tutorials that use obcs}
+ \label{sec:pkg:obcs:experiments}
+ \begin{itemize}
+ \item{Ocean experiment in exp4 verification directory. }
+ \end{itemize}

 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.5
 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.5
-Removed from v.1.1
+Added in v.1.5

	ViewVC Help
Powered by ViewVC 1.1.22