User:Jcreer/SMS:SRH-2D Changes: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
(Created page with " At release apply updates here: SMS:Simulations#Monitoring_Data ===Monitoring Data=== The '''Simulation Run Queue''' contains an option for ''Monitoring Data''. Turning on this option activates the tabs underneath for the selected simulation. The tabs are: * ''Command Line'' – Shows the command line entries for the selected process. Reports errors encountered during the simulation run. * ''Residual Plot'' – Shows the residual plot for the selected simulat...")
 
No edit summary
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOINDEX__
At release apply updates here: [[SMS:Simulations#Monitoring_Data]]
{{Version SMS 13.4}}
__TOC__
----
At release, apply updates here: [[SMS:Simulations#Monitoring_Data]]
===Monitoring Data===
===Monitoring Data===
The '''Simulation Run Queue''' contains an option for ''Monitoring Data''. Turning on this option activates the tabs underneath for the selected simulation. The tabs are:
The '''Simulation Run Queue''' contains an option for ''Monitoring Data''. Turning on this option activates the tabs underneath for the selected simulation. The tabs are:
* ''Command Line'' – Shows the command line entries for the selected process. Reports errors encountered during the simulation run.
* ''Command Line'' – Shows the command line entries for the selected process. Reports errors encountered during the simulation run.
* ''Residual Plot'' – Shows the residual plot for the selected simulation.
* ''Residual Plot'' – Shows the residual plot for the selected simulation.
* ''Monitor Point Plot'' – If monitor points are included in the simulation, this shows a plot for the point location once the simulation has included the point in the simulation run.
* ''Monitor Point Plot'' – If monitor points are included in the simulation, this shows a water level -vs- time plot for the point location once the simulation has included the point in the simulation run.
* ''Monitor Line Plot'' – If monitor lines are included in the simulation, this shows a plot for the line location once the simulation has included the line in the simulation run.
* ''Monitor Line Q Plot'' – If monitor lines are included in the simulation, this shows a plot for the flow rate vs time plot once the simulation has included the line in the simulation run.
* ''Monitor Line QS Plot'' – If monitor lines are included in the simulation, this shows a plot for the sediment discharge vs time plot once the simulation has included the line in the simulation run.
 
----
At release, apply changes to this article: [[SMS:SRH-2D Plots]]
 
==Run Queue Plots==
While the simulation is running, plots which are monitoring the progress and stability of the simulation can be viewed by clicking on the SRH-2D process link in the Simulation Run Queue. The plots that are available in the run queue include:
*  ''Net_Q/INLET_Q'' – This is a measure of the percentage of flow entering the simulation relative to the flow that leaves the simulation at a given time. To be more specific, the equation that SRH-2D uses to compute this quantity is (Exterior Boundary Outflow - Exterior Boundary Inflow) / Total Inflow.
** Terms
*** Exterior Boundary Outflow: all flow leaving the domain over Exit-H or Exit-Q boundaries.
*** Exterior Boundary Inflow: all flow entering the domain over Inlet-Q boundaries.
*** Total Inflow: Exterior Boundary Inflow minus summation of interior Sink boundaries 
**  Examples
*** -100% means all the flow that entered the simulation at this time stayed in the simulation
***  0% means the same amount of flow exited during this time step as entered
***  >0% means more flow left the simulation than entered it.
** Considerations
*** Exit-H boundaries can become inflow boundaries for transient runs in situations such as a flood tide. This negative outflow complicates the calculations.
*** Sink boundaries are specified with a positive value. Source boundaries are simply specified as sink boundaries with a negative value.
*** Boundaries that change flow rates over time, such as Exit-H boundaries or sink boundaries with rating curves make the interpretation of this plot for complicated.
* ''Mass Balance'' – Includes mass loss percentage -vs- time and  average mass loss percentage -vs- time.
* ''Monitor Points WSE'' – Monitor point water level -vs- time. Will display one plot for each monitor point in the simulation.
* ''Monitor Points Z'' – Monitor point ground level -vs- time. Will display one for each monitor point in the simulation. This plot is not meaningful unless the simulation includes sediment transport.
* ''Monitor Q Lines'' – Monitor line flow rate flux vs time. Will display one plot for each monitor line in the simulation.
* ''Monitor QS Lines'' – Monitor line sediment discharge flux vs time. Will display one plot for each monitor line in the simulation.
 
==Simulation Plots==
Once a simulation is complete, it is useful to be able to review the plots for the simulation as quality check on the simulation and model review.
<!--[[File:SRH-2D SimulationPlots.png|thumb|450 px|Example of the ''SRH-2D Solution Plots'' dialog for a simulation]]-->
In the SRH-2D simulation right-click menu, using the ''Tools'' | '''View Simulation Plots''' command brings up the ''SRH-2D Solution Plots'' dialog. This dialog provides a list of solution plots that were generated during the model run. The list of available plots in on the left side of the dialog. Once a plot is selected from the list, the plot will be shown in the plot window on the right side of the dialog.
 
All of the plots that were available during the simulation execution in the run queue are also available in the simulation tools. However, these plots are now displayed in a plot window (rather than the Run Queue) and have additional options for viewing the plot.  The options include:
*''X axis''
**''Specify range'' &ndash; Allows specifying the time range of the plot to be viewed. The possible range will be 0 to the length (time in hours) of the simulation.
***''Minimum time'' &ndash; The beginning time range.
***''Maximum time'' &ndash; The ending time range.
*''Y axis''
**''Specify range'' &ndash; Allows specifying the value range of the plot to be viewed. The possible range will be values generated during the simulation run.
***''Minimum value'' &ndash; The beginning value range.
***''Maximum value'' &ndash; The ending value range.
*''Log scale'' &ndash; Change the y-axis to use a log scale.
The plot window has the following tools:
* Reset View [[File:Home button icon.png|16 px]] &ndash; Restores the plot view to the original view.
* Previous View [[File:Previous view button icon.png|16 px]] &ndash; Moves to the previous plot view.
* Next View [[File:Next view button icon.png|16 px]] &ndash; After moving to a previous view, will move back to a more recent view.
* Pan [[File:Pan Tool.svg|16 px]] &ndash; Allows panning through the plot graph.
* Zoom [[File:Zoom dialog button icon.png|16 px]] &ndash; Allows zooming in and out of the plot graph.
* Edit Plot Properties [[File:Edit plot button icon.png|16 px]] &ndash; Opens a dialog where title, axes, line style, and marker style can be changed.
* Save [[File:Save plot button icon.png| 16 px]] &ndash; Opens a save dialog to export an image of the plot at the current set view.
{{-}}
 
==Monitor and Structure Plots==
<!--[[File:SRH2D SolutionPlots.png|thumb|450 px|Example of the ''SRH-2D Solution Plots'' dialog for an SRH-2D structure]]-->
In addition to the simulation plots, plots for structures can also be generated in review mode. These plots are accessed by selecting the map module arc associated with structure in the boundary condition or monitor arc in the monitor coverage.
 
SMS can generate a solution plot at a monitoring location or at a structure location. The plot will use the solution datasets generated during the model run. If the coverage was edited after running SRH-2D, rerun SRH-2D with the updated coverage to ensure that the plot is consistent with the SRH-2D outputs.
 
For a monitoring point or line, in the monitor coverage, select the monitoring point or line then right-click and select the '''Monitor Points Plot''' or '''Monitor Lines Plot''' command to open the ''SRH-2D Solution Plots'' dialog for a monitor location. Note that the monitor coverage must have been included in the simulation model run. Also note that only one point or line can be selected
 
For an SRH-2D structure, in the boundary conditions coverage, select the structure arcs then right-click and select the '''Structure Output Plots''' command to open the ''SRH-2D Solution Plots'' dialog for  SRH-2D structures. Only one structure arc can be selected to access the structure plots.
 
The ''SRH-2D Solution Plots'' dialog is similar for both monitor points or lines, and SRH-2D structures. The dialog has the following options.
*''Simulations'' &ndash; Contains a list of all available simulations where the monitor coverage or boundary conditions coverage was included during the simulation run. Select which of these simulations to include in the plot.
**'''All on''' &ndash; Select to include all available simulations in the plot.
**'''All off''' &ndash; Select to remove all simulations from the plot.
*''Plots'' &ndash; Contains a list of all available solution datasets from the model run. Selected datasets will appear in the plot.
*''X axis''
**''Specify range'' &ndash; Allows specifying the time range of the plot to be viewed. The possible range will be 0 to the length (time in hours) of the simulation.
***''Minimum time'' &ndash; The beginning time range.
***''Maximum time'' &ndash; The ending time range.
*''Y axis''
**''Specify range'' &ndash; Allows specifying the value range of the plot to be viewed. The possible range will be values generated during the simulation run.
***''Minimum value'' &ndash; The beginning value range.
***''Maximum value'' &ndash; The ending value range.
*''Log scale'' &ndash; Change the y-axis to use a log scale.
===Plot Tab===
The ''Plot'' tab of the ''Simulation Plots'' dialog has the following tools:
* Reset View [[File:Home button icon.png|16 px]] &ndash; Restores the plot view to the original view.
* Previous View [[File:Previous view button icon.png|16 px]] &ndash; Moves to the previous plot view.
* Next View [[File:Next view button icon.png|16 px]] &ndash; After moving to a previous view, will move back to a more recent view.
* Pan [[File:Pan Tool.svg|16 px]] &ndash; Allows panning through the plot graph.
* Zoom [[File:Zoom dialog button icon.png|16 px]] &ndash; Allows zooming in and out of the plot graph.
* Edit Plot Properties [[File:Edit plot button icon.png|16 px]] &ndash; Opens a dialog where title, axes, line style, and marker style can be changed.
* Save [[File:Save plot button icon.png| 16 px]] &ndash; Opens a save dialog to export an image of the plot at the current set view.
 
===Table Tab===
One or more ''Table'' tabs may be available. The number of tables is based on the number of select monitor lines or points as well as the available simulations with solution files in the project. The ''Table'' tab will contain a table of the data used to generate the plot.
 
 
{{-}}

Latest revision as of 20:33, 3 October 2024


At release, apply updates here: SMS:Simulations#Monitoring_Data

Monitoring Data

The Simulation Run Queue contains an option for Monitoring Data. Turning on this option activates the tabs underneath for the selected simulation. The tabs are:

  • Command Line – Shows the command line entries for the selected process. Reports errors encountered during the simulation run.
  • Residual Plot – Shows the residual plot for the selected simulation.
  • Monitor Point Plot – If monitor points are included in the simulation, this shows a water level -vs- time plot for the point location once the simulation has included the point in the simulation run.
  • Monitor Line Q Plot – If monitor lines are included in the simulation, this shows a plot for the flow rate vs time plot once the simulation has included the line in the simulation run.
  • Monitor Line QS Plot – If monitor lines are included in the simulation, this shows a plot for the sediment discharge vs time plot once the simulation has included the line in the simulation run.

At release, apply changes to this article: SMS:SRH-2D Plots

Run Queue Plots

While the simulation is running, plots which are monitoring the progress and stability of the simulation can be viewed by clicking on the SRH-2D process link in the Simulation Run Queue. The plots that are available in the run queue include:

  • Net_Q/INLET_Q – This is a measure of the percentage of flow entering the simulation relative to the flow that leaves the simulation at a given time. To be more specific, the equation that SRH-2D uses to compute this quantity is (Exterior Boundary Outflow - Exterior Boundary Inflow) / Total Inflow.
    • Terms
      • Exterior Boundary Outflow: all flow leaving the domain over Exit-H or Exit-Q boundaries.
      • Exterior Boundary Inflow: all flow entering the domain over Inlet-Q boundaries.
      • Total Inflow: Exterior Boundary Inflow minus summation of interior Sink boundaries
    • Examples
      • -100% means all the flow that entered the simulation at this time stayed in the simulation
      • 0% means the same amount of flow exited during this time step as entered
      • >0% means more flow left the simulation than entered it.
    • Considerations
      • Exit-H boundaries can become inflow boundaries for transient runs in situations such as a flood tide. This negative outflow complicates the calculations.
      • Sink boundaries are specified with a positive value. Source boundaries are simply specified as sink boundaries with a negative value.
      • Boundaries that change flow rates over time, such as Exit-H boundaries or sink boundaries with rating curves make the interpretation of this plot for complicated.
  • Mass Balance – Includes mass loss percentage -vs- time and average mass loss percentage -vs- time.
  • Monitor Points WSE – Monitor point water level -vs- time. Will display one plot for each monitor point in the simulation.
  • Monitor Points Z – Monitor point ground level -vs- time. Will display one for each monitor point in the simulation. This plot is not meaningful unless the simulation includes sediment transport.
  • Monitor Q Lines – Monitor line flow rate flux vs time. Will display one plot for each monitor line in the simulation.
  • Monitor QS Lines – Monitor line sediment discharge flux vs time. Will display one plot for each monitor line in the simulation.

Simulation Plots

Once a simulation is complete, it is useful to be able to review the plots for the simulation as quality check on the simulation and model review. In the SRH-2D simulation right-click menu, using the Tools | View Simulation Plots command brings up the SRH-2D Solution Plots dialog. This dialog provides a list of solution plots that were generated during the model run. The list of available plots in on the left side of the dialog. Once a plot is selected from the list, the plot will be shown in the plot window on the right side of the dialog.

All of the plots that were available during the simulation execution in the run queue are also available in the simulation tools. However, these plots are now displayed in a plot window (rather than the Run Queue) and have additional options for viewing the plot. The options include:

  • X axis
    • Specify range – Allows specifying the time range of the plot to be viewed. The possible range will be 0 to the length (time in hours) of the simulation.
      • Minimum time – The beginning time range.
      • Maximum time – The ending time range.
  • Y axis
    • Specify range – Allows specifying the value range of the plot to be viewed. The possible range will be values generated during the simulation run.
      • Minimum value – The beginning value range.
      • Maximum value – The ending value range.
  • Log scale – Change the y-axis to use a log scale.

The plot window has the following tools:

  • Reset View Home button icon.png – Restores the plot view to the original view.
  • Previous View Previous view button icon.png – Moves to the previous plot view.
  • Next View Next view button icon.png – After moving to a previous view, will move back to a more recent view.
  • Pan Pan Tool.svg – Allows panning through the plot graph.
  • Zoom Zoom dialog button icon.png – Allows zooming in and out of the plot graph.
  • Edit Plot Properties Edit plot button icon.png – Opens a dialog where title, axes, line style, and marker style can be changed.
  • Save Save plot button icon.png – Opens a save dialog to export an image of the plot at the current set view.


Monitor and Structure Plots

In addition to the simulation plots, plots for structures can also be generated in review mode. These plots are accessed by selecting the map module arc associated with structure in the boundary condition or monitor arc in the monitor coverage.

SMS can generate a solution plot at a monitoring location or at a structure location. The plot will use the solution datasets generated during the model run. If the coverage was edited after running SRH-2D, rerun SRH-2D with the updated coverage to ensure that the plot is consistent with the SRH-2D outputs.

For a monitoring point or line, in the monitor coverage, select the monitoring point or line then right-click and select the Monitor Points Plot or Monitor Lines Plot command to open the SRH-2D Solution Plots dialog for a monitor location. Note that the monitor coverage must have been included in the simulation model run. Also note that only one point or line can be selected

For an SRH-2D structure, in the boundary conditions coverage, select the structure arcs then right-click and select the Structure Output Plots command to open the SRH-2D Solution Plots dialog for SRH-2D structures. Only one structure arc can be selected to access the structure plots.

The SRH-2D Solution Plots dialog is similar for both monitor points or lines, and SRH-2D structures. The dialog has the following options.

  • Simulations – Contains a list of all available simulations where the monitor coverage or boundary conditions coverage was included during the simulation run. Select which of these simulations to include in the plot.
    • All on – Select to include all available simulations in the plot.
    • All off – Select to remove all simulations from the plot.
  • Plots – Contains a list of all available solution datasets from the model run. Selected datasets will appear in the plot.
  • X axis
    • Specify range – Allows specifying the time range of the plot to be viewed. The possible range will be 0 to the length (time in hours) of the simulation.
      • Minimum time – The beginning time range.
      • Maximum time – The ending time range.
  • Y axis
    • Specify range – Allows specifying the value range of the plot to be viewed. The possible range will be values generated during the simulation run.
      • Minimum value – The beginning value range.
      • Maximum value – The ending value range.
  • Log scale – Change the y-axis to use a log scale.

Plot Tab

The Plot tab of the Simulation Plots dialog has the following tools:

  • Reset View Home button icon.png – Restores the plot view to the original view.
  • Previous View Previous view button icon.png – Moves to the previous plot view.
  • Next View Next view button icon.png – After moving to a previous view, will move back to a more recent view.
  • Pan Pan Tool.svg – Allows panning through the plot graph.
  • Zoom Zoom dialog button icon.png – Allows zooming in and out of the plot graph.
  • Edit Plot Properties Edit plot button icon.png – Opens a dialog where title, axes, line style, and marker style can be changed.
  • Save Save plot button icon.png – Opens a save dialog to export an image of the plot at the current set view.

Table Tab

One or more Table tabs may be available. The number of tables is based on the number of select monitor lines or points as well as the available simulations with solution files in the project. The Table tab will contain a table of the data used to generate the plot.