Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCN aquaplanet from file and new A compsets with DOCN modes #1582

Merged
merged 7 commits into from
May 22, 2017
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 61 additions & 40 deletions src/components/data_comps/docn/cime_config/config_component.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,25 @@

<entry id="DOCN_MODE">
<type>char</type>
<valid_values>prescribed,sst_aquap1,sst_aquap2,sst_aquap3,sst_aquap4,sst_aquap5,sst_aquap6,sst_aquap7,sst_aquap8,sst_aquap9,sst_aquap10,som,som_aquap,copyall,interannual,null</valid_values>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to get rid of "copyall"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. copyall was not being used so having it there was simply confusing.

<valid_values>prescribed,sst_aquap1,sst_aquap2,sst_aquap3,sst_aquap4,sst_aquap5,sst_aquap6,sst_aquap7,sst_aquap8,sst_aquap9,sst_aquap10,sst_aquapfile,som,som_aquap,interannual,null</valid_values>
<default_value>prescribed</default_value>
<values>
<value compset="_DOCN%NULL">null</value>
<value compset="_DOCN%DOM" >prescribed</value>
<value compset="_DOCN%SOM" >som</value>
<value compset="_DOCN%SOMAQP">som_aquap</value>
<value compset="_DOCN%IAF">interannual</value>
<value compset="_DOCN%AQP1">sst_aquap1</value>
<value compset="_DOCN%AQP2">sst_aquap2</value>
<value compset="_DOCN%AQP3">sst_aquap3</value>
<value compset="_DOCN%AQP4">sst_aquap4</value>
<value compset="_DOCN%AQP5">sst_aquap5</value>
<value compset="_DOCN%AQP6">sst_aquap6</value>
<value compset="_DOCN%AQP7">sst_aquap7</value>
<value compset="_DOCN%AQP8">sst_aquap8</value>
<value compset="_DOCN%AQP9">sst_aquap9</value>
<value compset="_DOCN%AQP10">sst_aquap10</value>
<value compset="_DOCN%COPY">copyall</value>
<value compset="_DOCN%NULL_">null</value>
<value compset="_DOCN%DOM_" >prescribed</value>
<value compset="_DOCN%SOM_" >som</value>
<value compset="_DOCN%SOMAQP_">som_aquap</value>
<value compset="_DOCN%IAF_">interannual</value>
<value compset="_DOCN%AQP1_">sst_aquap1</value>
<value compset="_DOCN%AQP2_">sst_aquap2</value>
<value compset="_DOCN%AQP3_">sst_aquap3</value>
<value compset="_DOCN%AQP4_">sst_aquap4</value>
<value compset="_DOCN%AQP5_">sst_aquap5</value>
<value compset="_DOCN%AQP6_">sst_aquap6</value>
<value compset="_DOCN%AQP7_">sst_aquap7</value>
<value compset="_DOCN%AQP8_">sst_aquap8</value>
<value compset="_DOCN%AQP9_">sst_aquap9</value>
<value compset="_DOCN%AQP10_">sst_aquap10</value>
<value compset="_DOCN%AQPFILE_">sst_aquapfile</value>
</values>
<group>run_component_docn</group>
<file>env_run.xml</file>
Expand Down Expand Up @@ -67,13 +67,13 @@
appropriate and is provided for testing and development purposes only.
Users must create scientifically appropriate data for their particular
application. A tool is available to derive valid SOM forcing.
--- A setting of sst_aquapN (where “N” is an integer index value) is a
type of prescribed SST mode used specifically for an aquaplanet setup in
which global SSTs correspond to an analytic form set by the index value.
--- A setting of sst_aquapN (where N is an integer index value) is a
type of prescribed SST mode used specifically for an aquaplanet setup in
which global SSTs correspond to an analytic form set by the index value.
Currently, indices for 10 SST profiles are supported [e.g., index 3 corresponds
to the QOBS profile of Neale and Hoskins (2001, Atmos. Sci. Lett.)].
With source code modifications, it is possible for users to create their own
analytic SST distributions and match them to indices 11 or greater.
to the QOBS profile of Neale and Hoskins (2001, Atmos. Sci. Lett.)].
With source code modifications, it is possible for users to create their own
analytic SST distributions and match them to indices 11 or greater.
</desc>
</entry>

Expand All @@ -88,7 +88,21 @@
</values>
<group>run_component_docn</group>
<file>env_run.xml</file>
<desc>Sets SOM forcing data filename for pres runs, only used in D and E compset</desc>
<desc>Sets SOM forcing filename.
This is only used when DOCN_MODE=som.</desc>
</entry>

<entry id="DOCN_AQP_FILENAME">
<type>char</type>
<valid_values></valid_values>
<default_value>UNSET</default_value>
<values>
<value compset="_DOCN%AQPFILE">sst_c4aquasom_0.9x1.25_clim.c170512.nc</value>
</values>
<group>run_component_docn</group>
<file>env_run.xml</file>
<desc>Sets aquaplanet forcing filename instead of using an analytic form.
This is only used when DOCN_MODE=sst_aqpfile.</desc>
</entry>

<entry id="SSTICE_STREAM">
Expand All @@ -98,7 +112,8 @@
<group>run_component_docn</group>
<file>env_run.xml</file>
<desc>Prescribed SST and ice coverage stream name.
Sets SST and ice coverage stream name for prescribed runs.</desc>
Sets SST and ice coverage stream name.
This is only used when DOCN_MODE=prescribed.</desc>
</entry>

<entry id="SSTICE_DATA_FILENAME">
Expand Down Expand Up @@ -131,7 +146,8 @@
<group>run_component_docn</group>
<file>env_run.xml</file>
<desc>Prescribed SST and ice coverage data file name.
Sets SST and ice coverage data file name for DOCN prescribed runs.</desc>
Sets SST and ice coverage data file name.
This is only used when DOCN_MODE=prescribed.</desc>
</entry>

<entry id="SSTICE_GRID_FILENAME">
Expand Down Expand Up @@ -167,7 +183,8 @@
<group>run_component_cam_sstice</group>
<file>env_run.xml</file>
<desc>Prescribed SST and ice coverage grid file name.
Sets SST and ice coverage grid file name for prescribed runs.</desc>
Sets SST and ice coverage grid file name for prescribed runs.
This is only used when DOCN_MODE=prescribed.</desc>
</entry>

<entry id="SSTICE_YEAR_ALIGN">
Expand All @@ -188,7 +205,8 @@
run after the prescribed data ends (as determined by SSTICE_YEAR_END), the
default behavior is to assume that the data from SSTICE_YEAR_START to
SSTICE_YEAR_END cyclically repeats. This behavior is controlled by the
&quot;taxmode&quot; stream option; see the data model documentation for more details.</desc>
&quot;taxmode&quot; stream option; see the data model documentation for more details.
This is only used when DOCN_MODE=prescribed.</desc>
</entry>

<entry id="SSTICE_YEAR_START">
Expand All @@ -203,7 +221,8 @@
<desc>The first year of data to use from SSTICE_DATA_FILENAME.
This is the first year of prescribed SST and ice coverage data to use. For
example, if a data file has data for years 0-99, and SSTICE_YEAR_START is 10,
years 0-9 in the file will not be used.</desc>
years 0-9 in the file will not be used.
This is only used when DOCN_MODE=prescribed.</desc>
</entry>

<entry id="SSTICE_YEAR_END">
Expand All @@ -218,7 +237,8 @@
<desc>The last year of data to use from SSTICE_DATA_FILENAME.
This is the last year of prescribed SST and ice coverage data to use. For
example, if a data file has data for years 0-99, and value is 49,
years 50-99 in the file will not be used.</desc>
years 50-99 in the file will not be used.
This is only used when DOCN_MODE=prescribed.</desc>
</entry>

<description>
Expand All @@ -228,16 +248,17 @@
<desc compset="_DOCN%SOMAQP">docn aquaplanet slab ocean mode</desc>
<desc compset="_DOCN%IAF" >docn interannual mode</desc>
<desc compset="_DOCN%SST_AQUAP">docn aquaplanet mode:</desc>
<desc compset="_DOCN%AQP1">docn prescribed aquaplanet sst - option 1</desc>
<desc compset="_DOCN%AQP2">docn prescribed aquaplanet sst - option 2</desc>
<desc compset="_DOCN%AQP3">docn prescribed aquaplanet sst - option 3</desc>
<desc compset="_DOCN%AQP4">docn prescribed aquaplanet sst - option 4</desc>
<desc compset="_DOCN%AQP5">docn prescribed aquaplanet sst - option 5</desc>
<desc compset="_DOCN%AQP6">docn prescribed aquaplanet sst - option 6</desc>
<desc compset="_DOCN%AQP7">docn prescribed aquaplanet sst - option 7</desc>
<desc compset="_DOCN%AQP8">docn prescribed aquaplanet sst - option 8</desc>
<desc compset="_DOCN%AQP9">docn prescribed aquaplanet sst - option 9</desc>
<desc compset="_DOCN%AQP10">docn prescribed aquaplanet sst - option 10</desc>
<desc compset="_DOCN%AQP1">docn analytic aquaplanet sst - option 1</desc>
<desc compset="_DOCN%AQP2">docn analytic aquaplanet sst - option 2</desc>
<desc compset="_DOCN%AQP3">docn analytic aquaplanet sst - option 3</desc>
<desc compset="_DOCN%AQP4">docn analytic aquaplanet sst - option 4</desc>
<desc compset="_DOCN%AQP5">docn analytic aquaplanet sst - option 5</desc>
<desc compset="_DOCN%AQP6">docn analytic aquaplanet sst - option 6</desc>
<desc compset="_DOCN%AQP7">docn analytic aquaplanet sst - option 7</desc>
<desc compset="_DOCN%AQP8">docn analytic aquaplanet sst - option 8</desc>
<desc compset="_DOCN%AQP9">docn analytic aquaplanet sst - option 9</desc>
<desc compset="_DOCN%AQP10">docn analytic aquaplanet sst - option 10</desc>
<desc compset="_DOCN%AQPFILE">docn file input aquaplanet sst </desc>
</description>

<help>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
<value docn_mode="sst_aquap8">''</value>
<value docn_mode="sst_aquap9">''</value>
<value docn_mode="sst_aquap10">''</value>
<value docn_mode="sst_aquapfile">aquapfile</value>
<value docn_mode="som">som</value>
<value docn_mode="som_aquap">som</value>
<value docn_mode="interannual">interannual</value>
Expand Down Expand Up @@ -89,6 +90,7 @@
<desc>Stream domain file directory.</desc>
<values>
<value>null</value>
<value stream="aquapfile">$DIN_LOC_ROOT/ocn/docn7/AQUAPLANET/</value>
<value stream="som">$DIN_LOC_ROOT/ocn/docn7/SOM</value>
<value stream="interannual">$DIN_LOC_ROOT/atm/cam/sst</value>
</values>
Expand All @@ -101,6 +103,7 @@
<desc>Stream domain file path(s).</desc>
<values>
<value>null</value>
<value stream="aquapfile">$DOCN_AQP_FILENAME</value>
<value stream="som">$DOCN_SOM_FILENAME</value>
<value stream="interannual">sst_HadOIBl_bc_1x1_1850_2014_c150416.nc</value>
</values>
Expand All @@ -121,8 +124,13 @@
</value>
<value stream="interannual">
time time
lon lon
lat lat
lon lon
lat lat
</value>
<value stream="aquapfile">
time time
lon lon
lat lat
</value>
</values>
</entry>
Expand All @@ -134,6 +142,7 @@
<desc>Stream data file directory.</desc>
<values>
<value>null</value>
<value stream="aquapfile">$DIN_LOC_ROOT/ocn/docn7/AQUAPLANET</value>
<value stream="som">$DIN_LOC_ROOT/ocn/docn7/SOM</value>
<value stream="interannual">$DIN_LOC_ROOT/atm/cam/sst</value>
</values>
Expand All @@ -146,20 +155,7 @@
<desc>Stream data file path(s).</desc>
<values>
<value>null</value>
<value stream="prescribed" sstice_stream="WRFDATA_wus12">
sst_wus12_110111.2003-10.nc
sst_wus12_110111.2003-11.nc
sst_wus12_110111.2003-12.nc
sst_wus12_110111.2004-01.nc
sst_wus12_110111.2004-02.nc
sst_wus12_110111.2004-03.nc
sst_wus12_110111.2004-04.nc
sst_wus12_110111.2004-05.nc
sst_wus12_110111.2004-06.nc
sst_wus12_110111.2004-07.nc
sst_wus12_110111.2004-08.nc
sst_wus12_110111.2004-09.nc
</value>
<value stream="aquapfile">$DOCN_AQP_FILENAME</value>
<value stream="som">$DOCN_SOM_FILENAME</value>
<value stream="interannual">sst_HadOIBl_bc_1x1_1850_2014_c150416.nc</value>
</values>
Expand All @@ -185,10 +181,13 @@
qdp qbot
</value>
<value stream="interannual">
SST_cpl t
SST_cpl t
</value>
<value stream="prescribed" sstice_stream="CAMDATA">
SST_cpl t
SST_cpl t
</value>
<value stream="aquapfile">
SST_cpl t
</value>
</values>
</entry>
Expand All @@ -211,6 +210,7 @@
<values>
<value>-999</value>
<value stream="prescribed">$SSTICE_YEAR_ALIGN</value>
<value stream="aquapfile">0</value>
<value stream="som">1</value>
<value stream="interannual">1</value>
</values>
Expand All @@ -224,6 +224,7 @@
<values>
<value>-999</value>
<value stream="prescribed">$SSTICE_YEAR_START</value>
<value stream="aquapfile">0</value>
<value stream="som">1</value>
<value stream="interannual">1850</value>
</values>
Expand All @@ -237,6 +238,7 @@
<values>
<value>-999</value>
<value stream="prescribed">$SSTICE_YEAR_END</value>
<value stream="aquapfile">0</value>
<value stream="som">1</value>
<value stream="interannual">2014</value>
</values>
Expand All @@ -254,7 +256,7 @@
<type>char</type>
<category>streams</category>
<group>shr_strdata_nml</group>
<valid_values>SSTDATA,SST_AQUAP1,SST_AQUAP2,SST_AQUAP3,SST_AQUAP4,SST_AQUAP5,SST_AQUAP6,SST_AQUAP7,SST_AQUAP8,SST_AQUAP9,SST_AQUAP10,SOM,SOM_AQUAP,IAF,NULL,COPYALL</valid_values>
<valid_values>SSTDATA,SST_AQUAP1,SST_AQUAP2,SST_AQUAP3,SST_AQUAP4,SST_AQUAP5,SST_AQUAP6,SST_AQUAP7,SST_AQUAP8,SST_AQUAP9,SST_AQUAP10,SST_AQUAPFILE,SOM,SOM_AQUAP,IAF,NULL,COPYALL</valid_values>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

COPYALL wasn't removed here but is removed in other parts of this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The datamode in namelist_definition.xml and the DOCN_MODE are not the same thing. The DOCN_MODE maps to a datamode that is used directly by the docn model. For now DOCN_MODE copyall is not used - so I removed it. But the DOCN datamodel value of COPYALL could still be used at some point - so it should stay in the valid values.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Just update the PR to mention that COPYALL is being removed from DOCN_MODE.

<desc>
General method that operates on the data. This is generally
implemented in the data models but is set in the strdata method for
Expand Down Expand Up @@ -310,16 +312,17 @@
<values>
<value docn_mode="null">NULL</value>
<value docn_mode="prescribed">SSTDATA</value>
<value docn_mode="sst_aquap1">SST_AQUAP1</value>
<value docn_mode="sst_aquap2">SST_AQUAP2</value>
<value docn_mode="sst_aquap3">SST_AQUAP3</value>
<value docn_mode="sst_aquap4">SST_AQUAP4</value>
<value docn_mode="sst_aquap5">SST_AQUAP5</value>
<value docn_mode="sst_aquap6">SST_AQUAP6</value>
<value docn_mode="sst_aquap7">SST_AQUAP7</value>
<value docn_mode="sst_aquap8">SST_AQUAP8</value>
<value docn_mode="sst_aquap9">SST_AQUAP9</value>
<value docn_mode="sst_aquap10">SST_AQUAP10</value>
<value docn_mode="sst_aquap1$">SST_AQUAP1</value>
<value docn_mode="sst_aquap2$">SST_AQUAP2</value>
<value docn_mode="sst_aquap3$">SST_AQUAP3</value>
<value docn_mode="sst_aquap4$">SST_AQUAP4</value>
<value docn_mode="sst_aquap5$">SST_AQUAP5</value>
<value docn_mode="sst_aquap6$">SST_AQUAP6</value>
<value docn_mode="sst_aquap7$">SST_AQUAP7</value>
<value docn_mode="sst_aquap8$">SST_AQUAP8</value>
<value docn_mode="sst_aquap9$">SST_AQUAP9</value>
<value docn_mode="sst_aquap10$">SST_AQUAP10</value>
<value docn_mode="sst_aquapfile$">SST_AQUAPFILE</value>
<value docn_mode="som$">SOM</value>
<value docn_mode="som_aquap">SOM_AQUAP</value>
<value docn_mode="interannual">IAF</value>
Expand Down Expand Up @@ -505,7 +508,6 @@
</desc>
<values>
<value>cycle</value>
<value stream="prescribed" sstice_stream="WRFDATA_wus12">limit</value>
<value stream="prescribed" sstice_stream="WRFDATA">limit</value>
</values>
</entry>
Expand Down
Loading