User:Jcreer/SMS:STWAVE Graphical Interface in SMS 13.0

From XMS Wiki
< User:Jcreer
Revision as of 22:20, 23 October 2018 by Jcreer (talk | contribs) (→‎STWAVE Map Coverages)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

The STWAVE graphical interface includes tools to assist with creating, editing and debugging an STWAVE model.

STWAVE Simulation

Example of an ADCIRC simulation in the Project Explorer

Simulations are available for STWAVE starting in SMS 13.0. A simulation should contain a 2D grid and a spectral coverage, and optional STWAVE coverages. Right-clicking on the simulation will display options and dialogs.

To create a new simulation:

  1. Right-click on empty space in the Project Explorer and select New Simulation | STWAVE. A new tree item Simulation Folder Icon.svg will appear.
  2. Drag and drop simulation components under the newly created simulation tree item Simulation Icon.svg. Components available include:
    • 2D grid
    • Spectral coverage
    • Monitoring Cells coverage
    • Nesting Points coverage

Multiple STWAVE simulations can be included in a single project.

Simulation Components

An STWAVE simulation uses the following components in the model run:

  • 2D grid – Any generic Cartesian grid will work. Generally this mesh should be created from the CGrid Generator coverage.
  • Spectral coverage – Contains arcs defining the boundary condition attributes for the model run.
  • Monitoring Cells coverage –
  • Nesting Points coverage –

Each component can be added to the simulation by selecting the component and dragging it under the simulation item Simulation Icon.svg in the Project Explorer. Linked 2D grid Mesh Link.svg and coverages Coverage Link.svg will be displayed under the simulation.

Linking Components

After a simulation has been created, components may be added to the simulation. Components are usually added by clicking on the component item in the Project Explorer and dragging the item under the STWAVE simulation. A link (Coverage Link.svg or Mesh Link.svg) is then created between the component and the simulation. If the component is updated, it is updated automatically in all simulations that are linked to it.

Components can also be added to a simulation by right-clicking on the component in the project explorer and selecting the simulation name in the Link To submenu. Similarly, components can be unlinked from a simulation by right-clicking on the component and selecting the simulation name in the Unlink From submenu. The Link To and Unlink From submenus become available once a simulation has been created.

Running the STWAVE Simulation

After all components have been added to the simulation and the model parameters have been established, the simulation can be run. This is done by right-clicking on the simulation and choosing the Launch STWAVE command or the Save, Export, and Launch STWAVE command.

The simulation run involves three steps.

  1. Exporting the STWAVE files – SMS writes out an STWAVE folder in the same directory where the SMS project is saved. The STWAVE folder has several files which have mesh geometry information, and boundary conditions as well as model control information defined in the model.
  2. Running STWAVE – .

After using a launch command, the Simulation Run Queue dialog will appear. If there are any errors in the model run, the model wrapper will exit early. The model run can also be exited early by clicking the Abort button. When the model run is completed, select Exit to close the model wrapper.

The Load solution button appears with the model run has finished. Clicking this button will load the solution into SMS.


STWAVE makes use of a number of right-click menus found on the STWAVE simulation items and coverages in the Project Explorer. See STWAVE Menu for more information.

STWAVE Map Coverages

STWAVE makes use of map coverage to define certain features and components for the STWAVE model run. Available coverage types include:


An STWAVE simulation requires a Spectral coverage. This coverage contains all spectral data for the simulation. Spectral data is organized by date and time. For more information, see Spectral Coverage and Spectral Events.

Monitoring Cells

Points placed on the Monitoring Cells coverage will designate the matching cell on the grid as a monitoring station. Spectral output will be generated for each point during the simulation model run. This coverage is optional.

Nesting Points

Points placed on the Nesting Points coverage will be corresponded to cells in the simulation grid. Spectral output will be generated from this points for use as input for a nested child grid. This coverage is optional.

Model Control

The STWAVE Model Control dialog is used to setup the options that apply to the simulation as a whole. These options include time controls, run types, output options, global parameters, print options and other global settings.

Visualizing Results

The solution files for STWAVE are XMDF files. These files can be opened in the normal SMS interface. To view the observation or nesting spectral output simply open the files (outside of the Spectral Energy dialog), open the Spectral Energy dialog, and select the spectral grid. This will open the spectral grid for viewing in the Spectral Energy dialog. Make sure to set the original grid back before leaving the dialog to ensure the model does not change.

Related Topics