Skip to content

Commit

Permalink
A few namelist updates for E3SM v3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@xylar
xylar committed Apr 27, 2024
1 parent ebb2135 commit 4714cf4
Show file tree
Hide file tree
Showing 4 changed files with 143 additions and 76 deletions.
122 changes: 102 additions & 20 deletions users_guide/ocean/namelist_section_documentation.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,9 @@
\hline
Default Value: & split\_explicit\_ab2 \\
\hline
Possible Values: & 'split\_explicit', 'RK4', 'unsplit\_explicit', 'split\_implicit', 'LTS', 'split\_explicit\_ab2' \\
Possible Values: & 'split\_explicit', 'RK4', 'unsplit\_explicit', 'split\_implicit', 'split\_explicit\_ab2', 'LTS', 'FB\_LTS' \\
\hline
\caption{config\_time\_integrator: Time integration method.}
\caption{config\_time\_integrator: Time integration method. These options are only supported in standalone, not E3SM: 'LTS', 'FB\_LTS'.}
\end{longtable}
\end{center}
\subsection[config\_number\_of\_time\_levels]{\hyperref[sec:nm_tab_time_integration]{config\_number\_of\_time\_levels}}
Expand Down Expand Up @@ -2423,22 +2423,6 @@
\end{center}
\section[coupling]{\hyperref[sec:nm_tab_coupling]{coupling}}
\label{sec:nm_sec_coupling}
\subsection[config\_ssh\_grad\_relax\_timescale]{\hyperref[sec:nm_tab_coupling]{config\_ssh\_grad\_relax\_timescale}}
\label{subsec:nm_sec_config_ssh_grad_relax_timescale}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & \si{seconds} \\
\hline
Default Value: & 0.0 \\
\hline
Possible Values: & Any positive real number. \\
\hline
\caption{config\_ssh\_grad\_relax\_timescale: Timescale for relaxation of the ssh gradient for coupling. A value of 0.0 (default) removes any relaxation and gives instantaneous response.}
\end{longtable}
\end{center}
\subsection[config\_remove\_AIS\_coupler\_runoff]{\hyperref[sec:nm_tab_coupling]{config\_remove\_AIS\_coupler\_runoff}}
\label{subsec:nm_sec_config_remove_AIS_coupler_runoff}
\begin{center}
Expand Down Expand Up @@ -2470,7 +2454,7 @@
\hline
Possible Values: & 'jerlov' or 'ohlmann00' or 'none' \\
\hline
\caption{config\_sw\_absorption\_type: Name of shortwave absorption type used in simulation. }
\caption{config\_sw\_absorption\_type: Name of shortwave absorption type used in simulation.}
\end{longtable}
\end{center}
\subsection[config\_jerlov\_water\_type]{\hyperref[sec:nm_tab_shortwaveRadiation]{config\_jerlov\_water\_type}}
Expand Down Expand Up @@ -2582,7 +2566,7 @@
\hline
Default Value: & off \\
\hline
Possible Values: & 'off','monochromatic' \\
Possible Values: & 'off','monochromatic','linear' \\
\hline
\caption{config\_tidal\_forcing\_model: Selects the mode in which tidal forcing is computed.}
\end{longtable}
Expand Down Expand Up @@ -2651,6 +2635,54 @@
\caption{config\_tidal\_forcing\_monochromatic\_baseline: Value of baseline monochromatic tide, e.g., sea level rise.}
\end{longtable}
\end{center}
\subsection[config\_tidal\_forcing\_linear\_baseline]{\hyperref[sec:nm_tab_tidal_forcing]{config\_tidal\_forcing\_linear\_baseline}}
\label{subsec:nm_sec_config_tidal_forcing_linear_baseline}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & \si{days} \\
\hline
Default Value: & 0.0 \\
\hline
Possible Values: & Any positive real number. \\
\hline
\caption{config\_tidal\_forcing\_linear\_baseline: Value of baseline linear tide, e.g., sea level rise.}
\end{longtable}
\end{center}
\subsection[config\_tidal\_forcing\_linear\_min]{\hyperref[sec:nm_tab_tidal_forcing]{config\_tidal\_forcing\_linear\_min}}
\label{subsec:nm_sec_config_tidal_forcing_linear_min}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & \si{days} \\
\hline
Default Value: & -1.0 \\
\hline
Possible Values: & Any real number. \\
\hline
\caption{config\_tidal\_forcing\_linear\_min: Value of minimum tide.}
\end{longtable}
\end{center}
\subsection[config\_tidal\_forcing\_linear\_rate]{\hyperref[sec:nm_tab_tidal_forcing]{config\_tidal\_forcing\_linear\_rate}}
\label{subsec:nm_sec_config_tidal_forcing_linear_rate}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & \si{days} \\
\hline
Default Value: & -8.0 \\
\hline
Possible Values: & Any real number. \\
\hline
\caption{config\_tidal\_forcing\_linear\_rate: Value of tide rate of change in m per day.}
\end{longtable}
\end{center}
\section[self\_attraction\_loading]{\hyperref[sec:nm_tab_self_attraction_loading]{self\_attraction\_loading}}
\label{sec:nm_sec_self_attraction_loading}
\subsection[config\_use\_self\_attraction\_loading]{\hyperref[sec:nm_tab_self_attraction_loading]{config\_use\_self\_attraction\_loading}}
Expand Down Expand Up @@ -4065,6 +4097,56 @@
\caption{config\_dt\_scaling\_LTS: The ratio between the dt on the coarse region and the dt on the fine region. Specifically, it is the positive integer M that defines dtFine for LTS, dtFine = dt / M.}
\end{longtable}
\end{center}
\section[forward\_backward]{\hyperref[sec:nm_tab_forward_backward]{forward\_backward}}
\label{sec:nm_sec_forward_backward}
\subsection[config\_fb\_weight\_1]{\hyperref[sec:nm_tab_forward_backward]{config\_fb\_weight\_1}}
\label{subsec:nm_sec_config_fb_weight_1}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & -- \\
\hline
Default Value: & 0.531 \\
\hline
Possible Values: & Any positive real number less than or equal to one. \\
\hline
\caption{config\_fb\_weight\_1: The forward-backward weight for the first stage of FB-RK(3,2), used in FB\_LTS.}
\end{longtable}
\end{center}
\subsection[config\_fb\_weight\_2]{\hyperref[sec:nm_tab_forward_backward]{config\_fb\_weight\_2}}
\label{subsec:nm_sec_config_fb_weight_2}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & -- \\
\hline
Default Value: & 0.531 \\
\hline
Possible Values: & Any positive real number less than or equal to one. \\
\hline
\caption{config\_fb\_weight\_2: The forward-backward weight for the second stage of FB-RK(3,2), used in FB\_LTS.}
\end{longtable}
\end{center}
\subsection[config\_fb\_weight\_3]{\hyperref[sec:nm_tab_forward_backward]{config\_fb\_weight\_3}}
\label{subsec:nm_sec_config_fb_weight_3}
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & -- \\
\hline
Default Value: & 0.313 \\
\hline
Possible Values: & Any positive real number less than or equal to one. \\
\hline
\caption{config\_fb\_weight\_3: The forward-backward weight for the third stage of FB-RK(3,2), used in FB\_LTS.}
\end{longtable}
\end{center}
\section[pressure\_gradient]{\hyperref[sec:nm_tab_pressure_gradient]{pressure\_gradient}}
\label{sec:nm_sec_pressure_gradient}
\subsection[config\_pressure\_gradient\_type]{\hyperref[sec:nm_tab_pressure_gradient]{config\_pressure\_gradient\_type}}
Expand Down
33 changes: 29 additions & 4 deletions users_guide/ocean/namelist_table_documentation.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
\hline
\hyperref[subsec:nm_sec_config_dt]{config\_dt} & Length of model time-step. \\
\hline
\hyperref[subsec:nm_sec_config_time_integrator]{config\_time\_integrator} & Time integration method. \\
\hyperref[subsec:nm_sec_config_time_integrator]{config\_time\_integrator} & Time integration method. These options are only supported in standalone, not E3SM: 'LTS', 'FB\_LTS'. \\
\hline
\hyperref[subsec:nm_sec_config_number_of_time_levels]{config\_number\_of\_time\_levels} & The number of time levels in the time-stepping scheme. This is used for array allocation. \\
\hline
Expand Down Expand Up @@ -592,8 +592,6 @@
{\bf Name} & {\bf Description} (Continued) \endhead
\hline
\hline
\hyperref[subsec:nm_sec_config_ssh_grad_relax_timescale]{config\_ssh\_grad\_relax\_\-timescale} & Timescale for relaxation of the ssh gradient for coupling. A value of 0.0 (default) removes any relaxation and gives instantaneous response. \\
\hline
\hyperref[subsec:nm_sec_config_remove_AIS_coupler_runoff]{config\_remove\_AIS\_coupler\_\-runoff} & If true, solid and liquid runoff from the Antarctic Ice Sheet (below 60S latitude) coming from the coupled is zeroed in the coupler import routines. To be used with data iceberg fluxes coming from the sea ice model. \\
\hline
\end{longtable}
Expand All @@ -611,7 +609,7 @@
{\bf Name} & {\bf Description} (Continued) \endhead
\hline
\hline
\hyperref[subsec:nm_sec_config_sw_absorption_type]{config\_sw\_absorption\_type} & Name of shortwave absorption type used in simulation. \\
\hyperref[subsec:nm_sec_config_sw_absorption_type]{config\_sw\_absorption\_type} & Name of shortwave absorption type used in simulation. \\
\hline
\hyperref[subsec:nm_sec_config_jerlov_water_type]{config\_jerlov\_water\_type} & Integer value defining the water type used in Jerlov short wave absorption. \\
\hline
Expand Down Expand Up @@ -650,6 +648,12 @@
\hline
\hyperref[subsec:nm_sec_config_tidal_forcing_monochromatic_baseline]{config\_tidal\_forcing\_\-monochromatic\_baseline} & Value of baseline monochromatic tide, e.g., sea level rise. \\
\hline
\hyperref[subsec:nm_sec_config_tidal_forcing_linear_baseline]{config\_tidal\_forcing\_linear\_\-baseline} & Value of baseline linear tide, e.g., sea level rise. \\
\hline
\hyperref[subsec:nm_sec_config_tidal_forcing_linear_min]{config\_tidal\_forcing\_linear\_\-min} & Value of minimum tide. \\
\hline
\hyperref[subsec:nm_sec_config_tidal_forcing_linear_rate]{config\_tidal\_forcing\_linear\_\-rate} & Value of tide rate of change in m per day. \\
\hline
\end{longtable}
\end{center}
}
Expand Down Expand Up @@ -996,6 +1000,27 @@
\end{longtable}
\end{center}
}
\section[forward\_backward]{\hyperref[sec:nm_sec_forward_backward]{forward\_backward}}
\label{sec:nm_tab_forward_backward}
\vspace{0.5in}
{\small
\begin{center}
\begin{longtable}{| p{2.0in} || p{4.0in} |}
\hline
{\bf Name} & {\bf Description} \endfirsthead
\hline
{\bf Name} & {\bf Description} (Continued) \endhead
\hline
\hline
\hyperref[subsec:nm_sec_config_fb_weight_1]{config\_fb\_weight\_1} & The forward-backward weight for the first stage of FB-RK(3,2), used in FB\_LTS. \\
\hline
\hyperref[subsec:nm_sec_config_fb_weight_2]{config\_fb\_weight\_2} & The forward-backward weight for the second stage of FB-RK(3,2), used in FB\_LTS. \\
\hline
\hyperref[subsec:nm_sec_config_fb_weight_3]{config\_fb\_weight\_3} & The forward-backward weight for the third stage of FB-RK(3,2), used in FB\_LTS. \\
\hline
\end{longtable}
\end{center}
}
\section[pressure\_gradient]{\hyperref[sec:nm_sec_pressure_gradient]{pressure\_gradient}}
\label{sec:nm_tab_pressure_gradient}
\input{ocean/section_descriptions/pressure_gradient.tex}
Expand Down
60 changes: 12 additions & 48 deletions users_guide/ocean/variable_section_documentation.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8525,42 +8525,6 @@
\caption{avgSSHGradientMeridional: Time averaged meridional gradient of SSH}
\end{longtable}
\end{center}
\subsection[filteredSSHGradientZonal]{\hyperref[sec:var_tab_forcing]{filteredSSHGradientZonal}}
\label{subsec:var_sec_forcing_filteredSSHGradientZonal}
\begin{center}
\begin{longtable}{| p{2.0in} | p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & \si{1} \\
\hline
Dimension: & nCells Time \\
\hline
Persistence: & persistent \\
\hline
Location in code: & domain \% blocklist \% forcing \% filteredSSHGradientZonal \\
\hline
\caption{filteredSSHGradientZonal: Time filtered zonal gradient of SSH}
\end{longtable}
\end{center}
\subsection[filteredSSHGradientMeridional]{\hyperref[sec:var_tab_forcing]{filteredSSHGradientMeridional}}
\label{subsec:var_sec_forcing_filteredSSHGradientMeridional}
\begin{center}
\begin{longtable}{| p{2.0in} | p{4.0in} |}
\hline
Type: & real \\
\hline
Units: & \si{1} \\
\hline
Dimension: & nCells Time \\
\hline
Persistence: & persistent \\
\hline
Location in code: & domain \% blocklist \% forcing \% filteredSSHGradientMeridional \\
\hline
\caption{filteredSSHGradientMeridional: Time filtered meridional gradient of SSH}
\end{longtable}
\end{center}
\subsection[avgTotalFreshWaterTemperatureFlux]{\hyperref[sec:var_tab_forcing]{avgTotalFreshWaterTemperatureFlux}}
\label{subsec:var_sec_forcing_avgTotalFreshWaterTemperatureFlux}
\begin{center}
Expand Down Expand Up @@ -43364,7 +43328,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43382,7 +43346,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43400,7 +43364,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43418,7 +43382,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43436,7 +43400,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43454,7 +43418,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43472,7 +43436,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43490,7 +43454,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43508,7 +43472,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43526,7 +43490,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43544,7 +43508,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand All @@ -43562,7 +43526,7 @@
\hline
Type: & real \\
\hline
Units: & \si{kg.m^-2.s^-1} \\
Units: & \si{kg.s^-1} \\
\hline
Dimension: & Time \\
\hline
Expand Down
4 changes: 0 additions & 4 deletions users_guide/ocean/variable_table_documentation.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -992,10 +992,6 @@
\hline
\hyperref[subsec:var_sec_forcing_avgSSHGradientMeridional]{avgSSHGradientMeridional} & Time averaged meridional gradient of SSH \\
\hline
\hyperref[subsec:var_sec_forcing_filteredSSHGradientZonal]{filteredSSHGradientZonal} & Time filtered zonal gradient of SSH \\
\hline
\hyperref[subsec:var_sec_forcing_filteredSSHGradientMeridional]{filteredSSHGradientMeridional} & Time filtered meridional gradient of SSH \\
\hline
\hyperref[subsec:var_sec_forcing_avgTotalFreshWaterTemperatureFlux]{avgTotalFreshWaterTemperature\-Flux} & Sum of heat fluxes associated with water fluxes cell centers sent to coupler. Positive into the ocean. \\
\hline
\hyperref[subsec:var_sec_forcing_landIceFraction]{landIceFraction} & The fraction of each cell covered by land ice \\
Expand Down

0 comments on commit 4714cf4

Please sign in to comment.