SMS:Spectral Energy: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
 
(59 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The Spectral Energy dialog can  be opened through ''STWAVE | Spectral Energy'', ''BOUSS-2D | Spectral Energy'', ''CGWAVE | Spectral Energy'', or by choosing ''STWAVE | Model Control'', clicking on the ''Boundary Conditions'' button to open the Boundary Conditions dialog, and then clicking the ''Spectral Energy'' button. The spectrum represents energy densities at discrete values over a range of angles and a range of frequencies for a given wave condition.  
[[File:SpectralEnergy.png|thumb|400 px|''Spectral Energy'' dialog]]
The ''Spectral Energy'' dialog can be accessed when the spectral coverage is active. The dialog is opened by either double-clicking on a selected node/point or by right-clicking on a selected point and choosing the '''Point Attributes''' command. The spectrum represents energy densities at discrete values over a range of angles and a range of frequencies for a given wave condition.


== Tools ==
== Tools ==
* [[Image:SelectCGridCell.JPG]] '''Select Cell Corner''' – Select a cell corner to view or edit the  energy value.
* [[File:SMS Select Cell Mesh Tool.svg|16 px]] '''Select Cell ''' – Select a cell corner to view or edit the  energy value.
* [[Image:Pan.JPG]] '''Pan''' –  Pan the spectral  grid.
* [[File:Pan Tool.svg|15 px]] '''Pan''' –  Pan the spectral  grid.
* [[Image:Zoom.JPG]] '''Zoom''' –  Zoom in the  window.
* [[File:Zoom Tool Icon.svg|16 px]] '''Zoom''' –  Zoom in the  window.
* [[Image:Rotate.JPG]] '''Rotate''' – Rotate in the window.
* [[File:Rotate Tool.svg|16 px]] '''Rotate''' – Rotate in the window.
* [[Image:Frame.JPG]] '''Frame''' –  Frame, or zoom to the  extents of the grid.
* [[File:Frame Macro.svg|16 px]] '''Frame''' –  Frame, or zoom to the  extents of the grid.
* [[Image:contours.gif]] '''Contour Options''' – Bring up the contour options dialog  for setting the spectral grid contour display options.
* [[File:Contour Options Macro.svg|16 px]] '''Contour Options''' – Bring up the contour options dialog  for setting the spectral grid contour display options.


== Grid Options ==
== Grid Options ==
* '''Create Grid''' –  Brings up the [[SMS:Create Spectral Energy Grid|Create Spectral Energy  Grid]] dialog.
* '''Create Grid''' –  Brings up the ''Spectral Grid Attributes'' dialog followed by the [[SMS:Create Spectral Energy Grid|''Create Spectral Energy  Grid'']] dialog.
* '''Generate Spectra''' –  Brings up the [[SMS:Generate/Edit Spectra|Generate Spectra]] dialog.
* '''Spectra''' –  Brings up the [[SMS:Generate/Edit Spectra|''Generate Spectra'']] dialog.
* '''Import Spectra''' –  Brings up the [[SMS:Import Spectra|Import Spectra]] dialog.
<!--* '''Import Spectra''' &ndash;  Moved to the [[SMS:Generate/Edit Spectra|''Generate Spectra'']] dialog. Brings up the [[SMS:Import Spectra|''Import Spectra'']] dialog.
* '''Export Spectra''' &ndash;  Brings up the Export Spectra dialog where you can choose a location to save the  spectra.
* '''Export Spectra''' &ndash;  Moved to the [[SMS:Generate/Edit Spectra|''Generate Spectra'']] dialog. Brings up the'' Export Spectra'' dialog where a location can be chosen to save the  spectra.-->


== Spectral Tree Options ==
== Spectral Tree Options ==
* '''Spectral Manager  Tree''' &ndash; Select a spectrum in the tree. The selected  spectra will be displayed in the Spectral Viewer.  The tree’s right-click  options are described below.
* ''Spectral Manager  Tree'' &ndash; Select a spectrum in the tree. The selected  spectra will be displayed in the ''Spectral Viewer''.  The tree’s right-click  options are described below.
* '''Select Spectral  Grid''' &ndash; Brings up a dialog to choose a spectrum. Only one spectrum can be viewed at a time. This selects the spectrum to use/visualize. For models that can only use one spectrum, this spectrum will be tied to the model when leaving the dialog (i.e. clicking "Done").


== Grid/Spectra Right-click Options ==
=== Grid/Spectra Right-Click Options ===
* '''Generate Spectra''' &ndash;  Opens the [[SMS:Generate/Edit Spectra|Generate Spectra]] dialog. This  option is available when the grid in the Spectral Manager Tree is right clicked.
<!--* '''Generate Spectra''' &ndash;  Opens the [[SMS:Generate/Edit Spectra|''Generate Spectra'']] dialog. This  option is available when the grid in the ''Spectral Manager Tree'' is right -clicked.
* '''Edit Spectra''' &ndash;  Opens the [[SMS:Generate/Edit Spectra|Edit Spectra]] dialog where the  Parameter Settings, Angle Settings and Spectral Parameters can be edited.
* '''Edit Spectra''' &ndash;  Opens the [[SMS:Generate/Edit Spectra|''Edit Spectra'']] dialog where the  ''Parameter Settings'', ''Angle Settings'' and ''Spectral Parameters'' can be edited.
* '''Export Spectra''' &ndash;  Brings up the Export Spectra dialog where you can choose a location to save the  spectra.
* '''Export Spectra''' &ndash;  Brings up the ''Export Spectra'' dialog where a location can be chosen to save the  spectra.-->
* '''Rename Grid''' or  '''Rename Data Set''' &ndash; Rename a grid or spectrum.
* '''Delete Grid''' or  '''Delete Dataset''' &ndash; Deletes a grid or spectrum.   
* '''Delete Grid''' or  '''Delete Data Set''' &ndash; Deletes a grid or spectrum.   
* '''Properties''' &ndash; Brings up ''Dataset Info''.  This  option is available when the grid in the ''Spectral Manager Tree'' is right-clicked.
* '''Properties''' &ndash; Brings up the [[SMS:Spectral Grid Properties|Spectral Grid Properties]] dialog.  This  option is available when the grid in the Spectral Manager Tree is right clicked.
<!--* '''Edit Time''' &ndash; Edit the time offset for the dataset.-->


== View Options ==
== View Options ==
* '''Cartesian/Polar View''' &ndash; View and edit the  spectral grid using a Cartesian or polar view.
* ''View'' &ndash; View and edit the  spectral grid using a Cartesian or polar view.


== Graphic Options ==
== Graphic Options ==
* '''Selection''' &ndash; View the Frequency, Angle, and Energy of the selected cell corner. The Energy can be edited for the selected points.
Information for points in the grid can be displayed in two ways:
* '''Cursor''' &ndash; View the Frequency, Angle, and Energy as the cursor moves over the grid.
* ''Selection'' &ndash; View the ''Frequency'', ''Angle'', and ''Energy'' of the selected cell corner. The ''Energy'' can be edited for the selected points.
* ''Cursor'' &ndash; View the ''Frequency'', ''Angle'', and ''Energy'' as the cursor moves over the grid.


== 2D Plot Options ==
== 2D Plot Options ==
* '''Frequency Integration Plot''' &ndash; Turn on to  show an energy vs. frequency plot for the selected spectrum.
* ''Frequency Integration Plot'' &ndash; Turn on to  show an energy vs. frequency plot for the selected spectrum.
* '''Direction Integration Plot''' &ndash; Turn on to  show a direction vs. energy plot for the selected spectrum.
* ''Direction Integration Plot'' &ndash; Turn on to  show a direction vs. energy plot for the selected spectrum.
 
==Reference Time==
Clicking on the '''Update Reference Time...''' button will bring up the ''Time Settings'' dialog with the following options.
* ''Reference Time'' &ndash; Specify the reference time for all datasets assigned to the node
* ''Time Units'' &ndash; Specify the units for the time offsets assigned to the datasets
[[File:Spectral Time Setting.png|thumb|none|left|300 px|The spectral energy ''Time Settings'' dialog.]]


==Related Topics==
==Related Topics==
* [[SMS:Create Spectral Energy Grid|Create Spectral Energy Grid]]
* [[SMS:Create Spectral Energy Grid|Create Spectral Energy Grid]]
* [[SMS:Generate Spectra|Generate Spectra]]
* [[SMS:Generate/Edit Spectra|Generate Spectra]]
* [[SMS:Import Spectra|Import Spectra]]
* [[SMS:Import Spectra|Import Spectra]]
* [[SMS:Spectral Grid Properties|Spectral Grid Properties]]
* [[SMS:Spectral Grid Properties|Spectral Grid Properties]]
* [[SMS:STWAVE Menu|STWAVE Menu]]
* [[SMS:STWAVE Menu|STWAVE Menu]]
* [[SMS:CGWAVE_Menu|CGWAVE Menu]]
* [[SMS:CGWAVE Graphical Interface#CGWAVE Menu|CGWAVE Menu]]
* [[SMS:Cartesian Grid Module|Cartesian Grid Module]]
* [[SMS:Cartesian Grid Module|Cartesian Grid Module]]


Line 50: Line 57:
{{Template:Navbox SMS}}
{{Template:Navbox SMS}}


[[Category:BOUSS-2D]]
[[Category:BOUSS-2D|S]]
[[Category:STWAVE]]
[[Category:CMS-Wave|S]]
[[Category:STWAVE|S]]
[[Category:Spectral Energy|Energy]]
[[Category:SMS Spectral Dialogs|Energy]]

Latest revision as of 22:01, 10 June 2024

Spectral Energy dialog

The Spectral Energy dialog can be accessed when the spectral coverage is active. The dialog is opened by either double-clicking on a selected node/point or by right-clicking on a selected point and choosing the Point Attributes command. The spectrum represents energy densities at discrete values over a range of angles and a range of frequencies for a given wave condition.

Tools

  • SMS Select Cell Mesh Tool.svg Select Cell – Select a cell corner to view or edit the energy value.
  • Pan Tool.svg Pan – Pan the spectral grid.
  • Zoom Tool Icon.svg Zoom – Zoom in the window.
  • Rotate Tool.svg Rotate – Rotate in the window.
  • Frame Macro.svg Frame – Frame, or zoom to the extents of the grid.
  • Contour Options Macro.svg Contour Options – Bring up the contour options dialog for setting the spectral grid contour display options.

Grid Options

Spectral Tree Options

  • Spectral Manager Tree – Select a spectrum in the tree. The selected spectra will be displayed in the Spectral Viewer. The tree’s right-click options are described below.

Grid/Spectra Right-Click Options

  • Delete Grid or Delete Dataset – Deletes a grid or spectrum.
  • Properties – Brings up Dataset Info. This option is available when the grid in the Spectral Manager Tree is right-clicked.

View Options

  • View – View and edit the spectral grid using a Cartesian or polar view.

Graphic Options

Information for points in the grid can be displayed in two ways:

  • Selection – View the Frequency, Angle, and Energy of the selected cell corner. The Energy can be edited for the selected points.
  • Cursor – View the Frequency, Angle, and Energy as the cursor moves over the grid.

2D Plot Options

  • Frequency Integration Plot – Turn on to show an energy vs. frequency plot for the selected spectrum.
  • Direction Integration Plot – Turn on to show a direction vs. energy plot for the selected spectrum.

Reference Time

Clicking on the Update Reference Time... button will bring up the Time Settings dialog with the following options.

  • Reference Time – Specify the reference time for all datasets assigned to the node
  • Time Units – Specify the units for the time offsets assigned to the datasets
The spectral energy Time Settings dialog.

Related Topics