SMS:ADCIRC Graphical Interface: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
Line 1: Line 1:
The [[SMS:ADCIRC|ADCIRC]] Graphical Interface includes tools to assist with creating, editing and debugging an [[SMS:ADCIRC|ADCIRC]] model. The [[SMS:ADCIRC|ADCIRC]] interface exists in the [[SMS:Mesh Module|2D Mesh Module]].
The [[SMS:ADCIRC|ADCIRC]] graphical interface includes tools to assist with creating, editing and debugging an [[SMS:ADCIRC|ADCIRC]] model.


=== Model Control ===
==ADCIRC Simulation==
The [[SMS:ADCIRC Model Control|''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.
[[File:ADCIRC Simulation.png|thumb|175 px|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:
# Right-click on empty space in the Project Explorer and select ''New Simulation'' | '''ADCIRC'''. A new tree item [[File:Simulation Folder Icon.svg|16 px]] will appear.
# Drag and drop simulation components under the newly created simulation tree item [[File:Simulation Icon.svg|16 px]]. Components available include:
#* 2D mesh
#* Boundary Conditions coverage
#* Recording Stations coverage
#* Pipes 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 Generic Mesh coverage.
* Boundary Conditions coverage – Contains arcs defining the boundary condition attributes for the model run.
* Recording Stations coverage –
* Pipes coverage –
* Wind Stations coverage –
 
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.
 
===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.
 
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 ===
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.
 
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.
# Running ADCIRC – .  


=== Boundary Conditions ===
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.
All numeric models require boundary condition data. In [[SMS:ADCIRC|ADCIRC]] [[SMS:ADCIRC Boundary Conditions|boundary conditions]] are defined on [[SMS:ADCIRC Boundary Conditions | nodestrings]]. The default boundary condition is a closed boundary (no flow). See [[SMS:ADCIRC Boundary Conditions|ADCIRC BC Nodestrings]] for more information.


=== Running the Model ===
The ''Load solution'' button appears with the model run has finished. Clicking this button will load the solution into SMS.
The [[SMS:ADCIRC|ADCIRC]] files are written automatically with the SMS project file or can be saved separately using the [[SMS:ADCIRC#Saving ADCIRC|''File'' | '''Save ADCIRC''']] or ''File'' | '''Save As''' menu commands. See [[SMS:ADCIRC Files|ADCIRC Files]] for more information on the files used for the [[SMS:ADCIRC|ADCIRC]] run.


[[SMS:ADCIRC|ADCIRC]] can be launched from SMS using the ''ADCIRC'' | '''Run ADCIRC''' menu command. A check of some of the common problems called the Model Checker is done each time the model is launched, or by selecting the ''ADCIRC'' | '''Model Check''' menu command.
==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 [[SMS:ADCIRC Menu|ADCIRC Menu]] for more information.


==ADCIRC Menu==
==ADCIRC Map Coverages==
See [[SMS:ADCIRC Menu|ADCIRC Menu]] for more information.
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
*Pipes
*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 [[SMS:ADCIRC Model Control|''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 ==
== Related Topics ==
Line 29: Line 69:


[[Category:ADCIRC|G]]
[[Category:ADCIRC|G]]
[[Category:SMS Simulations|A]]

Revision as of 17:14, 20 November 2018

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
    • Pipes 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 Generic Mesh coverage.
  • Boundary Conditions coverage – Contains arcs defining the boundary condition attributes for the model run.
  • Recording Stations coverage –
  • Pipes coverage –
  • Wind Stations 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 mesh 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 ADCIRC 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 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.

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
  • Pipes
  • 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