SMS:CMS-Wave Files: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
SMS stores the data used for CMS-Wave inside the project. This includes the Cartesian grids in their own HDF5 (grids.h5) file, the spectral grids in their own HDF5 (spec_grds.h5) file and all of the simulation parameters.
A CMS-Wave simulation consists of:
* A Cartesian grid which defines the bathymetric depths over the model domain
* A set of spectra that represent the input wave conditions to be modeled
* Model parameters controlling what options should be used in this simulation
* Optional spatially varied input fields over the same domain such as wind datasets, surge (water level) datasets, and current datasets


In order to run the file, the user must export the data into model native file formats. These files are listed below.  The model native files are referenced by a simulation file, which includes all the names of the other files used as input for a simulation, or that will be created by CMS-Wave when it runs.
SMS stores all of this information internally in its own formats.  This includes:
* An XMDF (HDF5) file to store the bathymetry and other datasets on the grid
* An XMDF (HDF5) file to store the spectral grids and wave states entering the domain from the boundary
* Model parameters in the project (sms) file.


SMS stores a simulation name associated each CMS-Wave grid loaded into a session. If a new grid is created, the name is blank and SMS will prompt the user for a name when it is needed.
In order to run the numeric model, the data must be exported into model native file formats. SMS exports these files when instructed to do so from either the ''CMS-Wave'' menu or by right-clicking on the CMS-Wave grid. SMS includes three commands in either location. These include:


A simulation may be run by right clicking on the grid and selecting the command to export the model native files, launch the model with the current version of the data saved to dist, or save all data (both SMS project and simulation) and launch CMS-Wave.  These commands can also be accessed from the CMS-Wave menu at the top of the application.  The menu bar commands refer to the active CMS-Wave grid.
# '''Export CMS-Wave Files''' – Creates the native files described below for the simulation.  If the data has not been previously saved to establish the name of the simulation, SMS prompts for a simulation name.
# '''Launch CMS-Wave''' – Uses the saved files to invoke the simulation
# '''Save project, export and launch CMS-Wave''' – This command, as described, saves the SMS project and then replicates the functionality of the other two commands.


If the "launch CMS-Wave" command is issued without having first saved the model native files, SMS will bring up a message indicating that the files must first be saved.
The model native files are referenced by a simulation file, which includes all the names of the other files used as input for a simulation, or that will be created by CMS-Wave when it runs.


To change the name of the simulation associated with a grid, the user can select the "File|Save as..." command and select the CMS-Wave simulation option.  SMS will then prompt the user for the new simulation name to be associated with the active CMS-Wave grid.  We recommend that this option be utilized only after duplicating the CMS-Wave grid, since the link to the old simulation files is lost when the new simulation name is specified.
SMS stores a simulation name associated each CMS-Wave grid loaded into a sessionIf a new grid is created, the name is blank. SMS will prompt for a name when it is needed.


If the '''Launch CMS-Wave''' command is issued without having first saved the model native files, SMS will bring up a message indicating that the files must first be saved.
To change the name of the simulation associated with a grid, select the ''File''|'''Save as...''' command and select the ''CMS-Wave simulation'' option.  SMS will then prompt for the new simulation name to be associated with the active CMS-Wave grid.  It is recommended that this option be utilized only after duplicating the CMS-Wave grid, since the link to the old simulation files is lost when the new simulation name is specified.


== Input Files: ==
== Input Files: ==
* Required files
* Required files
**[[SMS:CMS-Wave Simulation File|''projname''.sim]]
**[[SMS:CMS-Wave Simulation File|*.sim]] – Simulation file.
**[[SMS:CMS-Wave Control File|''projname''.std]]
**[[SMS:CMS-Wave Control File|*.std]] – Control file.
**[[SMS:CMS-Wave Depth File|''projname''.dep]]
**[[SMS:CMS-Wave Depth File|*.dep]] – Depth file.
**[[SMS:CMS-Wave Spectral Energy File|''projname''.eng]]
**[[SMS:CMS-Wave Spectral Energy File|*.eng]] – Spectral energy file.


* Optional files
* Optional files
**[[SMS:CMS-Wave Current File|''projname''.cur]]
**[[SMS:CMS-Wave Current File|*.cur]] – Current file
** [[SMS:CMS-Wave Spatial Surge File|''projname''.eta]]
** *.eta – Water level file (uses the same format as the *.dep file)
** [[SMS:CMS-Wave Structure File|''projname''.struct]]
** [[SMS:CMS-Wave Structure File|*.struct]] – Wave structure file
** [[SMS:CMS-Wave Friction File|friction.struct]]
** *.fric – Bottom friction coefficient file (uses the same format as the *.dep file)
** [[SMS:CMS-Wave Forward Reflection File|forward.struct]]
** *.fref – Forward reflection coefficient file (uses the same format as the *.dep file)
** [[SMS:CMS-Wave Reverse Reflection File|reverse.struct]]
** *.bref – Backward reflection coefficient file (uses the same format as the *.dep file)


* Auxilliary files
* Auxiliary files
**[[SMS:CMS-Wave Spectral Table File|''projname''.txt]]
**[[SMS:CMS-Wave Spectral Table File|*.txt]] – A spectral table file


== Output Files ==
== Output Files ==
* Spatially varied data (value for each cell)
* Spatially varied data (value for each cell)
** [[SMS:CMS-Wave Wave Output File|''projname''.wav]]
** [[SMS:CMS-Wave Wave Output File|*.wav]] – A wave output file.
** [[SMS:CMS-Wave Wave Breaking File|''projname''.brk]]
** [[SMS:CMS-Wave Wave Breaking File|*.brk]] – A wave breaking file.
** [[SMS:CMS-Wave Radiation Stress File|''projname''.rad]]
** [[SMS:CMS-Wave Radiation Stress File|*.rad]] – A radiation stress file.


* Full spectra a selected cells
* Full spectra at selected cells (have the same format as the *.eng file)
** [[SMS:CMS-Wave Observation Output File|''projname''.obs]]
** *.obs
** [[SMS:CMS-Wave Nesting Output File|''projname''.nst]]
** *.nst


* Additional files
* Additional files
** [[SMS:CMS-Wave Selected Cells Output File|selhts.out]]
** setup.wave – Text file of wave runup/setup at specified structure locations.
** [[SMS:CMS-Wave Setup Output File|setup.wave]]
** [[SMS:CMS-Wave Monitoring Station Output File|selhts.out]] – Output text file of wave height, period and direction at specified observation locations.


==Related Topics==
==Related Topics==
*[[SMS:CMS-Wave|CMS-Wave]]
*[[SMS:CMS-Wave|CMS-Wave]]


{{Template:Navbox SMS}}
{{Template:Navbox SMS}}


[[Category:CMS-Wave]]
[[Category:CMS-Wave|F]]
[[Category:SMS File Formats|C]]

Latest revision as of 20:23, 14 July 2016

A CMS-Wave simulation consists of:

  • A Cartesian grid which defines the bathymetric depths over the model domain
  • A set of spectra that represent the input wave conditions to be modeled
  • Model parameters controlling what options should be used in this simulation
  • Optional spatially varied input fields over the same domain such as wind datasets, surge (water level) datasets, and current datasets

SMS stores all of this information internally in its own formats. This includes:

  • An XMDF (HDF5) file to store the bathymetry and other datasets on the grid
  • An XMDF (HDF5) file to store the spectral grids and wave states entering the domain from the boundary
  • Model parameters in the project (sms) file.

In order to run the numeric model, the data must be exported into model native file formats. SMS exports these files when instructed to do so from either the CMS-Wave menu or by right-clicking on the CMS-Wave grid. SMS includes three commands in either location. These include:

  1. Export CMS-Wave Files – Creates the native files described below for the simulation. If the data has not been previously saved to establish the name of the simulation, SMS prompts for a simulation name.
  2. Launch CMS-Wave – Uses the saved files to invoke the simulation
  3. Save project, export and launch CMS-Wave – This command, as described, saves the SMS project and then replicates the functionality of the other two commands.

The model native files are referenced by a simulation file, which includes all the names of the other files used as input for a simulation, or that will be created by CMS-Wave when it runs.

SMS stores a simulation name associated each CMS-Wave grid loaded into a session. If a new grid is created, the name is blank. SMS will prompt for a name when it is needed.

If the Launch CMS-Wave command is issued without having first saved the model native files, SMS will bring up a message indicating that the files must first be saved.

To change the name of the simulation associated with a grid, select the File|Save as... command and select the CMS-Wave simulation option. SMS will then prompt for the new simulation name to be associated with the active CMS-Wave grid. It is recommended that this option be utilized only after duplicating the CMS-Wave grid, since the link to the old simulation files is lost when the new simulation name is specified.

Input Files:

  • Required files
    • *.sim – Simulation file.
    • *.std – Control file.
    • *.dep – Depth file.
    • *.eng – Spectral energy file.
  • Optional files
    • *.cur – Current file
    • *.eta – Water level file (uses the same format as the *.dep file)
    • *.struct – Wave structure file
    • *.fric – Bottom friction coefficient file (uses the same format as the *.dep file)
    • *.fref – Forward reflection coefficient file (uses the same format as the *.dep file)
    • *.bref – Backward reflection coefficient file (uses the same format as the *.dep file)
  • Auxiliary files
    • *.txt – A spectral table file

Output Files

  • Spatially varied data (value for each cell)
    • *.wav – A wave output file.
    • *.brk – A wave breaking file.
    • *.rad – A radiation stress file.
  • Full spectra at selected cells (have the same format as the *.eng file)
    • *.obs
    • *.nst
  • Additional files
    • setup.wave – Text file of wave runup/setup at specified structure locations.
    • selhts.out – Output text file of wave height, period and direction at specified observation locations.

Related Topics