NUOPC Cap - Revision history

Arango: /* Implementation */

2022-08-30T19:47:03Z

Implementation

Arango: /* Capabilities */

2022-06-26T21:18:56Z

Capabilities

← Older revision		Revision as of 21:18, 26 June 2022
Line 114:		Line 114:
	\|-		\|-
	\|valign="top"\|<span class="blue">ROMS_Rotate</span>		\|valign="top"\|<span class="blue">ROMS_Rotate</span>
	\|Rotates vector components from computational grid to geographical EAST and NORTH directions or vice versa.		\|Rotates vector components from computational grid to geographical '''EAST''' and '''NORTH''' directions or vice versa.
	\|-		\|-
	\|}		\|}

Arango: /* Capabilities */

2022-06-26T21:10:21Z

Capabilities

← Older revision		Revision as of 21:10, 26 June 2022
Line 112:		Line 112:
	\|valign="top"\|<span class="blue">ROMS_Export</span>		\|valign="top"\|<span class="blue">ROMS_Export</span>
	\|Exports ROMS fields to other gridded components.		\|Exports ROMS fields to other gridded components.
			\|-
			\|valign="top"\|<span class="blue">ROMS_Rotate</span>
			\|Rotates vector components from computational grid to geographical EAST and NORTH directions or vice versa.
	\|-		\|-
	\|}		\|}
Line 177:		Line 180:
	\|}		\|}
	<div style="clear: both"></div>		<div style="clear: both"></div>


	==Import and Export Fields==		==Import and Export Fields==

Arango: /* Overview */

2022-05-04T15:09:49Z

Overview

← Older revision		Revision as of 15:09, 4 May 2022
Line 3:		Line 3:

	==Overview==		==Overview==
	This document describes the ROMS [[Model_Coupling_ESMF\|ESMF/NUOPC]] <span class="red">cap</span> module <span class="blue">Master/esmf_roms.F</span> used in the ROMS native coupling infrastructure shown below. In this case, ROMS is driving the coupled system (<span class="blue">Master/~~esmf_esm~~.F</span>), which ~~sets the~~ '''~~NOUPC~~'''~~-based generic services for~~ each Earth System Model ('''ESM''') component ('''data''', '''atmosphere''', '''sea-ice''', '''wave''', and '''ocean'''), the coupler '''connectors''', and the '''RunSequence''' policy. ~~It also~~ provides the '''NUOPC''' <span class="red">cap</span> modules for each coupled component. Detailed information about '''ESMF/NUOPC''' and how it is implemented in ROMS can be found on the [[Model_Coupling_ESMF\|Earth System Modeling Framework]] WikiROMS page.		This document describes the ROMS [[Model_Coupling_ESMF\|ESMF/NUOPC]] <span class="red">cap</span> module <span class="blue">Master/esmf_roms.F</span> used in the ROMS native coupling infrastructure shown below. In this case, ROMS is driving the coupled system (<span class="blue">Master/esmf_driver.h</span>), which '''creates''', '''register''', '''initialize''', '''run''', and '''finalize''' the coupling of each Earth System Model ('''ESM''') component ('''data''', '''atmosphere''', '''sea-ice''', '''wave''', and '''ocean'''). It also sets the coupler '''connectors''' and the '''RunSequence''' policy (<span class="blue">Master/esmf_esm.F</span>). The framework provides the '''NUOPC''' <span class="red">cap</span> modules for each coupled component. Detailed information about '''ESMF/NUOPC''' and how it is implemented in ROMS can be found on the [[Model_Coupling_ESMF\|Earth System Modeling Framework]] WikiROMS page.

	A '''NUOPC''' <span class="red">cap</span> is a Fortran module that serves as the interface to a model when used in a '''NUOPC'''-based coupled system. The term <span class="red">cap</span> is used because it is a lightweight software layer that sits on top of the model kernel, making calls to its '''initialize''', '''run''', and '''finalize''' phases and exposing the model data structures to the field exchange ('''import''' and '''export''' states) between coupled components.		A '''NUOPC''' <span class="red">cap</span> is a Fortran module that serves as the interface to a model when used in a '''NUOPC'''-based coupled system. The term <span class="red">cap</span> is used because it is a lightweight software layer that sits on top of the model kernel, making calls to its '''initialize''', '''run''', and '''finalize''' phases and exposing the model data structures to the field exchange ('''import''' and '''export''' states) between coupled components.

Arango: /* Import and Export Fields */

2022-05-04T15:00:33Z

Import and Export Fields

← Older revision		Revision as of 15:00, 4 May 2022
Line 177:		Line 177:
	\|}		\|}
	<div style="clear: both"></div>		<div style="clear: both"></div>


	==Import and Export Fields==		==Import and Export Fields==

Arango: /* Capabilities */

2022-05-04T15:00:00Z

Capabilities

← Older revision		Revision as of 15:00, 4 May 2022
Line 68:		Line 68:

	==Capabilities==		==Capabilities==
	The ROMS <span class="red">cap</span> module contains a set of subroutines that are required by '''NUOPC'''. ~~These~~ subroutines are called by the '''NUOPC''' infrastructure ~~according to a predefined calling sequence~~. Some subroutines are called during the initialization of the coupled system, some during the run of the coupled system, and some during the finalization of the coupled system.		The ROMS <span class="red">cap</span> module contains a set of subroutines that are required by '''NUOPC'''. According to a predefined calling sequence, these subroutines are called by the '''NUOPC''' infrastructure. Some subroutines are called during the initialization of the coupled system, some during the run of the coupled system, and some during the finalization of the coupled system.

	The initialization sequence is the most complex and is governed by the '''NUOPC''' technical rules. Details about the initialization sequence can be found in the '''NUOPC''' Reference Manual. The ROMS <span class="red">cap</span> requires '''ESMF version 8 or higher'''.		The initialization sequence is the most complex and is governed by the '''NUOPC''' technical rules. Details about the initialization sequence can be found in the '''NUOPC''' Reference Manual. The ROMS <span class="red">cap</span> requires '''ESMF version 8 or higher'''.


	:{\| border="1" cellspacing="0" cellpadding="5" width="1000"		:{\| border="1" cellspacing="0" cellpadding="5" width="1000"
Line 119:		Line 120:

	:{\| border="1" cellspacing="0" cellpadding="5" align="left"		:{\| border="1" cellspacing="0" cellpadding="5" align="left"
	\| align="center" \| '''NUOPC''' ~~<span class="red">cap</span>~~		\| align="center" \| '''ESMF/NUOPC Modules'''
	\| align="center" \| '''Tested'''		\| align="center" \| '''Tested'''
	\|style="width: ~~600px~~;" align="center" \| '''Description'''		\|style="width: 700px;" align="center" \| '''Description'''
			\|-
			\| <span class="red">Master/esmf_driver.h</span>
			\| <span class="forestGreen">yes</span>
			\| '''ESMF/NUOPC''' Master Driver
			\|-
			\| <span class="red">Master/esmf_esm.F</span>
			\| <span class="forestGreen">yes</span>
			\| Sets '''ESMF/NUOPC''' '''Services''' and '''RunSequence''' for each coupled component
			\|-
			\| <span class="red">Master/esmf_coupler.h</span>
			\| <span class="forestGreen">yes</span>
			\| '''Computes''', '''Execute''', and '''Release''' the '''Connectors''' between <span class="violet">source</span> and <span class="violet">destination</span> fields
			\|-
			\| <span class="red">Master/mod_esmf_esm.h</span>
			\| <span class="forestGreen">yes</span>
			\| Defines framework object '''structures''' and '''variables''' and includes support routines
	\|-		\|-
	\| <span class="blue">Master/esmf_atm_coamps.h</span>		\| <span class="blue">Master/esmf_atm_coamps.h</span>
	\| yes		\| <span class="forestGreen">yes</span>
			\| Coupled Ocean-Atmosphere Mesoscale Prediction System ('''COAMPS''')
			\|-
			\| <span class="blue">Master/esmf_atm_coamps.h</span>
			\| <span class="forestGreen">yes</span>
	\| Coupled Ocean-Atmosphere Mesoscale Prediction System ('''COAMPS''')		\| Coupled Ocean-Atmosphere Mesoscale Prediction System ('''COAMPS''')
	\|-		\|-
	\| <span class="blue">Master/esmf_atm_regcm.h</span>		\| <span class="blue">Master/esmf_atm_regcm.h</span>
	\| no		\| <span class="red">no</span>
	\| ICTP Regional Climate Model (Version 4.5~~) ('''RegCM~~''')		\| ICTP Regional Climate Model ('''RegCM''', Version '''4.5''')
	\|-		\|-
	\| <span class="blue">Master/esmf_atm_wrf.h</span>		\| <span class="blue">Master/esmf_atm_wrf.h</span>
	\| yes		\| <span class="forestGreen">yes</span>
	\| Weather Research and Forecasting model ('''WRF''')		\| Weather Research and Forecasting model ('''WRF''')
	\|-		\|-
	\| <span class="blue">Master/esmf_data.F</span>		\| <span class="blue">Master/esmf_data.F</span>
	\| yes		\| <span class="forestGreen">yes</span>
	\| Generic '''DATA''' component		\| Generic '''DATA''' component via '''NetCDF''' files
	\|-		\|-
	\| <span class="blue">Master/esmf_ice_cice.h</span>		\| <span class="blue">Master/esmf_ice_cice.h</span>
	\| no		\| <span class="red">no</span>
	\| Los Alamos Sea Ice Model ('''CICE''')		\| Los Alamos Sea Ice Model ('''CICE''')
	\|-		\|-
	\| <span class="blue">Master/esmf_roms.F</span>		\| <span class="blue">Master/esmf_roms.F</span>
	\| yes		\| <span class="forestGreen">yes</span>
	\| Regional Ocean Modeling System ('''ROMS''')		\| Regional Ocean Modeling System ('''ROMS''')
	\|-		\|-
	\| <span class="blue">Master/esmf_wav_wam.h</span>		\| <span class="blue">Master/esmf_wav_wam.h</span>
	\| no		\| <span class="red">no</span>
	\| ECMWF's Wave Model ('''WAM''')		\| ECMWF's Wave Model ('''WAM''')
	\|-		\|-
	\| <span class="blue">Master/esmf_wav_ww3.h</span>		\| <span class="blue">Master/esmf_wav_ww3.h</span>
	\| no		\| <span class="red">no</span>
	\| WaveWatch III ('''WW3'''), <span class="~~forestGreen~~">under development</span>		\| WaveWatch III ('''WW3'''), <span class="twilightBlue">under development</span>
	\|}		\|}
	<div style="clear: both"></div>		<div style="clear: both"></div>


	==Import and Export Fields==		==Import and Export Fields==

Arango: /* Import and Export Fields */

2022-05-04T01:42:19Z

Import and Export Fields

← Older revision		Revision as of 01:42, 4 May 2022
Line 164:		Line 164:
	The '''ESMF/NUOPC''' library version '''8.0.0''' or higher supports native nesting capabilities. The '''NUOPC''' layer now allows coupling sets in the <span class="red">import</span> and <span class="red">export</span> states of the '''ESM''' components. A nested grid is represented as another '''ESMF_Grid''' object so that a coupled model can have a set of telescoping meshes of decreasing spatial resolution. The '''NUOPC''' connector can recognize the different grids and exchange fields to a connected '''ESM''' component. Various types of connections are possible, like nest-to-nest, fine-to-coarse, or coarse-to-fine. The user decides which nested grids to connect. The <span class="blue">NUOPC_AddNestedState</span> routine is used to advertise the nested couple sets.		The '''ESMF/NUOPC''' library version '''8.0.0''' or higher supports native nesting capabilities. The '''NUOPC''' layer now allows coupling sets in the <span class="red">import</span> and <span class="red">export</span> states of the '''ESM''' components. A nested grid is represented as another '''ESMF_Grid''' object so that a coupled model can have a set of telescoping meshes of decreasing spatial resolution. The '''NUOPC''' connector can recognize the different grids and exchange fields to a connected '''ESM''' component. Various types of connections are possible, like nest-to-nest, fine-to-coarse, or coarse-to-fine. The user decides which nested grids to connect. The <span class="blue">NUOPC_AddNestedState</span> routine is used to advertise the nested couple sets.

	For example, the ROMS '''NOUPC''' <span class="red">cap</span> module routine <span class="blue">ROMS_SetInitializeP1</span> illustrates how easily the coupled sets is added to the ImportState and ExportState as shown below in the green blocks of code.		For example, the ROMS '''NOUPC''' <span class="red">cap</span> module routine <span class="blue">ROMS_SetInitializeP1</span> illustrates how easily the coupled sets is added to the <span class="red">ImportState</span> and <span class="red">ExportState</span> as shown below in the green blocks of code.


	{\|cellpadding="3"		{\|cellpadding="3"

Arango: /* Import and Export Fields */

2022-05-04T01:41:12Z

Import and Export Fields

← Older revision		Revision as of 01:41, 4 May 2022
Line 156:		Line 156:
	\|}		\|}
	<div style="clear: both"></div>		<div style="clear: both"></div>


	==Import and Export Fields==		==Import and Export Fields==

Arango: /* Capabilities */

2022-05-04T01:39:35Z

Capabilities

← Older revision		Revision as of 01:39, 4 May 2022
Line 150:		Line 150:
	\| no		\| no
	\| ECMWF's Wave Model ('''WAM''')		\| ECMWF's Wave Model ('''WAM''')
			\|-
			\| <span class="blue">Master/esmf_wav_ww3.h</span>
			\| no
			\| WaveWatch III ('''WW3'''), <span class="forestGreen">under development</span>
	\|}		\|}
	<div style="clear: both"></div>		<div style="clear: both"></div>


	==Import and Export Fields==		==Import and Export Fields==

Arango: /* Import and Export Fields */

2022-05-04T01:36:04Z

Import and Export Fields

← Older revision		Revision as of 01:36, 4 May 2022
Line 152:		Line 152:
	\|}		\|}
	<div style="clear: both"></div>		<div style="clear: both"></div>


	==Import and Export Fields==		==Import and Export Fields==