SMS:Generic Model Graphical Interface

From XMS Wiki
Revision as of 23:17, 30 November 2012 by Jcreer (talk | contribs) (→‎Define Model)
Jump to navigationJump to search

The Generic Model Graphical Interface includes tools to assist with creating, editing and debugging a Generic Model. The Generic Model interface exists in the Mesh Module.

Define Model

The Define Model Dialog is used to setup the options that apply to the simulation as a whole.

  • Model Parameters
  • Global Parameters
  • Boundary Conditions
  • Material Properties
  • Lock Model Definition with Key

Boundary Conditions

All numeric models require boundary condition data. Generic Mesh Model boundary conditions can be defined on nodestrings, nodes, and elements. An entity (nodestring, node, or element) may have multiple boundary conditions set. To add or remove a boundary condition, select a node, nodestring, or element. Then right click and select assign BC. A dialog with a tree item appears listing all possible boundary conditions. Checked tree items are active boundary conditions. Toggle the tree items as desired to activate/deactivate boundary conditions. The settings in Display→Display Options will determine how the boundary conditions are displayed.

The model developer can define boundary conditions as constant or as dynamic. This is stored in the BD card as the next to last field. The user can also assing multiple boundary conditions to nodes, nodestrings, and elements.To add or remove a boundary condition, select a node, nodestring, or element. Then right click and select assign BC. A dialog with a tree item appears listing all possible boundary conditions. Checked tree items are assigned. Toggle the tree items as desired to assign/unassign boundary conditions. The settings in Display→Display Options will determine how the boundary conditions are displayed.

Material Properties

Each element is assigned a material type. Material properties describe the hydraulic characteristics of each material type.

Material Parameter Groups are the same as the Global Parameter Groups. To add a new Material Parameter Group, add it in the Global Parameter Group by "Gen2DM" → "Define Model" → "Global Parameters".

Designer /User can choose whether to have a single material group or multiple (1 for each group) by "Gen2DM" → "Define Model" → "Material Properties" → select /unselect "Have a seperate material assignment for each parameter group".

  • Multiple
    • User can change the active group by "Gen2DM" → "Set Active Material Group".
    • Changing the "active material group" effects the display and assignment of materials.
    • In the "Gen2DM" → "Material Properties" dialog, only the active/assigned materials are displayed.
  • Single
    • "Set Active Material Group" menu is hidden under the "Gen2DM" menu
    • In the "Gen2DM" → "Material Properties" dialog, all materials are displayed. The tabs across the top correspond to the Groups.

Dependencies

The generic model interface lets a generic model designer create a custom interface by setting up input parameters for their model.

The parameters may be global parameters, bc parameters (applied to node, element, or nodestring), or material parameters.

It is often useful to have certain parameters displayed only in some situations.

For example, the numeric engine may support manning values by depth or a single manning value for all depths. If the user chooses to use manning values by depth he or she would need to provide a curve for manning values based upon depth. If the user chooses to do a single manning value he or she would need to provide a single manning value.

This manning example could be expanded another level. Suppose the manning value mentioned above was part of the material properties for each material. Also, suppose that the engine supported chezy as well as manning to represent roughness but this had to be applied at a global level. If the global parameter is chezy, the material properties dialog should only show the option to enter a chezy value. If the global parameter is manning, the material properties dialog would let the user choose whether to provide this using a single value or a curve by depth. The controls would work as described in the preceding paragraph.

The generic model designer can use dependencies to accomplish both situations above. Dependencies show/hide parameters based upon the setting of a parent parameter. The parent parameter must be before the child parameter. If the child parameter is a material or boundary condition parameter, the parent can also be a global parameter.

Dependencies are controlled on the child level when defining the model. To assign a dependency the parent and child parameters must exist and the parent must have its options defined. Dependencies are specified by clicking on the "None" button in the dependency column for the child parameter. You specify the parent you want to use for this parameter whether a global parameter or local (whatever level you currently are defining). Then check the boxes next to the parent parameters that will allow the child parameter to be visible. A child option may be visible for several parent options.

Whenever a parent object is invisible all children that are dependent upon the option are also invisible.

Overview

The designer/user can define whether the curves in their model are interpolated to the timestep duration or not.

Saving the Model

The Generic Model Files are written automatically with the SMS project file or can be saved separately using the File | Save Mesh or File | Save As menu commands. See Generic Model Files for more information on the files used for the Generic Model run.

Generic Model Menu

See Generic Model Menu for more information.

Related Topics