User:Jcreer/SMS:STWAVE Model Control in SMS 13.0: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOINDEX__
__NOINDEX__
[[File:STWAVE MC Parameters.png|thumb|400 px|STWAVE ''Model Control'' dialog showing the ''Parameters'' tab.]]
[[File:STWAVE MC Parameters.png|thumb|400 px|STWAVE ''Model Control'' dialog showing the ''Parameters'' tab.]]
The '''Model Control…'''command in the [[SMS:STWAVE Menu|STWAVE simulation menu] opens the STWAVE ''Model Control'' dialog. This dialog is divided into multiple tabs with different options.   
The '''Model Control…'''command in the [[SMS:STWAVE Menu|STWAVE simulation menu]] opens the STWAVE ''Model Control'' dialog. This dialog is divided into multiple tabs with different options.   


==Parameters==
==Parameters==
* STWAVE plane mode
* ''STWAVE plane mode'' – Determines how wave transformation and generation will be computed.
*Source terms
** "Full Plane" –  Allows wave transformation and generation on the full 360 degree plane. Consult the STWAVE model documentation for more information.
*Depth
** "Half Plane" –  Allows wave energy to propagate only from teh offshore towards the nearshore. Consult the STWAVE model documentation for more information.
*Current interaction
* ''Source Terms'' –  Specifies whether STWAVE should generate waves using wind and the input spectrum or whether to use the wave spectrum.
*Bottom friction
*''Depth'' – Determines the depth type used in the simulation run.
*Surge fields
**"Nontransient" – Default option.
*Ice fields
**"Transient" – Allows selecting a transient depth dataset for spatial varied depth.
*Number of grid partitions (processing)
**"Coupled" – Indicates that using a coupled simulation for the depth type.
* ''Current Interaction'' – Specifies whether currents will be used as input to the model.
* ''Bottom Friction'' –  Specifies which friction type is to be used, if any.
**"JONSWAP constant" – Uses a constant for the bottom friction value using the JONSWAP formulation.
**"JONSWAP dataset" – Allows selecting a dataset containing the bottom friction value using the JONSWAP formulation.
**"Manning constant" – Uses a constant for the bottom friction value using a Manning's n formulation.
**"Manning dataset" – Allows selecting a dataset containing the bottom friction value using a Manning's n formulation.
* ''Surge Fields'' –  Specifies whether surge fields are being used, or a constant tidal offset.
* ''Wind Fields'' – Specifies whether wind fields (spatially varied wind) are being used, or a constant wind magnitude and direction.
* ''Ice Fields'' – Specifies whether an ice dataset is being used. This is a scalar dataset that defines the percent of ice in each grid cell.
:* ''Ice Threshold'' – If an ice dataset is being used, this value is needed to specify to threshold concentration level. Any cells with a percentage of ice higher than this threshold will be considered inactive by STWAVE.
*''Number of grid partitions (processing)'' – Used for parallel simulations.
**''I'' – Number of partitions in the I-direction.
**''J'' – Number of partitions in the J-direction.


== Boundary Control ==
== Boundary Control ==
*Source
[[File:STWAVE MC Boundary.png|thumb|400 px|STWAVE ''Model Control'' dialog showing the ''Boundary control'' tab.]]
*Interpolation
The boundary condition for STWAVE consists of one or more energy spectra entering on one or more open edges of the grid.  Traditionally, specify a single spectra that is assigned to all of the cells on the offshore edge.  In this situation specify one spectra for each wave case or time snap being simulated.  Alternately, the input spectra can be interpolated to the cells on the offshore edge(s) from a parent STWAVE or  WAM grid.
*''Source'' – Select the source for the external boundary conditions.
** "Spectral coverage" – Uses the spectral coverage in the simulation for all boundary conditions.
** "None" –  Requires that energy spectra be entered.
*''Interpolation'' – Selects the interpolation method to use for the grid boundary.
**"None (single point)" – Applies a single input spectrum along the entire grid boundary.
**"Linear" – Used to apply multiple input spectrum along the entire grid boundary using the linear interpolation method.
**"Morphic" – Used to apply multiple input spectrum along the entire grid boundary using the morphic interpolation method.
*Computational spectral grid
*Computational spectral grid
**Number
**Number
Line 22: Line 42:
**Maximum
**Maximum
*Subset
*Subset
*Sides
*''Sides'' – Specified when using a spectral coverage source. The types of boundary conditions include:
*Case data
** "Specified spectrum" – This may come from a parent grid if using nesting. Otherwise, a button to the right will be used to assign the spectral coverage to the boundary.
**Time
** "1D transformed spectrum" – This boundary type allows energy to propagate along the boundary without interference. The cells would have the same energy if the grid was extended and the boundary became interior to a larger grid.
**Wind Direction
** "Zero spectrum" – The boundary doesn't have any spectral energy applied.
**Wind Magnitude
*''Case data'' – Defines the time step or cases that will be used and the input boundary conditions for each.
**Water Level
**''Wind direction angle convention'' –  Controls allow choosing the convention that will be used for the wind direction field in the events spreadsheet. Options include: "Cartesian", "Meteorologic", "Oceanographic", and "Shore normal".
----
**''Time'' – The time offset value representing how much later the time is than the specified reference time. Hence, if 5 is entered for the time offset, and the time units is hours, then it is the case of 5 hours later. When nesting is used, the case ids, and the number of cases, will be determined by the parent simulation.
The boundary condition for STWAVE consists of one or more energy spectra entering on one or more open edges of the grid.  Traditionally, specify a single spectra that is assigned to all of the cells on the offshore edge.  In this situation specify one spectra for each wave case or time snap being simulated.  Alternately, the input spectra can be interpolated to the cells on the offshore edge(s) from a parent STWAVE or  WAM grid.
**''Wind Direction'' – Available if "Constant value" has been selected on the ''Parameters" tab.
* ''Source combo box'' – This combo box lists the types of spectral sources.  Choose from "Spectral Coverage", "STWAVE run", and "WAM run".  If the option is "Spectral Coverage", provide the spectra in a spectral coverage as well as a definition for the spectral grid to be used when exporting STWAVE simulation files. The grid definition can be specified by selecting the '''Spectral Grid...''' button. Both of the other options indicating that spectra will be coming from a parent grid and the associated options and spectral sites buttons become enabled.  If an option is selected that is not valid (i.e. choosing an "STWAVE Run" when only a single grid exists in the project so not parent grid exists), SMS generates a message indicating the option is invalid and resets the source.
**''Wind Magnitude'' – Available if "Constant value" has been selected on the ''Parameters" tab.
* '''Options...''' – This button brings up a dialog which allows specifying information for using output from a STWAVE or WAM parent grid as spectral input for this grid. When a parent STWAVE grid is desired, specify which grid is the parent and what type of spectral interpolation should be used.
**''Water Level'' – Available if "Constant value" has been selected on the ''Parameters" tab.
* '''Spectral sites...''' – This button invokes a dialog that creates nesting sites in the parent grid. Spectral output sites for nesting may also be specified explicitly by selecting cells in the parent grid and assigning attributes for those cells. See grid nesting for more information.
[[Category:SMS Boundary Conditions|STWAVE]]
 
== Settings ==
* '''Boundary Control''' – Opens the [[SMS:Spectral Events|''Spectral Events'' dialog]] used to specify the STWAVE Boundary Conditions.
* '''Output Control''' –  Opens the ''STWAVE Output Control'' dialog. (see below)
* '''Iterations Control''' – Opens the STWAVE ''Iterations Control'' dialog. (see below)
* ''Full Plane'' – Consult the STWAVE model documentation for more information.
* ''Half Plane'' –  Consult the STWAVE model documentation for more information.
* ''Depth Type'' –
* ''Source Terms'' –  Specifies whether STWAVE should generate waves using wind and the input spectrum or whether to use the wave spectrum.
* ''Current Interaction'' – Specifies whether currents will be used as input to the model.
* ''Bottom Friction'' –  Specifies which friction type is to be used, if any.
* ''Surge Fields'' –  Specifies whether surge fields are being used, or a constant tidal offset.
* ''Wind Fields'' – Specifies whether wind fields (spatially varied wind) are being used, or a constant wind magnitude and direction.
* ''Number of Iterations'' – Number of iterations to run. (Full Plane Only).
* ''Select buttons'' – The select buttons by next to the current, bottom friction, surge, and wind options are used to specify a dataset on the grid to use as the desired dataset. These buttons open up the ''Select Dataset'' dialog. These datasets must be created  prior to entering the model control dialog.
* ''Ice Fields'' – Specifies whether an ice dataset is being used. This is a scalar dataset that defines the percent of ice in each grid cell.
:* ''Ice Threshold'' – If an ice dataset is being used, this value is needed to specify to threshold concentration level. Any cells with a percentage of ice higher than this threshold will be considered inactive by STWAVE.  


===STWAVE Output Control===
==Output Control==
[[Image:STWAVE MC Output.jpg|thumb|200 px|''STWAVE Output Control'' dialog]]
[[File:STWAVE MC OutputControl.png|thumb|400 px|STWAVE ''Model Control'' dialog showing the ''Output Control'' tab]]
The ''STWAVE Output Control'' dialog is used to specify the solutions files STWAVE should output.  
The ''STWAVE Output Control'' dialog is used to specify the solutions files STWAVE should output.  


Line 60: Line 61:
* '''Period'''
* '''Period'''
* '''Direction'''
* '''Direction'''
* '''Wave Vector'''(magnitude of height with wave direction)
* '''Wave Vector''' (magnitude of height with wave direction)
* '''1/fma''' – Period that represents the inverse of the spectral peak frequency redefined for local wind growth cases
* '''1/fma''' – Period that represents the inverse of the spectral peak frequency redefined for local wind growth cases


The options include:
The options include:
* ''Radiation stresses'' – If this is on, radiation stresses will be calculated and output into datasets
* ''Radiation stresses'' – If this is on, radiation stresses will be calculated and output into datasets
* ''Breaking'' – This will output a dataset representing the wave breaking. For full-plane, this can be no indices (off) or write indices which gives a value of 1 where breaking occurs and 0.0 otherwise. Half-plane has the full-plane options and has an additional option to calculate energy dissipation. This will give a dataset of energy dissipation.
* ''C2Shore''
* ''Output type'' – SMS supports the ability to write ASCII files, XMDF files or both. ASCII files refer to STWAVE version 6 global dataset files and XMDF files are datasets written using the XMDF library built upon HDF5. XMDF is the recommended file format because they are much faster to read/write. XMDF is only available on windows platforms.
* ''Output stations''
 
**''Use output stations''
===STWAVE Interations Control===
* ''Breaking'' – This will output a dataset representing the wave breaking. For full-plane, this can be no indices (off) or write indices which gives a value of 1 where breaking occurs and 0.0 otherwise. Half-plane has the full-plane options and has an additional option to calculate energy dissipation; this will give a dataset of energy dissipation.
[[Image:STWAVE MC Iterations.jpg|thumb|300 px|STWAVE ''Iterations Control'' dialog]]
The STWAVE ''Iterations Control'' dialog is reached through the ''STWAVE Model Control'' dialog. Here the number, stop value, and stop percent of iterations can be set. The dialog contains the following options:
 
:''Iterations Parameters''
:* ''Maximum number of initial iterations''
:* ''Initial iteration stop value''
:* ''Initial iteration stop percent''
:* ''Maximum number of final iterations''
:* ''Final iteration stop value''
:* ''Final iteration stop percent''
 
==Using Datasets as Input==
Datasets may be used as input to STWAVE to represent spatially varied currents, bottom friction (either manning's or JONSWAP), surge, or wind. Bottom friction cannot vary from snap to snap. The other dataset types can have different values for each snap.


Datasets are chosen within the model control by clicking on the '''Choose''' button to the right of the dataset choice. The dataset values for each time step will be the values for the time that the time step occurs. The time steps for the dataset chosen do not need to match the time steps specified for the simulation. The dataset values passed to STWAVE can be interpolated from a dataset with values at different time steps than is being used by the model.
==Interations Control==
[[File:STWAVE MC IterationsControl.png|thumb|300 px|STWAVE ''Model Control'' dialog showing the ''Iterations Control'' tab.]]
The STWAVE ''Iterations Control'' dialog is reached through the ''STWAVE Model Control'' dialog. Here the number, stop value, and stop percent of iterations can be set. The tab contains the following options:


If the simulation is not using time steps, the datasets are chosen in the [[SMS:Spectral Events|''Spectral Events'' dialog]]. In this situation, a steady state dataset is chosen for each snap.
:''Iterations Parameters'' – Used for full-plane simulations.
:* ''Maximum number of initial iterations'' – Number to perform per snap IDD.
:* ''Initial iteration stop value'' – The initial iteration stopping convergence criteria.
:* ''Initial iteration stop percent'' – The initial iteration stopping percentage criteria.  
:* ''Maximum number of final iterations''– Number to perform per snap IDD.
:* ''Final iteration stop value'' – The final iteration stopping convergence criteria.
:* ''Final iteration stop percent'' – The final iteration stopping percentage criteria.


==Related Topics==
==Related Topics==

Latest revision as of 18:07, 26 October 2018

STWAVE Model Control dialog showing the Parameters tab.

The Model Control…command in the STWAVE simulation menu opens the STWAVE Model Control dialog. This dialog is divided into multiple tabs with different options.

Parameters

  • STWAVE plane mode – Determines how wave transformation and generation will be computed.
    • "Full Plane" – Allows wave transformation and generation on the full 360 degree plane. Consult the STWAVE model documentation for more information.
    • "Half Plane" – Allows wave energy to propagate only from teh offshore towards the nearshore. Consult the STWAVE model documentation for more information.
  • Source Terms – Specifies whether STWAVE should generate waves using wind and the input spectrum or whether to use the wave spectrum.
  • Depth – Determines the depth type used in the simulation run.
    • "Nontransient" – Default option.
    • "Transient" – Allows selecting a transient depth dataset for spatial varied depth.
    • "Coupled" – Indicates that using a coupled simulation for the depth type.
  • Current Interaction – Specifies whether currents will be used as input to the model.
  • Bottom Friction – Specifies which friction type is to be used, if any.
    • "JONSWAP constant" – Uses a constant for the bottom friction value using the JONSWAP formulation.
    • "JONSWAP dataset" – Allows selecting a dataset containing the bottom friction value using the JONSWAP formulation.
    • "Manning constant" – Uses a constant for the bottom friction value using a Manning's n formulation.
    • "Manning dataset" – Allows selecting a dataset containing the bottom friction value using a Manning's n formulation.
  • Surge Fields – Specifies whether surge fields are being used, or a constant tidal offset.
  • Wind Fields – Specifies whether wind fields (spatially varied wind) are being used, or a constant wind magnitude and direction.
  • Ice Fields – Specifies whether an ice dataset is being used. This is a scalar dataset that defines the percent of ice in each grid cell.
  • Ice Threshold – If an ice dataset is being used, this value is needed to specify to threshold concentration level. Any cells with a percentage of ice higher than this threshold will be considered inactive by STWAVE.
  • Number of grid partitions (processing) – Used for parallel simulations.
    • I – Number of partitions in the I-direction.
    • J – Number of partitions in the J-direction.

Boundary Control

STWAVE Model Control dialog showing the Boundary control tab.

The boundary condition for STWAVE consists of one or more energy spectra entering on one or more open edges of the grid. Traditionally, specify a single spectra that is assigned to all of the cells on the offshore edge. In this situation specify one spectra for each wave case or time snap being simulated. Alternately, the input spectra can be interpolated to the cells on the offshore edge(s) from a parent STWAVE or WAM grid.

  • Source – Select the source for the external boundary conditions.
    • "Spectral coverage" – Uses the spectral coverage in the simulation for all boundary conditions.
    • "None" – Requires that energy spectra be entered.
  • Interpolation – Selects the interpolation method to use for the grid boundary.
    • "None (single point)" – Applies a single input spectrum along the entire grid boundary.
    • "Linear" – Used to apply multiple input spectrum along the entire grid boundary using the linear interpolation method.
    • "Morphic" – Used to apply multiple input spectrum along the entire grid boundary using the morphic interpolation method.
  • Computational spectral grid
    • Number
    • Delta
    • Minimum
    • Maximum
  • Subset
  • Sides – Specified when using a spectral coverage source. The types of boundary conditions include:
    • "Specified spectrum" – This may come from a parent grid if using nesting. Otherwise, a button to the right will be used to assign the spectral coverage to the boundary.
    • "1D transformed spectrum" – This boundary type allows energy to propagate along the boundary without interference. The cells would have the same energy if the grid was extended and the boundary became interior to a larger grid.
    • "Zero spectrum" – The boundary doesn't have any spectral energy applied.
  • Case data – Defines the time step or cases that will be used and the input boundary conditions for each.
    • Wind direction angle convention – Controls allow choosing the convention that will be used for the wind direction field in the events spreadsheet. Options include: "Cartesian", "Meteorologic", "Oceanographic", and "Shore normal".
    • Time – The time offset value representing how much later the time is than the specified reference time. Hence, if 5 is entered for the time offset, and the time units is hours, then it is the case of 5 hours later. When nesting is used, the case ids, and the number of cases, will be determined by the parent simulation.
    • Wind Direction – Available if "Constant value" has been selected on the Parameters" tab.
    • Wind Magnitude – Available if "Constant value" has been selected on the Parameters" tab.
    • Water Level – Available if "Constant value" has been selected on the Parameters" tab.

Output Control

STWAVE Model Control dialog showing the Output Control tab

The STWAVE Output Control dialog is used to specify the solutions files STWAVE should output.

The following datasets are always written:

  • Height
  • Period
  • Direction
  • Wave Vector (magnitude of height with wave direction)
  • 1/fma – Period that represents the inverse of the spectral peak frequency redefined for local wind growth cases

The options include:

  • Radiation stresses – If this is on, radiation stresses will be calculated and output into datasets
  • C2Shore
  • Output stations
    • Use output stations
  • Breaking – This will output a dataset representing the wave breaking. For full-plane, this can be no indices (off) or write indices which gives a value of 1 where breaking occurs and 0.0 otherwise. Half-plane has the full-plane options and has an additional option to calculate energy dissipation; this will give a dataset of energy dissipation.

Interations Control

STWAVE Model Control dialog showing the Iterations Control tab.

The STWAVE Iterations Control dialog is reached through the STWAVE Model Control dialog. Here the number, stop value, and stop percent of iterations can be set. The tab contains the following options:

Iterations Parameters – Used for full-plane simulations.
  • Maximum number of initial iterations – Number to perform per snap IDD.
  • Initial iteration stop value – The initial iteration stopping convergence criteria.
  • Initial iteration stop percent – The initial iteration stopping percentage criteria.
  • Maximum number of final iterations– Number to perform per snap IDD.
  • Final iteration stop value – The final iteration stopping convergence criteria.
  • Final iteration stop percent – The final iteration stopping percentage criteria.

Related Topics

STWAVE Menu