SMS:ADCIRC Graphical Interface: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 11: Line 11:
#* Boundary Conditions coverage
#* Boundary Conditions coverage
#* Recording Stations coverage
#* Recording Stations coverage
#* Pipes coverage
#* Wind Stations coverage
#* Wind Stations coverage
Multiple ADCIRC simulations can be included in a single project.
Multiple ADCIRC simulations can be included in a single project.
Line 17: Line 16:
===Simulation Components===
===Simulation Components===
An ADCIRC simulation uses the following components in the model run:
An ADCIRC simulation uses the following components in the model run:
* 2D mesh – Any generic 2D mesh will work. Generally this mesh should be created from the Generic Mesh coverage.
* 2D mesh – Any generic 2D mesh will work. Generally this mesh should be created from the Mesh Generation coverage.
* Boundary Conditions coverage – Contains arcs defining the boundary condition attributes for the model run.
* Boundary Conditions coverage – Contains arcs defining the boundary condition attributes for the model run.
* Recording Stations coverage –  
* Recording Stations coverage – Allows creating recording stations at specified nodal locations.
* Pipes coverage –
* Wind Stations coverage –  
* Wind Stations coverage –  
*Tidal forcing component


Each component can be added to the simulation by selecting the component and dragging it under the simulation item [[File:Simulation Icon.svg|16 px]] in the Project Explorer. Linked 2D mesh [[File:Mesh Link.svg|16 px]] and coverages [[File:Coverage Link.svg|16 px]] will be displayed under the simulation.
Each component can be added to the simulation by selecting the component and dragging it under the simulation item [[File:Simulation Icon.svg|16 px]] in the Project Explorer. Linked 2D mesh [[File:Mesh Link.svg|16 px]] and coverages [[File:Coverage Link.svg|16 px]] will be displayed under the simulation.
===Tidal Components===
[[File:ADCIRC TidalConstituents.png|thumb|350 px|The ADCIRC ''Tidal Constituents'' dialog]]
Tidal constituents are defined as a simulation that is applied to an ADCIRC simulation. A tidal component created by doing the following:
#In the Project Explorer, right-click in an empty space and select ''New Simulation'' | '''Tidal Constituents'''.
A new "[[File:Simulation Icon.svg|16 px]] Tidal Constituents" simulation will appear in the Project Explorer. This component can be renamed if desired.
[[SMS:ADCIRC Tidal Constituents|Tidal constituents]] attributes are defined in the ''Tidal Constituents'' dialog. To access this dialog:
#In the Project Explorer, right-click on the tidal constituents component and select '''Edit Constituents'''.
The ''Tidal Constituents'' dialog has the following options:
*''Source'' – Select a source database to use. Options include:
**"ADCIRC2015"
**"LeProvost"
**"FES2014"
**"TPX09"
**"TPX09"
**"User Defined"
*''Reference Time'' – Enter a start time for the tidal constituents.
*''Constituents'' – Contains a list of available constituents. The list varies depending on the selected source.
**'''Select All''' – Checks on all constituents in the list.
**'''Clear All''' – Checks off all constituents in the list.
**'''Select Minor''' – Checks on the minor tidal constituent group.
**'''Select Major''' – Checks on the major tidal constituent group.
After the tidal constituents have been defined in the simulation, the tidal simulation needs to be applied to the ADCIRC simulation. Do this by right-clicking and using the ''Apply To'' submenu commands.


===Linking Components===
===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 ADCIRC simulation. A link ([[File:Coverage Link.svg|16 px]] or [[File:Mesh Link.svg|16 px]]) 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.  
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 ADCIRC simulation. A link ([[File:Mesh Link.svg|16 px]] or [[File:TUFLOW Component Icon.svg|16 px]]) is then created between the component and the simulation.  
 
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 ''Apply To'' submenu.  The ''Apply To'' submenu becomes available once a simulation has been created.
 
Components can be removed by right-clicking on the component link under the simulation and select '''Remove'''.
 
If a component is updated, it must be reapplied to the simulation.


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 ADCIRC Simulation ===
=== Running the ADCIRC 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 ADCIRC''' command or the '''Save, Export, and Launch ADCIRC''' command.
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 '''Run Simulation''' command or the '''Save and Run Simulation''' command.


The simulation run involves three steps.  
The simulation run involves three steps.  
# Exporting the ADCIRC files – SMS writes out an ADCIRC folder in the same directory where the SMS project is saved. The ADCIRC folder has several files which have mesh geometry information, and boundary conditions as well as model control information defined in the model.  
# Exporting the ADCIRC files – SMS writes out an ADCIRC folder in the same directory where the SMS project is saved. The ADCIRC folder has several files which have mesh geometry information, and boundary conditions as well as model control information defined in the model.  
# Running ADCIRC – .
# Running ADCIRC – 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.
 
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.
The ''Load solution'' button appears with the model run has finished. Clicking this button will load the solution into SMS.
Line 47: Line 74:
*Boundary Condition
*Boundary Condition
*Recording Stations
*Recording Stations
*Pipes
*Wind Stations
*Wind Stations
=== Boundary Conditions ===
=== Boundary Conditions ===

Latest revision as of 21:15, 9 February 2023

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

ADCIRC Simulation

Example of an ADCIRC simulation in the Project Explorer

Simulations are available for ADCIRC starting in SMS 13.0. A simulation should contain a 2D mesh and an ADCIRC boundary conditions coverage, and optional ADCIRC 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 | ADCIRC. 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 mesh
    • Boundary Conditions coverage
    • Recording Stations coverage
    • Wind Stations coverage

Multiple ADCIRC simulations can be included in a single project.

Simulation Components

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

  • 2D mesh – Any generic 2D mesh will work. Generally this mesh should be created from the Mesh Generation coverage.
  • Boundary Conditions coverage – Contains arcs defining the boundary condition attributes for the model run.
  • Recording Stations coverage – Allows creating recording stations at specified nodal locations.
  • Wind Stations coverage –
  • Tidal forcing component

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 mesh Mesh Link.svg and coverages Coverage Link.svg will be displayed under the simulation.

Tidal Components

The ADCIRC Tidal Constituents dialog

Tidal constituents are defined as a simulation that is applied to an ADCIRC simulation. A tidal component created by doing the following:

  1. In the Project Explorer, right-click in an empty space and select New Simulation | Tidal Constituents.

A new "Simulation Icon.svg Tidal Constituents" simulation will appear in the Project Explorer. This component can be renamed if desired.

Tidal constituents attributes are defined in the Tidal Constituents dialog. To access this dialog:

  1. In the Project Explorer, right-click on the tidal constituents component and select Edit Constituents.

The Tidal Constituents dialog has the following options:

  • Source – Select a source database to use. Options include:
    • "ADCIRC2015"
    • "LeProvost"
    • "FES2014"
    • "TPX09"
    • "TPX09"
    • "User Defined"
  • Reference Time – Enter a start time for the tidal constituents.
  • Constituents – Contains a list of available constituents. The list varies depending on the selected source.
    • Select All – Checks on all constituents in the list.
    • Clear All – Checks off all constituents in the list.
    • Select Minor – Checks on the minor tidal constituent group.
    • Select Major – Checks on the major tidal constituent group.

After the tidal constituents have been defined in the simulation, the tidal simulation needs to be applied to the ADCIRC simulation. Do this by right-clicking and using the Apply To submenu commands.

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 ADCIRC simulation. A link (Mesh Link.svg or TUFLOW Component Icon.svg) is then created between the component and the simulation.

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 Apply To submenu. The Apply To submenu becomes available once a simulation has been created.

Components can be removed by right-clicking on the component link under the simulation and select Remove.

If a component is updated, it must be reapplied to the simulation.

Running the ADCIRC 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 Run Simulation command or the Save and Run Simulation command.

The simulation run involves three steps.

  1. Exporting the ADCIRC files – SMS writes out an ADCIRC folder in the same directory where the SMS project is saved. The ADCIRC folder has several files which have mesh geometry information, and boundary conditions as well as model control information defined in the model.
  2. Running ADCIRC – 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.

ADCIRC Menus

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

ADCIRC Map Coverages

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

  • Boundary Condition
  • Recording Stations
  • Wind Stations

Boundary Conditions

All numeric models require boundary condition data. The ADCIRC boundary condition coverage is used to apply boundary condition data to the simulation.

Model Control

The ADCIRC 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.

Related Topics