SMS:CMS-Flow Menu: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
The [[SMS:CMS-Flow|CMS-Flow]] graphical interface includes tools to assist with creating, editing, and debugging a [[SMS:CMS-Flow|CMS-Flow]] model. The [[SMS:CMS-Flow|CMS-Flow]] interface exists as a simulation. The simulation requires components in the [[SMS:Quadtree Module|Quadtree module]] and the [[SMS:Map Module|Map module]].
The [[SMS:CMS-Flow|CMS-Flow]] graphical interface includes tools to assist with creating, editing, and debugging a [[SMS:CMS-Flow|CMS-Flow]] model. The [[SMS:CMS-Flow|CMS-Flow]] interface exists as a simulation. The simulation requires components in the [[SMS:Quadtree Module|Quadtree module]] and the [[SMS:Map Module|Map module]].


==CMS-Flow Menu==
The interface consists of a right-click CMS-Flow simulation menu  and CMS-Flow coverage righ-click menus with model specific commands and visualization tools for setting up a simulation and analyzing the datasets computed by the model.   
The interface consists of a right-click CMS-Flow simulation menu  and CMS-Flow coverage righ-click menus with model specific commands and visualization tools for setting up a simulation and analyzing the datasets computed by the model.   


===CMS-Flow Simulation Right-Click Menu===
==CMS-Flow Simulation Right-Click Menu==
The simulation right-click menu includes the [[SMS:Simulations#Simulation Menu|general simulation commands]] '''Delete''', '''Duplicate''', and '''Rename''' along with the following model specific commands:
The simulation right-click menu includes the [[SMS:Simulations#Simulation Menu|general simulation commands]] '''Delete''', '''Duplicate''', and '''Rename''' along with the following model specific commands:


'''Model Control'''  
; '''Model Control''' : Brings up the [[SMS:CMS-Flow Model Control|CMS-Flow ''Model Control'']] dialog. The dialog allows viewing and editing the current parameters that affect how CMS-Flow runs and what options are to be included in the current simulation.
<blockquote style="margin-top:0px; margin-bottom:0px;">
; '''Model Check''' : The [[SMS:CMS-Flow_Simulation#CMS-Flow_Model_Check|CMS-Flow Model Check]] performs a number of checks on the simulation to ensure a valid model.  
Brings up the [[SMS:CMS-Flow Model Control|CMS-Flow ''Model Control'']] dialog. The dialog allows viewing and editing the current parameters that affect how CMS-Flow runs and what options are to be included in the current simulation.
; '''Export CMS-Flow''' : Tells SMS that it is time to write out the files that CMS-Flow needs to run. Note that the project must be saved before the files may be exported. The user will not see anything happen, but SMS uses the input information from the model control, the boundary conditions, and quadtree data to create the files in preparation for CMS-Flow to work.
</blockquote>
; '''Launch CMS-Flow''' : When the model is ready and has been exported, it may be launched. Launching CMS-Flow initiates the model run for the simulation. Upon successful completion of the launch, the analysis is complete and results are ready to be read and displayed by SMS.
'''Model Check'''  
; '''Save, Export, and Launch CMS-Flow''' : This is a combination of the previous steps put together into one.
<blockquote style="margin-top:0px; margin-bottom:0px;">
The [[SMS:CMS-Flow_Simulation#CMS-Flow_Model_Check|CMS-Flow Model Check]] performs a number of checks on the simulation to ensure a valid model.  
</blockquote>
'''Export CMS-Flow'''  
<blockquote style="margin-top:0px; margin-bottom:0px;">
Tells SMS that it is time to write out the files that CMS-Flow needs to run. Note that the project must be saved before the files may be exported. The user will not see anything happen, but SMS uses the input information from the model control, the boundary conditions, and quadtree data to create the files in preparation for CMS-Flow to work.
</blockquote>
'''Launch CMS-Flow'''  
<blockquote style="margin-top:0px; margin-bottom:0px;">
When the model is ready and has been exported, it may be launched. Launching CMS-Flow initiates the model run for the simulation. Upon successful completion of the launch, the analysis is complete and results are ready to be read and displayed by SMS.
</blockquote>
'''Save, Export, and Launch CMS-Flow'''  
<blockquote style="margin-top:0px; margin-bottom:0px;">
This is a combinination of the previous steps put together into one.
</blockquote>


===Boundary Condition Coverage Right-Click Menu===
==Boundary Condition Coverage Right-Click Menu==
When clicking on the CMS-Flow boundary condition coverage in the Project Explorer, the coverage has the standard coverage menu. After creating feature arcs in the coverage, the '''Select Feature Arcs''' [[File:Select Feature Arc icon.png]] tool can be used to bring up a right-click menu. This menu has the following additional command when the CMS-Flow boundary condition coverage is active.
When clicking on the CMS-Flow boundary condition coverage in the Project Explorer, the coverage has the standard coverage menu. After creating feature arcs in the coverage, the '''Select Feature Arcs''' [[File:SMS Select Arc Tool.svg|16 px]] tool can be used to bring up a right-click menu. This menu has the following additional command when the CMS-Flow boundary condition coverage is active.


'''Assign Boundary Conditions'''  
; '''Assign Boundary Conditions''' : Brings up the [[SMS:CMS-Flow_Coverages#Arc_Boundary_Conditions_Dialog|CMS-Flow ''Arc Buondary Conditions'']] dialog where boundary condition parameters can be assigned to the selected arc.
<blockquote style="margin-top:0px; margin-bottom:0px;">
Brings up the [[SMS:CMS-Flow_Coverages#Arc_Boundary_Conditions_Dialog|CMS-Flow ''Arc Buondary Conditions'']] dialog where boundary condition parameters can be assigned to the selected arc.
</blockquote>


===Save Points Coverage Right-Click Menu===
==Save Points Coverage Right-Click Menu==
The [[SMS:CMS-Flow_Coverages#Save_Points|CMS-Flow save points]] coverage has additional right-click menu commands for both the coverage and for feature points created in the coverage.
The [[SMS:CMS-Flow_Coverages#Save_Points|CMS-Flow save points]] coverage has additional right-click menu commands for both the coverage and for feature points created in the coverage.


Right-clicking on the save points coverage in the Project Explorer has the following additional menu command:
Right-clicking on the save points coverage in the Project Explorer has the following additional menu command:


'''Properties'''  
;'''Properties''' : Brings up the [[SMS:CMS-Flow_Coverages#Save_Points_Properties_Dialog|''Save Points Properties'']] dialog where the data type that will be collected in during the model run can be specified.
<blockquote style="margin-top:0px; margin-bottom:0px;">
Brings up the [[SMS:CMS-Flow_Coverages#Save_Points_Properties_Dialog|''Save Points Properties'']] dialog where the data type that will be collected in during the model run can be specified.
</blockquote>


Using the '''Select Feature Point''' [[File:SMS Select Node Tool.svg|15 px]] tool, right-clicking on a feature point in the CMS-Flow save points coverage will show the following additional menu command:
Using the '''Select Feature Point''' [[File:SMS Select Node Tool.svg|15 px]] tool, right-clicking on a feature point in the CMS-Flow save points coverage will show the following additional menu command:


'''Assign Save Points'''
;'''Assign Save Points''' : Brings up the [[SMS:CMS-Flow_Coverages#Assign_Save_Points|''Assign Save Points'']] dialog where the type of data the feature point will gather can be specified.
<blockquote style="margin-top:0px; margin-bottom:0px;">
Brings up the [[SMS:CMS-Flow_Coverages#Assign_Save_Points|''Assign Save Points'']] dialog where the type of data the feature point will gather can be specified.
</blockquote>


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

Latest revision as of 22:20, 18 January 2022

The CMS-Flow graphical interface includes tools to assist with creating, editing, and debugging a CMS-Flow model. The CMS-Flow interface exists as a simulation. The simulation requires components in the Quadtree module and the Map module.

The interface consists of a right-click CMS-Flow simulation menu and CMS-Flow coverage righ-click menus with model specific commands and visualization tools for setting up a simulation and analyzing the datasets computed by the model.

CMS-Flow Simulation Right-Click Menu

The simulation right-click menu includes the general simulation commands Delete, Duplicate, and Rename along with the following model specific commands:

Model Control
Brings up the CMS-Flow Model Control dialog. The dialog allows viewing and editing the current parameters that affect how CMS-Flow runs and what options are to be included in the current simulation.
Model Check
The CMS-Flow Model Check performs a number of checks on the simulation to ensure a valid model.
Export CMS-Flow
Tells SMS that it is time to write out the files that CMS-Flow needs to run. Note that the project must be saved before the files may be exported. The user will not see anything happen, but SMS uses the input information from the model control, the boundary conditions, and quadtree data to create the files in preparation for CMS-Flow to work.
Launch CMS-Flow
When the model is ready and has been exported, it may be launched. Launching CMS-Flow initiates the model run for the simulation. Upon successful completion of the launch, the analysis is complete and results are ready to be read and displayed by SMS.
Save, Export, and Launch CMS-Flow
This is a combination of the previous steps put together into one.

Boundary Condition Coverage Right-Click Menu

When clicking on the CMS-Flow boundary condition coverage in the Project Explorer, the coverage has the standard coverage menu. After creating feature arcs in the coverage, the Select Feature Arcs SMS Select Arc Tool.svg tool can be used to bring up a right-click menu. This menu has the following additional command when the CMS-Flow boundary condition coverage is active.

Assign Boundary Conditions
Brings up the CMS-Flow Arc Buondary Conditions dialog where boundary condition parameters can be assigned to the selected arc.

Save Points Coverage Right-Click Menu

The CMS-Flow save points coverage has additional right-click menu commands for both the coverage and for feature points created in the coverage.

Right-clicking on the save points coverage in the Project Explorer has the following additional menu command:

Properties
Brings up the Save Points Properties dialog where the data type that will be collected in during the model run can be specified.

Using the Select Feature Point SMS Select Node Tool.svg tool, right-clicking on a feature point in the CMS-Flow save points coverage will show the following additional menu command:

Assign Save Points
Brings up the Assign Save Points dialog where the type of data the feature point will gather can be specified.

Related Topics