SMS:ESMF - Earth System Modeling Framework: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TOCright}}
{{TOCright}}
The [http://www.esmf.ucar.edu/ Earth System Modeling Framework (ESMF)] is used to couple the following Models:  
The [https://www.earthsystemcog.org/projects/esmf/ Earth System Modeling Framework (ESMF)] is used to couple the following models:  
* [[SMS:ADCIRC|ADCIRC]] – [[SMS:STWAVE|STWAVE]]  
* [[SMS:ADCIRC|ADCIRC]] – [[SMS:STWAVE|STWAVE]]  
To create a coupled simulation using ESMF, perform the following steps:  
To create a coupled simulation using ESMF, perform the following steps:  
* Right-click in the [[SMS:Project Explorer|Project Explorer]]  
# Right-click in the [[SMS:Project Explorer|Project Explorer]].
* Choose the menu ''New Simulation'' | '''Hurricane'''  
# Choose the menu ''New Simulation'' | '''Hurricane''' .
* Change the simulation name if desired  
# Change the simulation name if desired .
* Create the elements to be include in the simulation and drag tree pointers representing them into the simulation. The following items can be linked to an Hurricane simulation:  
# Create the elements to be include in the simulation and drag tree pointers representing them into the simulation. The following items can be linked to an Hurricane simulation:  
* ADCIRC – STWAVE  
#* ADCIRC – STWAVE  
<blockquote>
#** ADCIRC Mesh  
* ADCIRC Mesh  
#** STWAVE Grid  
* STWAVE Grid  
#** Hurricane Coverage  
* Hurricane Coverage  
#** PBL Wind Coverage  
* PBL Wind Coverage  
#** WAM Simulation
* WAM Simulation </blockquote>
# Right-click on the Hurricane simulation in the [[SMS:Project Explorer|Project Explorer]].
* Right-click on the Hurricane simulation in the [[SMS:Project Explorer|Project Explorer]]  
# Choose the menu '''Properties'''. This action will create a new Hurricane coverage containing polygons that identify overlapping grid sections and areas of interest defined. It will then bring up a'' Hurricane Mode Project Summary'' property sheet containing four tabbed dialogs.  
* Choose the menu '''Properties'''. This action will create a new Hurricane coverage containing polygons that identify overlapping grid sections and areas of interest defined by the user. It will then bring up a'' Hurricane Mode Project Summary'' property sheet containing four tabbed dialogs.  
#* Overview  
<blockquote>
#* ESMF  
* Overview  
#* Spatial View  
* ESMF  
#* Timeline  
* Spatial View  
# Right-click on the ESMF simulation and choose '''Export ESMF Files'''. SMS will create a folder named ESMF in the same directory as the *.sms file of the current project. Inside of the ESMF folder will be a folder and input files for the ESMF Simulation. The ESMF simulation folder name will be the same as the name given to the ESMF simulations in the Project Explorer.  
* Timeline </blockquote>
* Right-click on the ESMF simulation and choose '''Export ESMF Files'''. SMS will create a folder named ESMF in the same directory as the .sms file of the current project. Inside of the ESMF folder will be a folder and input files for the ESMF Simulation. The ESMF Simulation folder name will be the same as the name given to the ESMF Simulations in the ''Project Explorer''.  


==ESMF Hurricane Overview==
==ESMF Hurricane Overview==
The dialog gives an overview of the components of the Hurricane simulation. It also allows the user to designate the number of processors to be use by each model in the simulation.  
The dialog gives an overview of the components of the Hurricane simulation. It also allows designating the number of processors to be use by each model in the simulation.  
* Simulation Name &ndash; Name of the Hurricane simulation as set in the project explore
* Simulation Name &ndash; Name of the Hurricane simulation as set in the Project Explorer.
* Properties &ndash; Properties of the Hurricane simulation  
* Properties &ndash; Properties of the Hurricane simulation .
<blockquote>
** Model Name &ndash; Name of models found in the simulation.
* Model Name &ndash; Name of models found in the simulation  
*** ADCIRC <mesh name> (1 required) &ndash; Name of the adcirc mesh used in the hurricane simulation.  
<blockquote>
*** STWAVE <grid name> (1 required) &ndash; Name of the stwave cgrid used in the hurricane simulation.  
* ADCIRC <mesh name> (1 required) &ndash; Name of the adcirc mesh used in the hurricane simulation.  
*** PBL <pbl cov name> (optional) &ndash; Name of pbl wind coverage used in the hurricane simulation.  
* STWAVE <grid name> (1 required) &ndash; Name of the stwave cgrid used in the hurricane simulation.  
*** WAM <wam sim name> (optional) &ndash; Name of wam simulation used in the hurricane simulation.  
* PBL <pbl cov name> (optional) &ndash; Name of pbl wind coverage used in the hurricane simulation.  
* WAM <wam sim name> (optional) &ndash; Name of wam simulation used in the hurricane simulation. </blockquote></blockquote>
* Projection &ndash; Projection type of model.  
* Projection &ndash; Projection type of model.  
<blockquote>
** Geo &ndash; Geographic (Latitude/Longitude)  
* Geo &ndash; Geographic (Latitude/Longitude)  
** STPL <#> &ndash; State Plane number .
* STPL <#> &ndash; State Plane number  
** Other &ndash; Other type of projection .
* Other &ndash; Other type of projection  
</blockquote>
* Start Time &ndash; Temporal starting time of model.  
* Start Time &ndash; Temporal starting time of model.  
* End Time &ndash; Temporal ending time of model.  
* End Time &ndash; Temporal ending time of model.  
* Threads &ndash; Number of processor threads used by model for computation or I/O processing.  
* Threads &ndash; Number of processor threads used by model for computation or I/O processing.  
* Function &ndash; Function used to adjust the processor threads used by each model.
* Function &ndash; Function used to adjust the processor threads used by each model.
<blockquote>
** Set Threads &ndash; Set the number of processor threads for:  
* Set Threads &ndash; Set the number of processor threads for:  
*** Computational or I/O processing (ADCIRC).
<blockquote>
*** Grid Partition I and J processing (STWAVE).
* Computational or I/O processing (ADCIRC)  
** NONE &ndash; WAM and PBL use only one processor thread.
* Grid Partition I and J processing (STWAVE) </blockquote>
* NONE &ndash; WAM and PBL use only one processor thread.</blockquote>


==Hurricane ESMF==
==Hurricane ESMF==
* Set the ESMF simulation options in the ''Data Exchange'' and ''Area Mapping'' sections of the dialog  
Set the ESMF simulation options in the ''Data Exchange'' and ''Area Mapping'' sections of the dialog  
<blockquote>
* Data Exchange  
* Data Exchange  
<blockquote>
** Model A &ndash; The meshed based model to be use (hard-coded to ADCIRC).
* Model A &ndash; The meshed based model to be use (hard-coded to ADCIRC)  
** Data Exchange &ndash; Controls how data is exchanged between the two models (&harr; bi-directional, &rarr; uni-direction A to B, &larr; uni-directional B to A).
* Data Exchange &ndash; Controls how data is exchanged between the two models (&harr; bi-directional, &rarr; uni-direction A to B, &larr; uni-directional B to A)  
** Model B &ndash; The grid based model to be use (hard-coded to STWAVE).
* Model B &ndash; The grid based model to be use (hard-coded to STWAVE)  
** Model A &rarr; B &ndash; How frequently the results of Model A are passed to Model B.
* Model A &rarr; B &ndash; How frequently the results of Model A are passed to Model B  
** Units &ndash; Frequency units for A to B exchange (days/hours/minutes/seconds).
* Units &ndash; Frequency units for A to B exchange (days/hours/minutes/seconds)  
** Model A &larr; B &ndash; How frequently the results of Model B are passed to Model A.
* Model A &larr; B &ndash; How frequently the results of Model B are passed to Model A  
** Units &ndash; Frequency units for B to A exchange (days/hours/minutes/seconds).
* Units &ndash; Frequency units for B to A exchange (days/hours/minutes/seconds) </blockquote> </blockquote>
* Area Mapping  
* Area Mapping  
<blockquote>
** ID &ndash; Polygon identifier correlated to the ids visible in the main graphics window.  
* ID &ndash; Polygon identifier correlated to the ids visible in the main graphics window.  
** Mapping  
* Mapping  
*** Single &ndash; Model A exchanges data with a single instance of Model B.
<blockquote>
*** Combined &ndash; Model A exchanges data with multiple instances of Model B. Model A can receive either the average or maximum values from the instances of Model B.  
* Single &ndash; Model A exchanges data with a single instance of Model B  
** Option &ndash; If the "Mapping" field is set to "Single" and multiple grids overlap the identified polygon, this field allows selecting which grid will be used. If the "Mapping" field is set to "Combined", this field select how the data from the grids will be combined (Average or Maximum).
* Combined &ndash; Model A exchanges data with multiple instances of Model B. Model A can receive either the average or maximum values from the instances of Model B.  
</blockquote>
* Option &ndash; If the "Mapping" field is set to "Single" and multiple grids overlap the identified polygon, this field allows the user to select which grid will be used. If the "Mapping" field is set to "Combined", this field allows the user to select how the data from the grids will be combined (Average or Maximum.)</blockquote>


==Hurricane Spatial View==
==Hurricane Spatial View==
Line 81: Line 68:
==Related Topics==  
==Related Topics==  
* [[SMS:Model Specific Coverages|Model Specific Coverages]]
* [[SMS:Model Specific Coverages|Model Specific Coverages]]
* [[SMS:CSTORM-MS|CSTORM-MS]]
* [[SMS:Steering|Steering]]
* [[SMS:Steering|Steering]]


Line 89: Line 75:
[[Category:SMS Coverages|E]]
[[Category:SMS Coverages|E]]
[[Category:SMS Map|E]]
[[Category:SMS Map|E]]
[[Category:External Links]]

Latest revision as of 21:59, 27 November 2017


The Earth System Modeling Framework (ESMF) is used to couple the following models:

To create a coupled simulation using ESMF, perform the following steps:

  1. Right-click in the Project Explorer.
  2. Choose the menu New Simulation | Hurricane .
  3. Change the simulation name if desired .
  4. Create the elements to be include in the simulation and drag tree pointers representing them into the simulation. The following items can be linked to an Hurricane simulation:
    • ADCIRC – STWAVE
      • ADCIRC Mesh
      • STWAVE Grid
      • Hurricane Coverage
      • PBL Wind Coverage
      • WAM Simulation
  5. Right-click on the Hurricane simulation in the Project Explorer.
  6. Choose the menu Properties. This action will create a new Hurricane coverage containing polygons that identify overlapping grid sections and areas of interest defined. It will then bring up a Hurricane Mode Project Summary property sheet containing four tabbed dialogs.
    • Overview
    • ESMF
    • Spatial View
    • Timeline
  7. Right-click on the ESMF simulation and choose Export ESMF Files. SMS will create a folder named ESMF in the same directory as the *.sms file of the current project. Inside of the ESMF folder will be a folder and input files for the ESMF Simulation. The ESMF simulation folder name will be the same as the name given to the ESMF simulations in the Project Explorer.

ESMF Hurricane Overview

The dialog gives an overview of the components of the Hurricane simulation. It also allows designating the number of processors to be use by each model in the simulation.

  • Simulation Name – Name of the Hurricane simulation as set in the Project Explorer.
  • Properties – Properties of the Hurricane simulation .
    • Model Name – Name of models found in the simulation.
      • ADCIRC <mesh name> (1 required) – Name of the adcirc mesh used in the hurricane simulation.
      • STWAVE <grid name> (1 required) – Name of the stwave cgrid used in the hurricane simulation.
      • PBL <pbl cov name> (optional) – Name of pbl wind coverage used in the hurricane simulation.
      • WAM <wam sim name> (optional) – Name of wam simulation used in the hurricane simulation.
  • Projection – Projection type of model.
    • Geo – Geographic (Latitude/Longitude)
    • STPL <#> – State Plane number .
    • Other – Other type of projection .
  • Start Time – Temporal starting time of model.
  • End Time – Temporal ending time of model.
  • Threads – Number of processor threads used by model for computation or I/O processing.
  • Function – Function used to adjust the processor threads used by each model.
    • Set Threads – Set the number of processor threads for:
      • Computational or I/O processing (ADCIRC).
      • Grid Partition I and J processing (STWAVE).
    • NONE – WAM and PBL use only one processor thread.

Hurricane ESMF

Set the ESMF simulation options in the Data Exchange and Area Mapping sections of the dialog

  • Data Exchange
    • Model A – The meshed based model to be use (hard-coded to ADCIRC).
    • Data Exchange – Controls how data is exchanged between the two models (↔ bi-directional, → uni-direction A to B, ← uni-directional B to A).
    • Model B – The grid based model to be use (hard-coded to STWAVE).
    • Model A → B – How frequently the results of Model A are passed to Model B.
    • Units – Frequency units for A to B exchange (days/hours/minutes/seconds).
    • Model A ← B – How frequently the results of Model B are passed to Model A.
    • Units – Frequency units for B to A exchange (days/hours/minutes/seconds).
  • Area Mapping
    • ID – Polygon identifier correlated to the ids visible in the main graphics window.
    • Mapping
      • Single – Model A exchanges data with a single instance of Model B.
      • Combined – Model A exchanges data with multiple instances of Model B. Model A can receive either the average or maximum values from the instances of Model B.
    • Option – If the "Mapping" field is set to "Single" and multiple grids overlap the identified polygon, this field allows selecting which grid will be used. If the "Mapping" field is set to "Combined", this field select how the data from the grids will be combined (Average or Maximum).

Hurricane Spatial View

This dialog provides a view of any grid boundaries (WAM and STWAVE), grid frames (PBL), and the ADCIRC mesh boundary associated with the simulation.

Hurricane Timeline

This dialog displays the timelines for each simulation (WAM, STWAVE, PBL, and ADCIRC) that are part of the hurricane simulation. The start and end times need to be set for each simulation individually.

Related Topics