SMS:GenCade Graphical Interface: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(43 intermediate revisions by the same user not shown)
Line 1: Line 1:
SMS provides a graphical interface that is designed to allow users to visualize the projects they are creating, easily modify project parameters, and view the solutions produced by the GenCade model.  The GenCade interface exists in the 1D Grid Module.
SMS provides a graphical interface that is designed to visualize the projects being created, easily modify project parameters, and view the solutions produced by the GenCade model.  The GenCade interface exists in the [[SMS:1D Grid Module|1D Grid module]].


A GenCade simulation consists of a geometric definition of the model domain (the grid) and a set of numerical parameters. The parameters define the boundary conditions and options pertinent to the model. To set up a simulation, the modeler can work directly with the 1D grid, but it is much more convenient to work with the conceptual model using a GenCade coverage.
A GenCade simulation consists of a geometric definition of the model domain (the grid) and a set of numerical parameters. The parameters define the boundary conditions and options pertinent to the model. To set up a simulation, the modeler can work directly with the 1D grid, but it is much more convenient to work with the conceptual model using a GenCade coverage.


Work with an existing simulation by selecting the 1D Grid Module. If a grid has already been created for a  GenCade simulation or an existing simulation read, the grid object will exist in the Project Explorer and selecting that object will make the 1D Grid module active and set the model to GenCade.  
Work with an existing simulation by selecting the [[SMS:1D Grid Module|1D Grid module]]. If a grid has already been created for a  GenCade simulation or an existing simulation read, the grid object will exist in the [[SMS:Project Explorer|Project Explorer]] and selecting that object will make the 1D Grid module active and set the model to GenCade.  


The interface consists of the conceptual model tools in the Map Module and the grid specific options in the 1D Grid Module.
The interface consists of the conceptual model tools in the [[SMS:Map Module|Map Module]] and the grid specific options in the [[SMS:1D Grid Module|1D Grid module]].


==Map Module – Conceptual Interface==
==Map Module – Conceptual Interface==
In the map module, the user creates a GenCade coverage (or coverages) that include the information defining the grid and structures in the desired simulation.
In the map module, a GenCade coverage (or coverages) can be created that include the information defining the grid and structures in the desired simulation.
====Grid Frame====
===Grid Frame===
The grid frame defines the orientation and extent that will be occupied by the 1D grid.
The grid frame defines the orientation and extent that will be occupied by the 1D grid. After defining the shorelines and any necessary structures, the grid should be set up. Manually draw the grid frame using the '''Create 1D Grid Frame''' tool. The GenCade grid frame is purple and has an arrow at one end. If a person followed the grid from the end to the arrow, the water should always be to the left and the land should always be to the right.
====Feature Points====
 
For example, if the GenCade grid was oriented from north to south, the water would be to the east (left) and the land would be to the west (right). The grid can be modified by clicking the '''Select 1-D Grid Frame''' tool and double-clicking on the square in the center of the purple grid line.
 
Alternately, the grid options can be changed by selecting the grid frame and use the right-click '''Properties''' command. The [[SMS:Grid Frame Properties|''Grid Frame Properties'']] window will open, and the ''Origin X, Origin Y, Angle,'' and ''I size'' can be modified. The ''I size'' is the length of the grid. ''Angle'' refers to the sign convention in the conceptual model which is degrees counterclockwise from the x axis.
 
This is different from the GenCade model convention (degrees clockwise from north). Therefore, once the map is converted to a 1D grid, the ''Azimuth'' for the grid will be a different value. The cell size can be constant or variable.
 
===Feature Points===
In a GenCade coverage, a feature point can be assigned to be:
In a GenCade coverage, a feature point can be assigned to be:
* A generic place holder
* A generic place holder
* A wave gage – The attributes of this point include a time series of wave data.
* A [[SMS:Wave Gages|wave gage]] – the attributes of this point include a time series of [[SMS:Wave Gages|wave data]].
* A refine point – This point will allow the user to control the grid density in the area of the point.
* A [[SMS:GenCade Refine Point|refine point]] – this point will allow controlling the grid density in the area of the point.
====[[SMS:GenCade Arc Attributes|Feature Arcs]]====
 
The arcs in a GenCade coverage can be assigned a variety of attributes including:
===Feature Arcs===
The [[SMS:GenCade Arc Attributes|arcs]] in a GenCade coverage can be assigned a variety of attributes including:
* Geometric object – shoreline and contours.
* Geometric object – shoreline and contours.
* Structure – jetty, inlet, sea wall, or breakwater and the associated parameters.
* Structure – jetty, inlet, sea wall, or breakwater and the associated parameters.
* Event – bypass or beach nourishment events and their time ranges and parameters.
* Event – bypass or beach nourishment events and their time ranges and parameters.
The conceptual model is converted to a numeric model using the "Map → 1D grid" command.  This command can overwrite an existing simulation or simply add additional structures to an existing simulation.
The conceptual model is converted to a numeric model using the '''Map → 1D Grid''' command.  This command can overwrite an existing simulation or simply add additional structures to an existing simulation.
 
==1D Grid Module – Numerical interface==
The tools in the grid module allow selecting individual structures graphically and change their parameters.  The ''GenCade'' menu allows bringing up tables of all structures of a specific type, view their parameters, and make edits as needed.
===GenCade Menu===
When the GenCade model is active, the ''GenCade'' menu becomes available. See [[SMS:GenCade Menu|GenCade Menu]] for more information.


==1D Grid Module - Numerical interface==
===GenCade Tools===
The tools in the grid module allow the user to select individual structures graphically and change their parameters.  The GenCade menu allows the user to bring up tables of all structures of a specific type, view their parameters, and make edits as needed.
GenCade makes use of the tools in the [[SMS:1D Grid Tools|1D Grid module]]
===Gencade Menu===
* Global Section
** Edit Grid
** Edit Water Level Data
** Edit Wave Data (New for multiple wave inputs)
** Filter Wave Data (This tool was part of the GENESIS interface, but is currently not functional for GenCade)
* Shore Parallel Structures Section
** Breakwaters (Detached breakwaters are temporally invariable at this time)
** Seawalls
* Shore Normal Structures Section
** Groins (was combined Groins/Jetties)
* Shore Feature Section
** Inlets (New – includes an option to specify a jetty at the inlet)
* Events Section
** Beach Fills
** Bypassing
* Management Section
** Model Control
** Run GenCade


==Running the Model==  
==Running the Model==  
The GenCade Files are written automatically with the SMS project file or can be saved separately using the File | Save GenCade or File | Save As menu commands. See GenCade Files for more information on the files used for the GenCade run.  
The GenCade Files are written automatically with the SMS project file or can be saved separately using the ''File'' | '''Save GenCade''' or ''File'' | '''Save As''' menu commands. See [[SMS:GenCade Files|GenCade Files]] for more information on the files used for the GenCade run.  
GenCade can be launched from SMS using the GenCade | Run GenCade menu command.  
 
GenCade can be launched from SMS using the ''GenCade'' | '''Run GenCade''' menu command.


==Related Topics==
==Related Topics==
* [[SMS:GenCade Model Control Dialog|GenCade Model Control Dialog]]
* [[SMS:GenCade Model Control Dialog|GenCade Model Control Dialog]]
* [[SMS:GenCade Result Visualization|GenCade Result Visualization]]
* [[SMS:GenCade Result Visualization|GenCade Result Visualization]]
{{Template:Navbox SMS}}
[[Category:GenCade]]
[[Category:Needs Update]]

Latest revision as of 15:13, 9 April 2019

SMS provides a graphical interface that is designed to visualize the projects being created, easily modify project parameters, and view the solutions produced by the GenCade model. The GenCade interface exists in the 1D Grid module.

A GenCade simulation consists of a geometric definition of the model domain (the grid) and a set of numerical parameters. The parameters define the boundary conditions and options pertinent to the model. To set up a simulation, the modeler can work directly with the 1D grid, but it is much more convenient to work with the conceptual model using a GenCade coverage.

Work with an existing simulation by selecting the 1D Grid module. If a grid has already been created for a GenCade simulation or an existing simulation read, the grid object will exist in the Project Explorer and selecting that object will make the 1D Grid module active and set the model to GenCade.

The interface consists of the conceptual model tools in the Map Module and the grid specific options in the 1D Grid module.

Map Module – Conceptual Interface

In the map module, a GenCade coverage (or coverages) can be created that include the information defining the grid and structures in the desired simulation.

Grid Frame

The grid frame defines the orientation and extent that will be occupied by the 1D grid. After defining the shorelines and any necessary structures, the grid should be set up. Manually draw the grid frame using the Create 1D Grid Frame tool. The GenCade grid frame is purple and has an arrow at one end. If a person followed the grid from the end to the arrow, the water should always be to the left and the land should always be to the right.

For example, if the GenCade grid was oriented from north to south, the water would be to the east (left) and the land would be to the west (right). The grid can be modified by clicking the Select 1-D Grid Frame tool and double-clicking on the square in the center of the purple grid line.

Alternately, the grid options can be changed by selecting the grid frame and use the right-click Properties command. The Grid Frame Properties window will open, and the Origin X, Origin Y, Angle, and I size can be modified. The I size is the length of the grid. Angle refers to the sign convention in the conceptual model which is degrees counterclockwise from the x axis.

This is different from the GenCade model convention (degrees clockwise from north). Therefore, once the map is converted to a 1D grid, the Azimuth for the grid will be a different value. The cell size can be constant or variable.

Feature Points

In a GenCade coverage, a feature point can be assigned to be:

  • A generic place holder
  • A wave gage – the attributes of this point include a time series of wave data.
  • A refine point – this point will allow controlling the grid density in the area of the point.

Feature Arcs

The arcs in a GenCade coverage can be assigned a variety of attributes including:

  • Geometric object – shoreline and contours.
  • Structure – jetty, inlet, sea wall, or breakwater and the associated parameters.
  • Event – bypass or beach nourishment events and their time ranges and parameters.

The conceptual model is converted to a numeric model using the Map → 1D Grid command. This command can overwrite an existing simulation or simply add additional structures to an existing simulation.

1D Grid Module – Numerical interface

The tools in the grid module allow selecting individual structures graphically and change their parameters. The GenCade menu allows bringing up tables of all structures of a specific type, view their parameters, and make edits as needed.

GenCade Menu

When the GenCade model is active, the GenCade menu becomes available. See GenCade Menu for more information.

GenCade Tools

GenCade makes use of the tools in the 1D Grid module

Running the Model

The GenCade Files are written automatically with the SMS project file or can be saved separately using the File | Save GenCade or File | Save As menu commands. See GenCade Files for more information on the files used for the GenCade run.

GenCade can be launched from SMS using the GenCade | Run GenCade menu command.

Related Topics