SMS:CMS-Wave Files

From XMS Wiki
Jump to: navigation, search

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