View source for coupling esmf atm.yaml

<div class="title">ROMS ESMF/NUOPC Metadata File: coupling_esmf_atm.yaml</div>

__TOC__

The '''coupling_esmf_<atm>.yaml''' (where '''<atm>''' is the model name) file specifies the ROMS Coupling ESMF/NUOPC System Import/Export Metadata Dictionary. Starting '''svn''' revision '''-r 1902''' released on March 1, 2022, the ROMS coupling metadata is managed with a YAML file, and the regular text file '''coupling_esmf_<atm>.dat''' is deprecated. The YAML files are simple, easy to follow, elegant, portable, and expandable. ROMS can now process YAML files with its parser module, '''yaml_parser.F'''. Therefore, there is no need to use third-party YAML parsers. Basically, '''coupling_esmf_<atm>.yaml''' has the following structure:

<div class="box"><span class="violet">ATM_component</span>:   <span class="green">&ATM</span> <span class="twilightBlue">WRF</span><br /><br /><span class="violet">DATA_component</span>:  <span class="twilightBlue">data.nc</span><br /><br /><span class="violet">ROMS_component</span>:  <span class="green">&OCN</span> <span class="twilightBlue">ROMS</span><br /><br /><span class="violet">metadata</span>:<br /><br />  <span class="red">-</span> <span class="violet">standard_name</span>:       <span class="twilightBlue">sea_surface_temperature</span><br />    <span class="violet">long_name</span>:           <span class="twilightBlue">sea surface temperature</span><br />    <span class="violet">short_name</span>:          <span class="twilightBlue">SST</span><br />    <span class="violet">data_variables</span>:      <span class="red">[<span class="twilightBlue">temperature</span>, <span class="twilightBlue">time</span>]</span><br />    <span class="violet">source_units</span>:        <span class="twilightBlue">C</span><br />    <span class="violet">destination_units</span>:   <span class="twilightBlue">K</span><br />    <span class="violet">source_grid</span>:         <span class="twilightBlue">cell_center</span><br />    <span class="violet">destination_grid</span>:    <span class="twilightBlue">cell_center</span><br />    <span class="violet">add_offset</span>:          <span class="twilightBlue">273.15d0</span><br />    <span class="violet">scale</span>:               <span class="twilightBlue">1.0d0</span><br />    <span class="violet">debug_write</span>:         <span class="twilightBlue">false</span><br />    <span class="violet">connected_to</span>:        <span class="salmon">*OCN</span><br />    <span class="violet">regrid_method</span>:       <span class="twilightBlue">bilinear</span><br />    <span class="violet">extrapolate_method</span>:  <span class="twilightBlue">nearest</span><br /><br />  <span class="red">-</span> <span class="violet">standard_name</span>:       <span class="twilightBlue">sea_surface_temperature_data</span><br />    <span class="violet">long_name</span>:           <span class="twilightBlue">sea surface temperature data</span><br />    <span class="violet">short_name</span>:          <span class="twilightBlue">dSST</span><br />    <span class="violet">data_variables</span>:      <span class="red">[<span class="twilightBlue">temperature</span>, <span class="twilightBlue">time</span>]</span><br />    <span class="violet">source_units</span>:        <span class="twilightBlue">C</span><br />    <span class="violet">destination_units</span>:   <span class="twilightBlue">K</span><br />    <span class="violet">source_grid</span>:         <span class="twilightBlue">cell_center</span><br />    <span class="violet">destination_grid</span>:    <span class="twilightBlue">cell_center</span><br />    <span class="violet">add_offset</span>:          <span class="twilightBlue">273.15d0</span><br />    <span class="violet">scale</span>:               <span class="twilightBlue">1.0d0</span><br />    <span class="violet">debug_write</span>:         <span class="twilightBlue">false</span><br />    <span class="violet">connected_to</span>:        <span class="salmon">*ATM</span><br />    <span class="violet">regrid_method</span>:       <span class="twilightBlue">bilinear</span><br />    <span class="violet">extrapolate_method</span>:  <span class="twilightBlue">nearest</span><br />  <span class="red">...</span></div>

The field key and value pair in the YAML blocking list is as follows:

{| border="1" cellspacing="0" cellpadding="5" align="left"
!'''Key'''
!'''Description'''
|-
|<span class="violet">standard_name</span>
|CF conventions standard name for variable. A list of applicable '''standard_name''' attributes are shown below.
|-
|<span class="violet">long_name</span>
|The field's long descriptive name.
|-
|<span class="violet">short_name</span>
|The field's short name private to the '''NUOPC''' cap module
|-
|<span class="violet">data_variables</span>
|The <span class="green">DATA</span> component NetCDF field and time variable names.
|-
|<span class="violet">source_units</span>
|The field's source units.
|-
|<span class="violet">destination_units</span>
|The field's destination units.
|-
|<span class="violet">source_grid</span>
|The field's source grid-cell location.
|-
|<span class="violet">destination_grid</span>
|The field's destination grid-cell location.
|-
|<span class="violet">add_offset</span>
|The value to add to the exchanged field.
|-
|<span class="violet">scale</span>
|The scale to use to convert data from source to destination.
|-
|<span class="violet">debug_write</span>
|A switch indicating whether or not to write out exchanged field, if DebugLevel>2.
|-
|<span class="violet">connected_to</span>
|The source component to which the field is connected.
|-
|<span class="violet">regrid_method</span>
|The field regridding method from source to destination:<br /><br />
  {|style="margin-left: 100px;" border="1" cellspacing="0" cellpadding="5" align="left"
   !'''Value'''
   !'''Description'''
   |-
   |<span class="twilightBlue">bilinear</span>
   |bilinear interpolation
   |-
   |<span class="twilightBlue">patch</span>
   |high-order patch recovery
   |-
   |<span class="twilightBlue">conservative1</span>
   |first-order conservative
   |-
   |<span class="twilightBlue">conservative2</span>
   |second-order conservative
   |-
   |<span class="twilightBlue">nearest</span>
   |nearest neighbor interpolation
   |-
   |}
|-
|<span class="violet">extrapolate_method</span>
|The field extrapolation method for unmapped points:<br /><br />
  {|style="margin-left: 100px;" border="1" cellspacing="0" cellpadding="5" align="left"
   !'''Value'''
   !'''Description'''
   |-
   |<span class="twilightBlue">none</span>
   |no extrapolation
   |-
   |<span class="twilightBlue">nearest</span>
   |nearest source to destination
   |-
   |<span class="twilightBlue">idavg</span>
   |nearest inverse distance average
   |-
   |<span class="twilightBlue">creep</span>
   |creep fill at specified level
   |-
   |<span class="twilightBlue">2steps</span>
   |Turuncoglu's 2 steps extrapolation
   |-
   |}
|-
|}
<div style="clear: both"></div>


The ESM imported fields are processed as:
:<span class="twilightBlue">field</span> (<span class="violet">destination_units</span>) = <span class="twilightBlue">field</span> (<span class="violet">source_units</span>) * <span class="violet">scale</span> + <span class="violet">add_offset</span>
YAML allows '''alias''' and '''anchor''' to avoid repetition. In YAML, single or multiple line comments start with a hash <span class="twilightBlue">#</span>. Also, comment after a key/value pair is allowed. All comments are skipped during processing.

=== Metadata: standard_name ===

The following table shows the coupling metadata <span class="violet">short_name</span> and <span class="violet">standard_name</span> ESMF/NUOPC export and Import states.  They follow CF conventions.  However, we needed to create lots of them because are not available in the CF tables but followed their established syntax.

{| border="1" cellspacing="0" cellpadding="5" align="left"
| align="center" | <span class="violet">short_name</span>
|style="width: 350px;" align="center" | <span class="violet">standard_name</span>
|-
| <span class="twilightBlue">dLWrad</span>
| <span class="twilightBlue">surface_net_downward_longwave_flux</span>
|-
| <span class="twilightBlue">dSWrad</span>
| <span class="twilightBlue">net_downward_shortwave_flux_at_sea_water_surface</span>
|-
| <span class="twilightBlue">dSST</span>
| <span class="twilightBlue">sea_surface_temperature_data</span>
|-
| <span class="twilightBlue">Hair</span>
| <span class="twilightBlue">surface_specific_humidity</span>
|-
| <span class="twilightBlue">LHfx</span>
| <span class="twilightBlue">surface_latent_heat_flux</span>
|-
| <span class="twilightBlue">LWrad</span>
| <span class="twilightBlue">surface_net_downward_longwave_flux</span>
|-
| <span class="twilightBlue">Pair</span>
| <span class="twilightBlue">surface_air_pressure</span>
|-
| <span class="twilightBlue">Pmsl</span>
| <span class="twilightBlue">mean_sea_level_pressure</span>
|-
| <span class="twilightBlue">Qair</span>
| <span class="twilightBlue">surface_relative_humidity</span>
|-
| <span class="twilightBlue">rain</span>
| <span class="twilightBlue">precipitation_flux</span>
|-
| <span class="twilightBlue">shflux</span>
| <span class="twilightBlue">surface_downward_heat_flux_in_sea_water</span>
|-
| <span class="twilightBlue">SHfx</span>
| <span class="twilightBlue">surface_sensible_heat_flux</span>
|-
| <span class="twilightBlue">SST</span>
| <span class="twilightBlue">sea_surface_temperature</span>
|-
| <span class="twilightBlue">sustr</span>
| <span class="twilightBlue">surface_downward_x_stress</span>
|-
| <span class="twilightBlue">svstr</span>
| <span class="twilightBlue">surface_downward_y_stress</span>
|-
| <span class="twilightBlue">swflux</span>
| <span class="twilightBlue">surface_upward_water_flux</span>
|-
| <span class="twilightBlue">SWrad</span>
| <span class="twilightBlue">net_shortwave_flux_at_sea_water_surface</span>
|-
| <span class="twilightBlue">Tair</span>
| <span class="twilightBlue">surface_air_temperature</span>
|-
| <span class="twilightBlue">Uwind</span>
| <span class="twilightBlue">surface_eastward_wind</span>
|-
| <span class="twilightBlue">Vwind</span>
| <span class="twilightBlue">surface_northward_wind</span>
|-
|}