https://www.xmswiki.com/api.php?action=feedcontributions&user=Morelandtom&feedformat=atomXMS Wiki - User contributions [en]2024-03-29T10:28:39ZUser contributionsMediaWiki 1.39.0https://www.xmswiki.com/index.php?title=GMS:MT3DMS&diff=148760GMS:MT3DMS2021-02-24T16:11:15Z<p>Morelandtom: /* Supported MODFLOW Packages */</p>
<hr />
<div>{{Infobox Model |<br />
|name= MT3DMS <br />
|model_type= 3D Transport Model <br />
|developer= -<br />
|documentation= [http://gmsdocs.aquaveo.com/mt3dms.pdf Old MT3DMS Manual]<br />
[http://gmsdocs.aquaveo.com/mt3dms_v5_supplemental.pdf Current MT3DMS v5.3 Supplemental Manual]<br />
|tutorials= [[GMS:Tutorials#Models|MT3DMS Tutorials]]<br />
}}<br />
{{MT3DMS Links}}<br />
MT3DMS (Modular Transport, 3-Dimensional, Multi-Species model) is a modular three-dimensional transport model for the simulation of advection, dispersion, and chemical reactions of dissolved constituents in groundwater systems (Zheng, 1990). MT3DMS uses a modular structure similar to the structure utilized by MODFLOW. MT3DMS is used in conjunction with [[GMS:MODFLOW|MODFLOW]] in a two step flow and transport simulation. Heads and cell-by-cell flux terms are computed by MODFLOW during the flow simulation and are written to a specially formatted HFF file (referenced by the LMT file). Note: MODFLOW will produce these files even if transport is turned off. These files are then read by MT3DMS and utilized as the flow field for the transport portion of the simulation.<br />
<br />
==Background==<br />
<br />
MT3DMS is a newer version of the old MT3D model that was distributed with earlier versions of GMS. GMS 8.0 and later now run MT3DMS version 5.3 (built in Feb 2010). MT3DMS differs from MT3D in that it allows for multi-species transport, supports additional solvers, and allows for cell-by-cell input of all model parameters.<br />
<br />
The [[GMS:RT3D|RT3D]], [[GMS:SEAM3D|SEAM3D]] and [[GMS:PHT3D|PHT3D]] models are special versions of MT3DMS that have been customized to simulate reactive transport problems. The interfaces to MT3DMS, RT3D, SEAM3D and PHT3D are all contained in the ''MT3DMS'' menu. [[GMS:MT3D-USGS|MT3D-USGS]] is another version of MT3D released in 2016 that includes the functionality of MT3DMS plus additional capabilities and packages.<br />
<br />
A complete description of MT3DMS is beyond the scope of this reference manual. It is assumed that the reader has a basic knowledge of MT3DMS and is familiar with the MT3DMS [http://gmsdocs.aquaveo.com/mt3dms.pdf original] and [http://gmsdocs.aquaveo.com/mt3dms_v5_supplemental.pdf supplementary] documentation (Zheng, 1990). Only the details of the GMS graphical interface to MT3DMS are described in these pages.<br />
<br />
==MT3DMS in GMS==<br />
<br />
A special version of MT3DMS is distributed with GMS, and the model is included with all [http://www.aquaveo.com/software/gms-pricing paid editions] of GMS. <br />
<br />
This version of MT3DMS has been modified to output [[GMS:Dataset Files|GMS dataset files]]. GMS supports MT3DMS as a pre- and post-processor where the input data for MT3DMS is generated by GMS and saved to a set of files. These files are then read by MT3DMS when MT3DMS is executed from the [[GMS:MT3DMS Commands|GMS menu]]. The output super file (*.mts) generated from MT3DMS is then imported to GMS for [[GMS:MODFLOW#Post Processing|post-processing]] and viewing.<br />
<br />
==MT3DMS Run Options==<br />
MT3DMS requires using solution files generated from a MODFLOW model run. An option is provided to use MODFLOW solution files completed from previous model runs using the ''Run Options'' dialog.<br />
[[File:MT3DMS RunOptions.png|thumb|none|200|The ''Run Options'' dialog]]<br />
<br />
==Supported MODFLOW Packages==<br />
<br />
MT3DMS v5.3 supports the following MODFLOW packages that are also supported in GMS: BAS6, BCF, LAK, LPF, HUF, HFB, CHD, WEL, DRN, RIV, GHB, RCH, EVT, STR, MNW, DRT, and ETS.<br />
<br />
==MT3DMS Files==<br />
<br />
Here are tables of some of the available input and output files for MT3DMS.<br />
<br />
* For more information on these files see the [http://gmsdocs.aquaveo.com/mt3dms_v5_supplemental.pdf MT3DMS manual].<br />
<br />
{| class="wikitable" <br />
|+'''Input Files'''<br />
!width="40" align="center"|Name<br />
!width="300" align="center"|Description<br />
|-<br />
|MTS||MT3DMS Super File<br />
|-<br />
|BTN||[[GMS:Basic Transport Package Dialog|Basic Transport Package File]]<br />
|-<br />
|ADV||Advection Package File<br />
|-<br />
|DSP||Dispersion Package File<br />
|-<br />
|SSM||Sink and Source Mixing Package File<br />
|-<br />
|RCT||Chemical Reactions Package File<br />
|-<br />
|GCG||Generalized Conjugate Gradient Solver Package File<br />
|-<br />
|TOB||Transport Observation Package File<br />
|-<br />
|PHC||PHT3D-PHREEQC Interface Package File<br />
|-<br />
|HSS||Hydrocarbon Spill Source Time-Varying Package File<br />
|}<br />
<br />
{| class="wikitable"<br />
|+'''Output Files'''<br />
!align="center" width="50"|Name<br />
!width="350"|Description<br />
|-<br />
|OUT||Model Output Text File<br />
|-<br />
|CNF||Model Spatial Discretization Configuration File<br />
|-<br />
|UCN||Unformatted Concentration (Dissolved Phase) File<br />
|-<br />
|UCN||Unformatted Concentration (Sorbed/Immobile Phase) File<br />
|-<br />
|OBS||Concentration Observation File<br />
|-<br />
|MAS||Mass Budget Summary File<br />
|-<br />
|OCN||Output Concentration File<br />
|-<br />
|MTR||Unformatted Concentration (Sorbed/Immobile Phase) File<br />
|-<br />
|PST||Binary Post-Processing File<br />
|-<br />
|MAS||Mass Budget Summary File<br />
|}<br />
<br />
==MT3DMS Links==<br />
*[[GMS:MT3DMS Packages|MT3DMS Packages]]<br />
*[[GMS:Basic Transport Package Dialog|MT3DMS Basic Transport Package Dialog]]<br />
*[[GMS:Building an MT3DMS Simulation|Building an MT3DMS Simulation]]<br />
*[[GMS:Saving an MT3DMS Simulation|Saving an MT3DMS Simulation]]<br />
*[[GMS:Importing an MT3DMS Simulation|Importing an MT3DMS Simulation]]<br />
<br />
==See also==<br />
<br />
*[[GMS:MODFLOW#Building a MODFLOW Model|Building MODFLOW Model]]<br />
<br />
*[[GMS:Stochastic Modeling#Statistical Analysis of Stochastic MODFLOW/MT3DMS solutions|Statistical Analysis of Stochastic MODFLOW/MT3DMS solutions]]<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:MT3DMS]]<br />
[[Category:PHT3D]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SRH-2D_Errors&diff=145393SMS:SRH-2D Errors2020-03-05T23:10:36Z<p>Morelandtom: </p>
<hr />
<div>This is a list of known error messages produced by [[SMS:SRH-2D|SRH-2D]]. These errors will appear during the model run.<br />
<br />
An error may occur during either the Pre-SRH-2D process or during the SRH-2D process. During the run, errors will be listed in the SRH-2D model wrapper. Clicking the PreSRH-2D button in the model wrapper will display results from the pre-processor. Clicking the SRH-2D button will show results from the model run.<br />
<br />
If the model wrapper has been closed, two files are generated recording the model run. Opening the "*_.OUT.dat" or the "*_DIA.dat" files in a text editor will show errors in the model run.<br />
<br />
==List of Error Messages==<br />
The first three columns in the table are sortable. Simply click the small arrows on the right side of the column header to sort in ascending or descending order.<br />
<br />
The columns in the table include:<br />
* ''Location'' indicates whether the error occurs in the SRH-2D Pre-processor or in SRH-2D itself.<br />
* ''Error Code'' gives the Error Code (if any).<br />
* ''Error Text from Model'' gives the full text of the error message. Errors that do not produce any error text will have "no text" in this field.<br />
* ''Description'' gives more details about the error.<br />
* ''Solution'' gives steps necessary to correct the issue.<br />
<br />
{| class="wikitable sortable" style="border:1px solid black;"<br />
! style="width:5%;" | Location<br />
! style="width:5%;" | Error Code<br />
! style="width:25%;" | Error Text from Model<br />
! style="width:25%;" class="unsortable" | Description<br />
! style="width:40%;" class="unsortable" | Solution<br />
<!-- Use the following as a template to add new entries<br />
|-<br />
| location<br />
| code<br />
| text<br />
| description<br />
| solution<br />
--><br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in spline.f90 H<br />
| Time series data used to define inflows/outflows or time varying water surface elevations has issues with how it is defined, such as duplicate times. <br />
| The time series data should only have one data value per defined time. Go to the XY series editor where the time series data is defined and remove any and every duplicate time entry.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in uti_qwin_xyplot.f90 TIME_SIMU <br />
| Inconsistent time control<br />
| The end time is prior to the start time in the model control. Adjust so it is later than the start time.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| unable to open srhhydro file! <br />
| Unable to open srhhydro file<br />
| The path length for the SMS project is too long. Therefore, the SRH-2D preprocessor could not read the exported files from SMS. Reduce the path length to less than 300 characters.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Element ID is not consecutive<br />
| The mesh element ID's have been mismatched since some mesh nodes were modified and not renumbered (which causes SMS to automatically update the mesh element ID's)<br />
| The mesh nodes need to be renumbered using the '''Renumber''' command under the ''Nodes'' menu in the Mesh module<br />
|-<br />
| SRH-2D<br />
| <br />
| No cells cover an obstruction in structure_obstruction.f90<br />
| Obstruction feature area of influence does not cover the centroid of at least one element<br />
| The "Obstruction Width/Diameter:" value in the ''Obstructions Properties'' dialog is set to "0" and/or an obstruction arc is positioned just beyond half the width/diameter defined in the properties from the centroid of a mesh element. <br />
|-<br />
| SRH-2D<br />
| 5<br />
| Stopped in structure_culvert.f90 ICELL error#5<br />
| BC arc mesh snapping does not match inactive material zone snapping<br />
| In SMS v12.1, some paired arc 1D structures require an "unassigned" material zone between the structure arcs. If the material zone snapping does not match the BC arc snapping, there will be element inactivity problems at the face of the structure. Modify the placement of the structure arcs in the boundary condition coverage or unassigned material polygon edges so that the snap preview of the material polygon matches the snap preview of the structure arc. In SMS 12.2 or later, it is not necessary to create the unassigned material polygon to disable the area between the structure arcs because SRH-2D has been modified to do this internally. If encountering this error using 12.2 or later, one possible solution would be to delete the unassigned material polygon, rebuild polygons and double check all polygons to make sure valid material types have been assigned.<br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| More than 99 obstructions exist<br />
| SRH-2D has a built in limit to how many obstructions can be included in a model. Currently this limit is 99. Reduce the number of obstructions to 99 or fewer.<br />
|-<br />
| Pre SRH-2D<br />
| <br />
| Errors from final_touch.f90 **** on MONITOR LINE#n<br> a face cannot be found given two mesh points<br><br />
Two points are: xx xx<br><br />
Check the mesh node list; do this using _SIF.dat file directly!<br />
| Monitor line spans a mesh void (hole)<br />
| Reconfigure the monitor line. Monitor lines cannot span holes in the mesh.<br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| If there is a ''z'' elevation to a bridge arc that is too high in the structures exercise, SRH doesn't run.<br />
| bug<br />
|-<br />
| SRH-2D<br />
| 2<br />
| ALL INLET cells are dry from bc_mdot2.f90! Code may have blow up due to input errors or too-large time step.<br />
| Material polygons near inflow are unassigned<br />
| This occurs when the material coverage has not been linked to the simulation. Also occurs when all material polygons covering the inflow BC are have an "unassigned" material type. This can also occur if no boundary conditions providing an inflow source have been included in the simulation.<br />
|-<br />
| SRH-2D<br />
| <br />
| FATAL ERROR The code diverged; further reduction of time step would help the convergence!<br />
| Too large of a time step<br />
| Reduce the size of the computational time step in the model control<br />
|-<br />
| SRH-2D<br />
| 3<br />
| bad mesh ! Stopped in indx_conn.f<br />
| Problem in mesh, often due to overlapping elements. <br />
| Check if problem cell (element) id is listed. Otherwise, examine mesh quality in SMS.<br />
|-<br />
| SMS<br />
| <br />
| No mesh that matches the scalar set.<br />
| No mesh that matches the scalar set. The solution file does not correspond to the mesh in the project, or node numbering of the mesh has been changed, invalidating the solution.<br />
| Take care when making edits to the mesh and renumbering the nodes. Any previous results will be invalidated when nodes are renumbered.<br />
|-<br />
| <br />
| None<br />
| None<br />
| WSE error directly under the bridge in the form of waves oscillating through the channel<br />
| Use larger, quadrilateral elements in the deepest areas of flow. This could also mean that the piers need to be switched to obstructions. Lowering the time step may also help.<br />
|-<br />
|-<br />
| <br />
| None<br />
| None<br />
| SRH-2D is not recognizing a 1D structure or 2D pressure flow structure. When reviewing the 2D results or output files it does not appear that SRH-2D is using a structure such as a culvert, pressure flow bridge structure, weir, or gate.<br />
| Make sure the pair of arcs in the SRH-2D boundary condition coverage representing the faces of the structure were created in the same topologic direction. (i.e. Both were created left to right looking downstream or both were created right to left downstream.) The direction does not matter, just that both arcs are consistent. Turn on the display of arc "Direction" in the display options for the map arcs. This will add an arrow to the map arcs in the display denoting their topologic direction.<br />
|-<br />
| SMS<br />
| <br />
| The following coverage(s) have an unsupported type and will be converted to area property: ''(Name of Coverage(s) Listed)''<br />
| <br />
| Opening a map file with out an accompanying project file. If the coverage type is under Model (which the .map file provided indicated it was) then the type is stored in the project file so that error will appear when opening just the *.map file.<br />
|-<br />
| SRH-2D<br />
| <br />
| Exit code 0<br />
| Exit code 0<br />
| SRH-2D has stopped or finished (whether "successfully executed" or not), further troubleshooting is required if it has not finished running successfully.<br />
|-<br />
| <br />
| 1<br />
| Error code 1<br />
| srhmat file does not exist<br />
| File didn't export successfully. Make sure materials are assigned in the materials coverage.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| forrtl: severe (157): Program Exception - access violation<br />
| <br />
| Set up file location Preferences to the correct location for SRH-Pre<br />
|-<br />
| PreSRH-2D<br />
| <br />
| MESH-UNIT: Enter one of the following options for the unit of the mesh<br />
| Mesh unit error<br />
| SRH requires that vertical and horizontal units be in either meters or U.S survey feet<br />
|-<br />
| SRH-2D<br />
| 8<br />
| Inconsistent cell ID in mesh_connectivity: maybe due to wrong nodestring<br />
| <br />
| Possibly due to overlapping elements. Also, check snapping of BC arcs.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Stopped in add_nbdf.90 DIS<br />
| Issue with BC nodestrings<br />
| In this case, this issue was from a bug where SMS was exporting the nodestring in the SRHGEOM file incorrectly for two HY8 culvert arcs. SMS was essentially writing the same string of nodes for both the upstream and downstream culvert arcs.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in face_wd.f90 PRESS#1<br />
| Issue with Pressure Flow BC and "Piers"<br />
| In this problem, SRH2D did not allow holes in the mesh that represented bridge piers within the Pressure flow zone. This is only a problem in SMS v.12.1 and the SRH executable supplied with it. SMS 12.2 and the SRH executable supplied with it now allows holes in the mesh within Pressure zones. The same error will also be shown if an "unassigned" material type is specified in the pressure zone, again this is only a problem in SMS v12.1 and the SRH exe supplied with it, 12.2 allows "unassigned" material types in the pressure flow zone.<br />
|-<br />
| SRH-2D<br />
| <br />
| Program Stopped as Mesh is different in RST file<br><br />
One of the following is different:<br><br />
Ncell Nvert Nface Nclfc Nclvt in RESTART file<br><br />
do not match those in the input file<br><br />
Ncell Nvert Nface Nclfc Nclvt<br><br />
in restart file are: 13604 7374 20977 41693 41693<br><br />
in casename.GRD file are: 15459 8277 23735 47225<br><br />
Mesh topology has to be the same for irest>=1 or init_method=3<br />
| Using a restart file that was created with another mesh<br />
| Restart files can only be used with simulations using the exact same mesh.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| Could not find a mesh cell which contains the monitoring point! Check the input of (X Y) coordinates for a monitoring points<br />
| Monitor Point Outside of Mesh<br />
| Monitor point must be somewhere within a mesh element.<br />
|-<br />
| SRH-2D<br />
| 6940<br />
| <br />
| <br />
| Ensure that areas upstream of the upstream culvert location and areas downstream of the downstream culvert location have a valid material type assigned.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in structure_pressure_flow.f90 PARA DISTANCE<br />
| Shape of pressure zone is not acceptable for a parabolic type bridge ceiling<br />
| Ensure that the pressure zone, between the pressure flow arcs, is rectangular in shape<br />
|-<br />
| SRH-2D<br />
| 9669<br />
| Program stopped due to the following:<br />
Wrong IFACE matching occurred in structure_internal.f90 #4<br />
Error Code is: 9669<br />
| Ensure that the area between the pressure zone arcs with overtopping turned on is rectangular in shape and that the elements in between the arcs are quads (rectangles).<br />
| Create a new mesh with a rectangle between pressure flow arcs and which has quads in this area using the patch mesh generation method.<br />
|-<br />
|-<br />
| SRH-2D<br />
| 46631<br />
| Program stopped due to the following:<br />
Wrong IFACE matching occurred in structure_internal.f90 #4<br />
Error Code is: 46631<br />
| Ensure that the area between the pressure zone arcs with overtopping turned on is rectangular in shape and that the elements in between the arcs are quads (rectangles).<br />
| Create a new mesh with a rectangle between pressure flow arcs and which has quads in this area using the patch mesh generation method.<br />
|-<br />
|-<br />
| SRH-2D<br />
| 0<br />
| Program stopped due to the following:<br />
Wrong IFACE matching occurred in structure_internal.f90 #4<br />
Error Code is: 0<br />
| BC arc is not snapped properly between nodes along element edges with varying elevations.<br />
| Either modify the mesh to smooth elevations or redistribute vertices along BC arc and assign elevations that match mesh element edges (the "Scatter | Interpolate to Map" feature can be used to vary elevations along an existing BC arc).<br />
|-<br />
| SRH-2D<br />
| 16026<br />
| Program stopped due to the following: <br />
A downstream Structure nodestring has not set right; structure_culvert.f90 ICELL error#2<br />
Error Code is: 16026<br />
| The 2D mesh around and through the structure is not optimal.<br />
| Re-mesh areas around the structure. Suggestions to optimize the mesh around the structure include creating patched (quadrilateral) elements through the structure from one face to the other. SRH-2D inactivates elements between the structure faces where the 1D flow is computed. Creating quadrilateral elements in the zone between the faces facilitates the process SRH uses to locate and inactivate the flow computations for those elements in the mesh. Configure the mesh such that the structure faces can be created alone a series of element edges that are oriented in the same direction (along a flat and straight line of element edges).<br />
|-<br />
| SRH-2D<br />
| 79<br />
| Program stopped due to the following:<br />
Tailwater WSE exceeded the maximum TW in the Reverse HY8 Table structure_hy8.f90<br />
Error Code is: 79<br />
| Computed water surface elevations near the culvert become extremely high. This could be from too large of a time step, poor mesh quality near the culvert faces, or parts of the mesh were the culvert is applied have higher elevations than what are defined as the inverts defined in the HY-8 culvert definition<br />
| Review mesh quality near the culvert face. Check to ensure that mesh node elevations where culvert faces are applied do not exceed invert elevations as defined in the HY8 culvert definition. Lowering the time step to improve stability around the culvert could also help.<br />
|-<br />
| SRH-2D<br />
| N/A<br />
| forrtl: severe (24): end-of-file during read, unit n, file {your filepath.dat} Image PC Routine Line Source srh2d_3.2_quickwi...Unknown...<br />
| This is usually a generic error indicating something is wrong with the SRH simulation casename.DAT file created by SRH pre. It typically signifies that SRH-Pre did not terminate normally and generate a valid simulation file. The cause of the error could be any number of issues.<br />
| Check for any error messages reported by SRH-pre by going to the SMS model wrapper and clicking on the "PreSRH-2D" line and reviewing the on screen output messages.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Program stopped due to the following: Stopped in read_input2: Mismatch in HY8 ID<br />
| This is a bug in SRH caused by having two culvert crossings defined in the *.hy8 crossing file with certain similarities in their names.<br />
| The temporary workaround until this is fixed is to make all crossing names as different as possible, including the first character of the names. For example, "My Culvert" and "My Culvert1" could cause this error. Change one of the crossings to make it different, something like "My Culvert" and "Two Barrel Wingwall" would resolve the issue.<br />
|-<br />
| SRH-2D<br />
| N/A<br />
| Failed to find a mesh cell which contains the following (x y) points: (X,Y)=<br />
| This is caused when there is a void added to the mesh by deleting a mesh element from the mesh after the mesh has been generated. Creating void by deleting mesh elements may not actually remove the element data from the mesh in SRH-2D. <br />
|If a void is needed in the mesh, it should be created as a polygon in the Mesh Generator coverage and given a mesh type of "None". When a mesh is generated using polygons with the "None" type, a void will be created in the mesh that can be recognized by SRH-2D.<br />
|-<br />
| SRH-2D<br />
| 0<br />
| Program stopped due to the following: IFACE match does not found in structure_culvert.f90 #''n''<br />
| Element configuration around the structure face is causing a mismatch in the transition into or out of the structure.<br />
| It may help to ensure all elements within the two structures are quadrilateral elements. It may also help to ensure that the first row of elements downstream of the downstream structure face and upstream of the upstream structure face are also quadrilateral elements that are "well formed" ("Well formed" elements as in having interior corners as close to 90 degrees as possible).<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Program stopped due to the following: Stopped in read_input2.f90 HY8 Forward_TABLE Line Error<br />
| There is a problem reading the culvert table file. One of the causes of this is that the HY8 file containing the culvert definition does not include a file extension.<br />
| Add a ".hy8" file extension to the culvert defintion filename.<br />
|-<br />
|SRH-2D<br />
|N/A<br />
|forrtl: severe (170): Program Exception - stack overflow<br />
|The simulation is too large for SRH-2D to process. Typically this occurs when running a simulation using sediment transport and a 2D mesh that contains more than 50,000 elements.<br />
|Reduce the number of elements in the 2D mesh and try running the simulation again.<br />
|-<br />
|SRH-2D<br />
| 3<br />
| Not ready in solve.f90 SEDIMENT MODULE<br />
| This errors occurs when sediment transport is being modeled in a project containing 1D hydraulic structures (culverts, weirs, pressure bridges, etc.). SRH-2D cannot model sediment transport in models containing 1D hydraulic structures.<br />
| Either do not use the sediment transport in the model run, or remove the 1D hydraulic structures from the model.<br />
|-<br />
|PreSRH-2D<br />
| 4<br />
| Program stopped due to the following: Stopped in sec_blow NLAY Error Code is: 4<br />
| This errors occurs when sediment transport is on and there are more than the maximum number of allowed sediment layers (9) for one or more sediment materials.<br />
| Reduce the number of sediment layers to 9 or less in each sediment material.<br />
|-<br />
|SRH-2D<br />
| 1<br />
| Program stopped due to the following: Wrong Boundary ID;may due to some boundary mesh points are not in NODESTRING lists in SMS<br />
| This error seems to be related to issues with mesh quality. <br />
| Review mesh quality. Check for elements with very small or very large interior angles (angles less than 10 degrees or greater than 180 degrees. If any are present, make adjustments in the conceptual model (mesh generator coverage) and re-generate the mesh.<br />
|}<br />
<br />
==Related Topics==<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
* [[SMS:Bugfixes|SMS Bugfixes]]<br />
<br />
<br />
{{Navbox SMS}}<br />
<br />
[[Category:SRH-2D|Errors]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SRH-2D_Errors&diff=132491SMS:SRH-2D Errors2017-11-18T22:45:05Z<p>Morelandtom: /* List of Error Messages */</p>
<hr />
<div>This is a list of known error messages produced by [[SMS:SRH-2D|SRH-2D]]. These errors will appear during the model run.<br />
<br />
==List of Error Messages==<br />
The first three columns in the table are sortable. Simply click the small arrows on the right side of the column header to sort in ascending or descending order.<br />
<br />
The columns in the table include:<br />
* ''Location'' indicates whether the error occurs in the SRH-2D Preprocessor or in SRH-2D itself.<br />
* ''Error Code'' gives the Error Code (if any).<br />
* ''Error Text from Model'' gives the full text of the error message. Errors that do not produce any error text will have "no text" in this field.<br />
* ''Description'' gives more details about the error.<br />
* ''Solution'' gives steps necessary to correct the issue.<br />
<br />
{| class="wikitable sortable" style="border:1px solid black;"<br />
! style="width:5%;" | Location<br />
! style="width:5%;" | Error Code<br />
! style="width:25%;" | Error Text from Model<br />
! style="width:25%;" class="unsortable" | Description<br />
! style="width:40%;" class="unsortable" | Solution<br />
<!-- Use the following as a template to add new entries<br />
|-<br />
| location<br />
| code<br />
| text<br />
| description<br />
| solution<br />
--><br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in uti_qwin_xyplot.f90 TIME_SIMU <br />
| Inconsistent time control<br />
| The end time is prior to the start time in the model control. Adjust so it is later than the start time.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| unable to open srhhydro file! <br />
| Unable to open srhhydro file<br />
| The path length for the SMS project is too long. Therefore, the SRH-2D preprocessor could not read the exported files from SMS. Reduce the path length to less than 300 characters.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Element ID is not consecutive<br />
| The mesh element ID's have been mismatched since some mesh nodes were modified and not renumbered (which causes SMS to automatically update the mesh element ID's)<br />
| The mesh nodes needs to be renumbered using the '''Renumber''' command under the ''Nodes'' menu in the Mesh module<br />
|-<br />
| SRH-2D<br />
| <br />
| No cells cover an obstruction in structure_obstruction.f90<br />
| Obstruction feature area of influence does not cover the centroid of at least one element<br />
| The "Obstruction Width/Diameter:" value in the ''Obstructions Properties'' dialog is set to "0" and/or an obstruction arc is positioned just beyond half the width/diameter defined in the properties from the centroid of a mesh element. <br />
|-<br />
| SRH-2D<br />
| 5<br />
| Stopped in structure_culvert.f90 ICELL error#5<br />
| BC arc mesh snapping does not match inactive material zone snapping<br />
| Some paired arc 1D structures require an "unassigned" material zone between the structure arcs. If the material zone snapping does not match the BC arc snapping, there will be element inactivity problems at the face of the structure. <br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| More than 99 obstructions exist<br />
| SRH-2D has a built in limit to how many obstructions can be included in a model. Currently this limit is 99. Reduce the number of obstructions to 99 or fewer.<br />
|-<br />
| Pre SRH-2D<br />
| <br />
| Errors from final_touch.f90 **** on MONITOR LINE#n<br> a face cannot be found given two mesh points<br><br />
Two points are: xx xx<br><br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Monitor line spans a mesh void (hole)<br />
| Reconfigure the monitor line. Monitor lines cannot span holes in the mesh.<br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| If you specify a ''z'' elevation to a bridge arc that is too high in the structures exercise, SRH doesn't run.<br />
| bug<br />
|-<br />
| SRH-2D<br />
| 2<br />
| ALL INLET cells are dry from bc_mdot2.f90! Code may have blow up due to input errors or too-large time step.<br />
| Material polygons near inflow are unassigned<br />
| This occurs when the material coverage has not been linked to the simulation. Also occurs when all material polygons covering the inflow BC are have an "unassigned" material type. This can also occur if no boundary conditions providing an inflow source have been included in the simulation.<br />
|-<br />
| SRH-2D<br />
| <br />
| FATAL ERROR The code diverged; further reduction of time step would help the convergence!<br />
| Too large of a time step<br />
| Reduce the size of the computational time step in the model control<br />
|-<br />
| SRH-2D<br />
| 3<br />
| bad mesh ! Stopped in indx_conn.f<br />
| Problem in mesh, often due to overlapping elements. <br />
| Check if problem cell (element) id is listed. Otherwise, examine mesh quality in SMS.<br />
|-<br />
| SMS<br />
| <br />
| No mesh that matches the scalar set.<br />
| No mesh that matches the scalar set. The solution file does not correspond to the mesh in the project, or node numbering of the mesh has been changed, invalidating the solution.<br />
| Take care when making edits to the mesh and renumbering the nodes. Any previous results will be invalidated when nodes are renumbered.<br />
|-<br />
| <br />
| <br />
| <br />
| WSE error directly under the bridge in the form of waves oscillating through the channel<br />
| Use larger, quadrilateral elements in the deepest areas of flow. This could also mean that the piers need to be switched to obstructions. Lowering the time step may also help.<br />
|-<br />
| SMS<br />
| <br />
| The following coverage(s) have an unsupported type and will be converted to area property: ''(Name of Coverage(s) Listed)''<br />
| <br />
| Opening a map file with out an accompanying project file. If the coverage type is under Model (which the .map file provided indicated it was) then the type is stored in the project file so that error will appear when opening just the *.map file.<br />
|-<br />
| SRH-2D<br />
| <br />
| Exit code 0<br />
| Exit code 0<br />
| SRH-2D has stopped or finished (whether "successfully executed" or not), further troubleshooting is required if it has not finished running successfully.<br />
|-<br />
| <br />
| 1<br />
| Error code 1<br />
| srhmat file does not exist<br />
| File didn't export successfully, Make sure assigned materials in the materials coverage, possibly too many monitoring lines (20 or less okay)<br />
|-<br />
| PreSRH-2D<br />
| <br />
| forrtl: severe (157): Program Exception - access violation<br />
| <br />
| Set up file location Preferences to the correct location for SRH-Pre<br />
|-<br />
| PreSRH-2D<br />
| <br />
| MESH-UNIT: Enter one of the following options for the unit of the mesh<br />
| Mesh unit error<br />
| SRH requires that vertical and horizontal units be in either meters or U.S survey feet<br />
|-<br />
| SRH-2D<br />
| 8<br />
| Inconsistent cell ID in mesh_connectivity: maybe due to wrong nodestring<br />
| <br />
| Possibly due to overlapping elements<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Stopped in add_nbdf.90 DIS<br />
| Issue with BC nodestrings<br />
| In this case, this issue was from a bug where SMS was exporting the nodestring in the SRHGEOM file incorrectly for two HY8 culvert arcs. SMS was essentially writing the same string of nodes for both the upstream and downstream culvert arcs.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in face_wd.f90 PRESS#1<br />
| Issue with Pressure Flow BC and "Piers"<br />
| In this problem, SRH2D did not allow holes in the mesh that represented bridge piers within the Pressure flow zone. This is only a problem in SMS v.12.1 and the SRH executable supplied with it. SMS 12.2 and the SRH executable supplied with it now allows holes in the mesh within Pressure zones. The same error will also be shown if an "unassigned" material type is specified in the pressure zone, again this is only a problem in SMS v12.1 and the SRH exe supplied with it, 12.2 allows "unassigned" material types in the pressure flow zone.<br />
|-<br />
| SRH-2D<br />
| <br />
| Program Stopped as Mesh is different in RST file<br><br />
One of the following is different:<br><br />
Ncell Nvert Nface Nclfc Nclvt in RESTART file<br><br />
do not match those in the input file<br><br />
Ncell Nvert Nface Nclfc Nclvt<br><br />
in restart file are: 13604 7374 20977 41693 41693<br><br />
in casename.GRD file are: 15459 8277 23735 47225<br><br />
Mesh topology has to be the same for irest>=1 or init_method=3<br />
| Using a restart file that was created with another mesh<br />
| Restart files can only be used with simulations using the exact same mesh.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| Could not find a mesh cell which contains the monitoring point! Check if you have the right input of (X Y) coordinates for a monitoring points<br />
| Monitor Point Outside of Mesh<br />
| Monitor point must be somewhere within a mesh element.<br />
|-<br />
| SRH-2D<br />
| 6940<br />
| <br />
| <br />
| Ensure that areas upstream of the upstream culvert location and areas downstream of the downstream culvert location have a valid material type assigned.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in structure_pressure_flow.f90 PARA DISTANCE<br />
| Shape of pressure zone is not acceptable for a parabolic type bridge ceiling<br />
| Ensure that the pressure zone, between the pressure flow arcs, is rectangular in shape<br />
|}<br />
<br />
==Related Topics==<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
* [[SMS:Bugfixes|SMS Bugfixes]]<br />
<br />
<br />
{{Navbox SMS}}<br />
<br />
[[Category:SRH-2D|Errors]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SRH-2D_Errors&diff=132490SMS:SRH-2D Errors2017-11-18T22:43:58Z<p>Morelandtom: /* List of Error Messages */</p>
<hr />
<div>This is a list of known error messages produced by [[SMS:SRH-2D|SRH-2D]]. These errors will appear during the model run.<br />
<br />
==List of Error Messages==<br />
The first three columns in the table are sortable. Simply click the small arrows on the right side of the column header to sort in ascending or descending order.<br />
<br />
The columns in the table include:<br />
* ''Location'' indicates whether the error occurs in the SRH-2D Preprocessor or in SRH-2D itself.<br />
* ''Error Code'' gives the Error Code (if any).<br />
* ''Error Text from Model'' gives the full text of the error message. Errors that do not produce any error text will have "no text" in this field.<br />
* ''Description'' gives more details about the error.<br />
* ''Solution'' gives steps necessary to correct the issue.<br />
<br />
{| class="wikitable sortable" style="border:1px solid black;"<br />
! style="width:5%;" | Location<br />
! style="width:5%;" | Error Code<br />
! style="width:25%;" | Error Text from Model<br />
! style="width:25%;" class="unsortable" | Description<br />
! style="width:40%;" class="unsortable" | Solution<br />
<!-- Use the following as a template to add new entries<br />
|-<br />
| location<br />
| code<br />
| text<br />
| description<br />
| solution<br />
--><br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in uti_qwin_xyplot.f90 TIME_SIMU <br />
| Inconsistent time control<br />
| The end time is prior to the start time in the model control. Adjust so it is later than the start time.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| unable to open srhhydro file! <br />
| Unable to open srhhydro file<br />
| The path length for the SMS project is too long. Therefore, the SRH-2D preprocessor could not read the exported files from SMS. Reduce the path length to less than 300 characters.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Element ID is not consecutive<br />
| The mesh element ID's have been mismatched since some mesh nodes were modified and not renumbered (which causes SMS to automatically update the mesh element ID's)<br />
| The mesh nodes needs to be renumbered using the '''Renumber''' command under the ''Nodes'' menu in the Mesh module<br />
|-<br />
| SRH-2D<br />
| <br />
| No cells cover an obstruction in structure_obstruction.f90<br />
| Obstruction feature area of influence does not cover the centroid of at least one element<br />
| The "Obstruction Width/Diameter:" value in the ''Obstructions Properties'' dialog is set to "0" and/or an obstruction arc is positioned just beyond half the width/diameter defined in the properties from the centroid of a mesh element. <br />
|-<br />
| SRH-2D<br />
| 5<br />
| Stopped in structure_culvert.f90 ICELL error#5<br />
| BC arc mesh snapping does not match inactive material zone snapping<br />
| Some paired arc 1D structures require an "unassigned" material zone between the structure arcs. If the material zone snapping does not match the BC arc snapping, there will be element inactivity problems at the face of the structure. <br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| More than 99 obstructions exist<br />
| SRH-2D has a built in limit to how many obstructions can be included in a model. Currently this limit is 99. Reduce the number of obstructions to 99 or fewer.<br />
|-<br />
| Pre SRH-2D<br />
| <br />
| Errors from final_touch.f90 **** on MONITOR LINE#n<br> a face cannot be found given two mesh points<br><br />
Two points are: xx xx<br><br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Monitor line spans a mesh void (hole)<br />
| Reconfigure the monitor line. Monitor lines cannot span holes in the mesh.<br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| If you specify a ''z'' elevation to a bridge arc that is too high in the structures exercise, SRH doesn't run.<br />
| bug<br />
|-<br />
| SRH-2D<br />
| 2<br />
| ALL INLET cells are dry from bc_mdot2.f90! Code may have blow up due to input errors or too-large time step.<br />
| Material polygons near inflow are unassigned<br />
| This occurs when the material coverage has not been linked to the simulation. Also occurs when all material polygons covering the inflow BC are have an "unassigned" material type. This can also occur if no boundary conditions providing an inflow source have been included in the simulation.<br />
|-<br />
| SRH-2D<br />
| <br />
| FATAL ERROR The code diverged; further reduction of time step would help the convergence!<br />
| Too large of a time step<br />
| Reduce the size of the computational time step in the model control<br />
|-<br />
| SRH-2D<br />
| 3<br />
| bad mesh ! Stopped in indx_conn.f<br />
| Problem in mesh often due to overlapping elements. Check in problem cell (element) id is listed.<br />
| Reduce the size of the computational time step in the model control<br />
|-<br />
| SMS<br />
| <br />
| No mesh that matches the scalar set.<br />
| No mesh that matches the scalar set. The solution file does not correspond to the mesh in the project, or node numbering of the mesh has been changed, invalidating the solution.<br />
| Take care when making edits to the mesh and renumbering the nodes. Any previous results will be invalidated when nodes are renumbered.<br />
|-<br />
| <br />
| <br />
| <br />
| WSE error directly under the bridge in the form of waves oscillating through the channel<br />
| Use larger, quadrilateral elements in the deepest areas of flow. This could also mean that the piers need to be switched to obstructions. Lowering the time step may also help.<br />
|-<br />
| SMS<br />
| <br />
| The following coverage(s) have an unsupported type and will be converted to area property: ''(Name of Coverage(s) Listed)''<br />
| <br />
| Opening a map file with out an accompanying project file. If the coverage type is under Model (which the .map file provided indicated it was) then the type is stored in the project file so that error will appear when opening just the *.map file.<br />
|-<br />
| SRH-2D<br />
| <br />
| Exit code 0<br />
| Exit code 0<br />
| SRH-2D has stopped or finished (whether "successfully executed" or not), further troubleshooting is required if it has not finished running successfully.<br />
|-<br />
| <br />
| 1<br />
| Error code 1<br />
| srhmat file does not exist<br />
| File didn't export successfully, Make sure assigned materials in the materials coverage, possibly too many monitoring lines (20 or less okay)<br />
|-<br />
| PreSRH-2D<br />
| <br />
| forrtl: severe (157): Program Exception - access violation<br />
| <br />
| Set up file location Preferences to the correct location for SRH-Pre<br />
|-<br />
| PreSRH-2D<br />
| <br />
| MESH-UNIT: Enter one of the following options for the unit of the mesh<br />
| Mesh unit error<br />
| SRH requires that vertical and horizontal units be in either meters or U.S survey feet<br />
|-<br />
| SRH-2D<br />
| 8<br />
| Inconsistent cell ID in mesh_connectivity: maybe due to wrong nodestring<br />
| <br />
| Possibly due to overlapping elements<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Stopped in add_nbdf.90 DIS<br />
| Issue with BC nodestrings<br />
| In this case, this issue was from a bug where SMS was exporting the nodestring in the SRHGEOM file incorrectly for two HY8 culvert arcs. SMS was essentially writing the same string of nodes for both the upstream and downstream culvert arcs.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in face_wd.f90 PRESS#1<br />
| Issue with Pressure Flow BC and "Piers"<br />
| In this problem, SRH2D did not allow holes in the mesh that represented bridge piers within the Pressure flow zone. This is only a problem in SMS v.12.1 and the SRH executable supplied with it. SMS 12.2 and the SRH executable supplied with it now allows holes in the mesh within Pressure zones. The same error will also be shown if an "unassigned" material type is specified in the pressure zone, again this is only a problem in SMS v12.1 and the SRH exe supplied with it, 12.2 allows "unassigned" material types in the pressure flow zone.<br />
|-<br />
| SRH-2D<br />
| <br />
| Program Stopped as Mesh is different in RST file<br><br />
One of the following is different:<br><br />
Ncell Nvert Nface Nclfc Nclvt in RESTART file<br><br />
do not match those in the input file<br><br />
Ncell Nvert Nface Nclfc Nclvt<br><br />
in restart file are: 13604 7374 20977 41693 41693<br><br />
in casename.GRD file are: 15459 8277 23735 47225<br><br />
Mesh topology has to be the same for irest>=1 or init_method=3<br />
| Using a restart file that was created with another mesh<br />
| Restart files can only be used with simulations using the exact same mesh.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| Could not find a mesh cell which contains the monitoring point! Check if you have the right input of (X Y) coordinates for a monitoring points<br />
| Monitor Point Outside of Mesh<br />
| Monitor point must be somewhere within a mesh element.<br />
|-<br />
| SRH-2D<br />
| 6940<br />
| <br />
| <br />
| Ensure that areas upstream of the upstream culvert location and areas downstream of the downstream culvert location have a valid material type assigned.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in structure_pressure_flow.f90 PARA DISTANCE<br />
| Shape of pressure zone is not acceptable for a parabolic type bridge ceiling<br />
| Ensure that the pressure zone, between the pressure flow arcs, is rectangular in shape<br />
|}<br />
<br />
==Related Topics==<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
* [[SMS:Bugfixes|SMS Bugfixes]]<br />
<br />
<br />
{{Navbox SMS}}<br />
<br />
[[Category:SRH-2D|Errors]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=GMS:TIN_Module&diff=127071GMS:TIN Module2017-08-01T16:08:09Z<p>Morelandtom: </p>
<hr />
<div>{{TIN links}}<br />
TIN stands for Triangulated Irregular Network. TINs are used for surface modeling. TINs are formed by connecting a set of XYZ points with edges to form a network of triangles. TINs can be used to represent the surface of a geologic unit or the surface defined by a mathematical function. <br />
<br />
TINs in GMS can be [[GMS:Creating a TIN|created]] manually, imported, or created from other data objects. By default, GMS uses the Delaunay criterion to [[GMS:Triangulation|triangulate]] TINs.<br />
<br />
GMS provides a variety of [[GMS:TIN Tool Palette|tools]] and [[GMS:TIN Commands|commands]] for [[GMS:Editing a TIN|manipulating]] TINs. TINs can be contoured, displayed in oblique view with mapped images and hidden surfaces removed, and have several other [[GMS:TIN Display Options|display options]] that can be set to visualize and understand the terrain surface better. GMS also contains custom [[GMS:TIN Settings|settings]] for using TINs and allows TINs to be [[GMS:Converting TINS to Other Data Types|converted]] into other types of data, including [[GMS:Building Solids and 3D Meshes with TINs|solid models and 3D meshes]]. Through GMS it is possible to both import and export [[TIN Files|TIN files]].<br />
<br />
Several TINs can be modeled at once in GMS. One of the TINs is designated as the "active" TIN. The selection and [[GMS:Editing a TIN|editing tools]] apply to the active TIN only.<br />
<br />
:[[Image:tins.png|thumb|none|400px|Example of a TIN in GMS]]<br />
<br />
The TIN Module can be added to a [http://www.aquaveo.com/software/gms-pricing paid edition] of GMS.<br />
[[Category:Link to Store]]<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:TINs]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=GMS:TIN_Module&diff=127070GMS:TIN Module2017-08-01T16:07:57Z<p>Morelandtom: </p>
<hr />
<div>{{TIN links}}<br />
TIN stands for Triangulated Irregular Network. TINs are used for surface modeling. TINs are formed by connecting a set of XYZ points with edges to form a network of triangles. TINs can be used to represent the surface of a geologic unit or the surface defined by a mathematical function. <br />
<br />
TINs in GMS can be [[GMS:Creating a TIN|created]] manually, imported, or created from other data objects. By default, GMS uses the Delaunay criterion to [[GMS:Triangulation|triangulate]] TINs.<br />
<br />
GMS provides a variety of [[GMS:TIN Tool Palette|tools]] and [[GMS:TIN Commands|commands]] for [[GMS:Editing a TIN|manipulating]] TINs. TINs can be contoured, displayed in oblique view with mapped images and hidden surfaces removed, and have several other [[GMS:TIN Display Options|display options]] that can be set to visualize and understand the terrain surface better. GMS also contains custom [[GMS:TIN Settings|settings]] for using TINs and allows TINs to be [[GMS:Converting TINS to Other Data Types|converted]] into other types of data, including [[GMS:Building Solids and 3D Meshes with TINs|solid models and 3D meshes]]. Through GMS it is possible to both import and export [[TIN Files|TIN files]].<br />
<br />
Several TINs can be modeled at once in GMS. One of the TINs is designated as the "active" TIN. The selection and [[GMS:Editing a TIN|editing tools]] apply to the active TIN only.<br />
<br />
:[[Image:tins.png|thumb|none|400px|Example of a TIN in GMS]]<br />
<br />
The TIN Module can be added to a [http://www.aquaveo.com/software/gms-pricing paid editions] of GMS.<br />
[[Category:Link to Store]]<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:TINs]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:ADCIRC&diff=123324SMS:ADCIRC2017-05-15T20:07:19Z<p>Morelandtom: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= ADCIRC<br />
|model_type= Finite element hydrodynamic model for coastal oceans, inlets, rivers and floodplains.<br />
|developer= <br />
Rick Luettich <br><br />
Joannes Westerink <br><br />
Randall Kolar <br><br />
Clint Dawson<br />
|web_site= http://www.adcirc.org<br />
|tutorials= <br />
General Section <br><br />
* Data Visualization<br />
* Mesh Editing<br />
* Observation<br />
Models Section <br><br />
* ADCIRC<br />
Several Sample problems can be found on the ADCIRC model developer's [http://adcirc.org/home/documentation/example-problems/ webpage]<br />
}}<br />
<br />
The ADCIRC (Advanced Circulation) model is a finite element hydrodynamic model for coastal oceans, inlets, rivers and floodplains. The initial developers of the code were Rick Luettich (University of North Carolina at Chapel Hill) and Joannes Westerink (University of Notre Dame). Other principal developers include Randall Kolar (University of Oklahoma at Norman) and Clint Dawson (University of Texas at Austin). Various other groups are involved in development and support around the country. <br />
<br />
The ADCIRC model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]] <br />
<br />
== Graphical Interface == <br />
SMS provides a graphical interface that is designed to visualize the projects being created, easily modify project parameters, and view the solutions produced by the ADCIRC model (for example, SMS 12.1 comes with ADCIRC [http://adcirc.org/home/documentation/users-manual-v50/ version 50]). See [[SMS:ADCIRC Graphical Interface|ADCIRC Graphical Interface]] for more information.<br />
<br />
The [[SMS:ADCIRC Graphical Interface|ADCIRC Graphical Interface]] contains tools to create and edit an ADCIRC simulation. The simulation consists of a geometric definition of the model domain (the mesh) and a set of numerical parameters. The parameters define the boundary conditions and options pertinent to the model.<br />
<br />
The interface is accessed by selecting the [[SMS:Mesh Module|2D Mesh Module]] and setting the current model to ADCIRC. If a mesh has already been created for a ADCIRC simulation or an existing simulation read, the mesh object will exist in the [[SMS:Project Explorer|Project Explorer]] and selecting that object will make the 2D Mesh module active and set the model to ADCIRC. See the [[SMS:Mesh Module|Mesh Module]] documentation for guidance on building and editing meshes as well as visualizing mesh results.<br />
<br />
The interface consists of the [[SMS:2D Mesh_Module_Menus|2D mesh module menus]] and [[SMS:2D Mesh Module Tools|tools]] augmented by the [[SMS:ADCIRC Menu|''ADCIRC'' menu]]. See [[SMS:ADCIRC Graphical Interface|ADCIRC Graphical Interface]] for more information.<br />
<br />
==ADCIRC Files==<br />
The list of files (both input and output) that may be associated with an ADCIRC simulation is quite long. The [http://adcirc.org/home/documentation/users-manual-v50/input-file-descriptions ADCIRC.org] web site lists all of these with details describing format and purpose. A brief summary of the most common file types is included here:<br />
====Input files==== <br />
<br />
* Required<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* fort.14: Grid file &ndash; Saved as ''proj_name''.grd by SMS and copied to fort.14 for use in an ADCIRC run.<br />
* fort.15: Control file &ndash; Saved as ''proj_name''.ctl by SMS and copied to fort.15 for use in an ADCIRC run.<br />
</blockquote><br />
* Optional<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* fort.13: Nodal or Spatial attributes<br />
* fort.19: Specified water surfaces (non-periodic elevation)<br />
* fort.20: Specified flow rates (non-periodic flow/flux such as a river)<br />
* fort.22, fort.2**: Meteorologic conditions (winds and atmospheric pressure) &ndash; Several formats depending on the option being used <br />
* fort.23: Wave radiation stress forcing<br />
</blockquote><br />
<br />
====Output files====<br />
* Diagnostic<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* fort.6 &ndash; Screen output<br />
* fort.16 &ndash; General information<br />
* fort.18 &ndash; Parallel file<br />
* fort.33 &ndash; ITPACKV 2D Solver convergence issue information<br />
</blockquote><br />
* Global<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* fort.63 or fort.63.nc &ndash; Water surface at each node<br />
* fort.64 or fort.64.nc &ndash; Velocity components at each node<br />
* fort.53 &ndash; Elevation Harmonic constituents at each node <br />
* fort.54 &ndash; Velocity Harmonic constituents at each node <br />
* fort.73 &ndash; Atmospheric pressure at each node <br />
* fort.74 &ndash; Wind stress or velocity at each node <br />
* fort.80 &ndash; Parallel run file<br />
</blockquote><br />
* At observation stations<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* fort.61 &ndash; Water surface at stations <br />
* fort.62 &ndash; Velocity components at stations <br />
* fort.51 &ndash; Elevation Harmonic constituents at stations <br />
* fort.52 &ndash; Velocity Harmonic constituents at stations <br />
* fort.71 &ndash; Atmospheric pressure at stations <br />
* fort.72 &ndash; Wind stress or velocity at stations <br />
</blockquote><br />
<br />
=== Global Output Format ===<br />
Generally, ADCIRC has the ability to output global data in three formats. These include:<br />
* Standard ASCII &ndash; This format loops through the time steps including a value for each node (both node ID and solution value). These files are commonly very large (multiple GB) and can take a significant amount of time to load (sometimes as long as half an hour) because SMS has to process each time step of each dataset and build information about the solution for faster access. When instructing SMS to read a file of this type, SMS recognizes that the ASCII format is not efficient and converts the data to XMDF format in an "h5" file. The name of the XMDF file that will be created can be specified. Multiple standard ascii files can be combined into a single "h5" file. The new "h5" file hase the following advantages:<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* The "h5" file is binary and compressed so it is much smaller than the standard ASCII file.<br />
* SMS can read the "h5" file almost instantaneously because all of the time step information is already compiled and a single time step is retrieved rather than processing the entire dataset.<br />
</blockquote><br />
* Sparse ASCII &ndash; This format loops through the time steps includes a default value for the time step and a number of nodes that don't have this default. Most commonly, the default would be -9999 indicating dry nodes. The file then includes the ''exceptions'' consisting of node ID and solution values for nodes that are not the default value. These lines are identical to the value lines in the standard ASCII format. (This format is supported in SMS starting at version 11.2) SMS converts sparse ASCII files to XMDF files just as it does the standard ASCII files.<br />
* NetCDF &ndash; This format is a binary library format using the NetCDF library. The data can be viewed using an HDF viewer. (This format is supported in SMS starting at version 11.2)<br />
<br />
('''''Note:''''' ADCIRC documentation references a global binary format as an option. These options correspond to NOUT** values of 2 and -2 generally. There is no evidence that this option is functional in the current version of ADCIRC. It has been removed from the SMS interface.)<br />
<br />
== Functionality ==<br />
ADCIRC is a system of computer programs for solving time dependent, free surface circulation and transport problems in two and three dimensions. These programs utilize the finite element method in space allowing the use of highly flexible, unstructured grids. Typical ADCIRC applications have included: (i) modeling tides and wind driven circulation, (ii) analysis of hurricane storm surge and flooding, (iii) dredging feasibility and material disposal studies, (iv) larval transport studies, (v) near shore marine operations.<br />
<br />
ADCIRC (which models wetting and drying) has also been used to model the propagation and inundation of tsunami waves as shown in [https://icce-ojs-tamu.tdl.org/icce/index.php/icce/article/view/7557/pdf_985 this] paper. ADCIRC was also [http://www.caseydietrich.com/swanadcirc/ coupled] with [http://swanmodel.sourceforge.net/unswan/unswan.htm SWAN] outside of SMS to model tsunami inundation in [https://www3.nd.edu/~coast/reports_papers/2011-CE-dzwhetal-swan+adcirc.pdf this] paper.<br />
<br />
For more information about the ADCIRC model visit [http://www.adcirc.org www.adcirc.org].<br />
<br />
==Running ADCIRC in Parallel (PADCIRC)==<br />
SMS 11.2 and later allows running ADCIRC in parallel (PADCIRC) on a single machine to take advantage of multiple cores. This can greatly speed up the runs. Use the following steps to set up a PADCIRC model:<br />
<br />
# Download the MPI (Message Passing Interface) executable found on the [http://www.aquaveo.com/downloads/?tab=2#TabbedPanels SMS downloads page] in the ADCIRC Basic Utilities zip folder.<br />
# To avoid run issues, install the MPI as an administrator and run with administrative privileges.<br />
# In SMS, select ''Edit'' | '''Preferences''' to bring up the ''Preferences'' dialog. <br />
# Select the ''File Locations'' tab<br />
# In the ''Other Files'' section, set the file path for the ''MPIEXEC'' executable.<br />
# Open the [[SMS:ADCIRC Model Control|''ADCIRC Model Control'']] dialog. <br />
#Select the [[SMS:ADCIRC_Model_Control#General_Tab|''General'']] tab in the model control.<br />
#In the ''Processors'' section put the desired number of processors into the ''Computational'' field. <br />
##To find out how many processors (CPU's or cores) the machine can use, right-click on the windows task bar and select '''Task Manager''' to bring up the ''Windows Task Manager''. <br />
##In the task manager, select the ''Performance'' tab and count the number of boxes under the ''CPU Usage History'' section or check the number next to ''Cores''. This will show how many physical processors the computer has. It may also list the number of logical (or virtual) processors if hyper-threading technology is enabled (it may have twice as many CPU's show up as actual physical cores in the hardware).<br />
##Note that running PADCIRC using hyperthreading (specifying more logical processors than physical cores) has not been shown to significantly reduce run time.<br />
# In SMS, run the ADCIRC model and PADCIRC.exe will run instead.<br />
<br />
==Saving ADCIRC==<br />
When using ''File'' | '''Save As...''' the following files get saved in the SMS file.<br />
<br />
* *.mat referenced to new save location<br />
* *.map referenced to new save location<br />
* *.grd referenced to new save location<br />
* *.ctl referenced to new save location<br />
* *.h5 referenced to new save location<br />
* *.dat referenced to new save location<br />
<br />
== Using the Model / Practical Notes ==<br />
It's important to note that ADCIRC is configured to accept only one calendar year’s data, so it is not possible to combine meteorological data from two different calendar years into a single file and then run it (e.g. Dec 2015 and Jan 2016 data could not be combined into a single ADCIRC model).<br />
<br />
There is an ADCIRC listserv that may be useful to keep up-to-date about the latest releases of ADCIRC and to post any questions about ADCIRC. It is [mailto:adcirc@listserv.unc.edu adcirc@listserv.unc.edu]. If wanting to join, please email [mailto:cfulcher@email.unc.edu Crystal Fulcher].<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS Models|SMS Models]]<br />
* [[SMS:LTEA|LTEA &ndash; Linear Truncation Error Analysis]]<br />
* [[SMS:ADCIRC_Database|ADCIRC Database]]<br />
<br />
== External Links ==<br />
* [http://adcirc.org/ ADCIRC Home page]<br />
* Mar 2002 ERDC/CHL CHETN-IV-40 Guidelines for Using Eastcoast 2001 Database of Tidal Constituents within Western North Atlantic Ocean, Gulf of Mexico and Caribbean Sea [http://chl.erdc.usace.army.mil/library/publications/chetn/pdf/chetn-iv-40.pdf]<br />
* Jun 2001 ERDC/CHL CHETN-IV-32 Leaky Internal-Barrier Normal-Flow Boundaries in the ADCIRC Coastal Hydrodynamics Code [http://chl.erdc.usace.army.mil/library/publications/chetn/pdf/chetn-iv-32.pdf]<br />
* Mar 2001 Technical Report CHL-98-32 Shinnecock Inlet, New York, site Investigation Report 4, Evaluation of Flood and Ebb shoal Sediment Source Alternatives for the West of Shinnecock Interim Project, New York [http://smsdocs.aquaveo.com/ADA389994.pdf]<br />
* Dec 1999 Coastal Engineering Technical Note IV-21 Surface-Water Modeling System Tidal Constituents Toolbox for ADCIRC [http://chl.erdc.usace.army.mil/library/publications/chetn/pdf/cetn-iv-21.pdf]<br />
* [http://www.seahorsecoastal.com/wiki/doku.php ADCIRC wiki hosted by Seahorse Coastal Consulting]<br />
* [http://water.engr.psu.edu/hill/research/glba/default.stm Glacier Bay Test Case by Dave F. Hill]<br />
* [http://www.coe.ou.edu/emgis/kolar/resources/TechReport0401.pdf Assessment of ADCIRC's Wetting and Drying Algorithm]<br />
* [https://www.youtube.com/watch?v=zJvEHLwARN8 Video demonstration of using ADCIRC in SMS]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|ADCIRC]]<br />
[[Category:ADCIRC|ADCIRC]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=122018SMS:SMS Models2017-03-30T18:55:21Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>{{TOCright}}<br />
[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of SMS. A comparison chart of the ''CIRP Numerical Model Tools and Capabilities'' (BOUSS-2D, CMS-Flow, CMS-Wave, GenCade, and PTM) can be found [https://web.archive.org/web/20150926110541/http://cirp.usace.army.mil/techtransfer/meetings/RARG2012/CIRP_Brochure-April2012.pdf in the 2012 CIRP Brochure].<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic Model Graphical Interface|generic model interface]] in cooperation with Aquaveo<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
*[[SMS:RiverFlow2D|RiverFlow2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW FV|TUFLOW FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:HEC-RAS|HEC-RAS]] &ndash; Developed at the Hydrologic Engineering Center for the U.S. Army Corps of Engineers.<br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE including [[SMS:RMA2|RMA2]] and [[SMS:RMA4|RMA4]]<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic Model|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. There are partial interfaces with the following:<br />
<blockquote style="margin-top:0px; margin-bottom:0px;"><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:TUFLOW FV|TUFLOW FV]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v12.2<br />
!style="background: #cccccc;" width="100"| SMS v12.1<br />
!style="background: #cccccc;" width="100"| SMS v12.0<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 52.30 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 51.33 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.5 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 4.5 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 4.4 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.4 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.2 --><br />
|style="background: #ececec;"| <!-- SMS v12.1 --><br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v12.2 --><br />
|style="background: #ececec;"| <!-- SMS v12.1 --><br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| 4.01.52 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 4.01.52 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| v1r6 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| v1r6 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HEC-RAS|HEC-RAS]]<br />
|style="background: #ececec;"| 5.0 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| <!-- SMS v12.1 --><br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH-2D|SRH-2D]]<br />
|style="background: #ececec;"| 3.1.1 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2016-03-AD <!-- SMS v12.2 --><br />
|style="background: #ececec;"| 2016-03-AB <!-- SMS v12.1 --><br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v12.2 --><br />
|style="background: #ececec;"| <!-- SMS v12.1 --><br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
* [[SMS:Simulations|Simulations]]<br />
* [[SMS:Model Checker|Model Checker]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models|M]]<br />
[[Category:Numerical Models|S]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Release_Notes_SMS&diff=120985SMS:Release Notes SMS2017-03-09T18:51:20Z<p>Morelandtom: /* SMS 12.1.10 - January 25, 2016 */</p>
<hr />
<div>{{TOC right}}<br />
The SMS Intermediate Release Bugfixes page for released versions of SMS:<br />
=[[SMS:What's_New_in_SMS_12.2|SMS 12.2 Release]] Bugfixes=<br />
==SMS 12.2.2 - November 14, 2016==<br />
'''ADCIRC'''<br />
*09234 Crash performing Model Check<br />
'''Map'''<br />
*09185 1D Summary Table Crash<br />
*09186 Can't close summary table dialog with X<br />
'''Datasets'''<br />
*09179 Unable to Perform Operation when Comparing Datasets in Data Set<br />
'''Grids'''<br />
*09255 CMS-Wave save creates invalid file if no spectra assigned<br />
'''Mesh'''<br />
*09210 Transform Command Invalidates Dataset<br />
*09220 Mesh disappears from project<br />
*09237 SMS crashes when merging nodestrings<br />
*09231 Writing ADCIRC weirs nodestrings corrupted when a mesh is duplicated<br />
*09139 ADCIRC BC types not correctly maintained when merging meshes<br />
'''Online Maps'''<br />
*09226 Map to Curvilinear function fails<br />
'''General'''<br />
*09228 Summary Table is only exported if the user types the file extension<br />
*09227 Save File dialog has an Open button instead of Save<br />
*09075 Check for Updates Not Working<br />
*09200 SRH normal depth boundary condition issue<br />
'''TUFLOW'''<br />
*09221 TUFLOW results opening switches to scatter module<br />
*09222 TUFLOW project loses Geometry Component<br />
'''UGrid'''<br />
*09215 Converting Quadtree to UGrid sometimes creates an extra folder<br />
==SMS 12.2.1 - October 10, 2016==<br />
'''Coverage'''<br />
*09185 1D Summary Table Crash<br />
*09186 Can't close summary table dialog with X`<br />
'''Export'''<br />
*09145 SMS Exporting HY8 Culvert Arc Nodestrings Incorrectly<br />
'''Feature Objects'''<br />
*09142 Revert subset hangs or crashes<br />
*09138 Working in subset mode confuses ADCIRC boundary conditions<br />
*09144 ADCIRC nodestring with multiple instances of same node not detected and fixed<br />
'''Mesh'''<br />
*09139 ADCIRC BC types not correctly maintained when merging meshes<br />
*09057 Interpolating nodes puts mesh into disarray<br />
'''Project Explorer'''<br />
*09121 SMS DMI allows multiple coverages of same type to be added to a simulation if added by a single drag<br />
*09122 Inconsistency of terminology when unlinking elements from a SRH-2D simulation<br />
'''Projection'''<br />
*09146 Opening ADCIRC mesh in geographic coords does not set the projection if the data spans the international date line<br />
'''General'''<br />
*09075 Check for Updates Not Working<br />
*09172 Crash opening project with SRH model<br />
==SMS 12.2.0 - September 10, 2016==<br />
*[[SMS:What's_New_in_SMS_12.2|Initial Release!!]]<br />
<br />
=[[SMS:What's_New_in_SMS_12.1|SMS 12.1 Release]] Bugfixes=<br />
==SMS 12.1.10 - January 25, 2017==<br />
'''Annotation'''<br />
*09306 Can't use a German "umlaut" in an annotation string<br />
'''Dynamic Model'''<br />
*09264 DMI export of coverage arcs and points of a polygon not working<br />
'''Feature Objects'''<br />
*09343 Renumber Nodestrings Changes Nodestring Direction<br />
*09335 Renumbering nodestrings messes up weir directions<br />
*09304 Select all for triangles does not show information<br />
*09283 Mesh visibility affects extracted data in observation coverage<br />
*09256 DMI polygon attributes lost<br />
'''Grids'''<br />
*09276 The weirs in an ADCIRC mesh don't save correctly<br />
'''Mesh'''<br />
*09333 Two types of unassigned ADCIRC nodestrings<br />
*09205 Exported shapefile does not contain elevation data<br />
'''Plots'''<br />
*09289 Plot Wizard Display Options<br />
'''UGrid'''<br />
*09298 Dataset imported after exporting in H5 format from UGrid can't be read<br />
'''General'''<br />
*09301 Organizing Linked Coverages Causes SMS to Become Unresponsive<br />
*09328 Unable to save image file<br />
*09286 Displaying Cartesian grids in version 12 (and 13) is up to 2 orders of magnitude slower than version 11<br />
*09208 SMS Disk I/O Performance<br />
<br />
==SMS 12.1.9 - November 16, 2016==<br />
'''ADCIRC'''<br />
*09234 Crash performing Model Check<br />
'''Grids'''<br />
*09255 CMS-Wave save creates invalid file if no spectra assigned<br />
'''Mesh'''<br />
*09220 Mesh disappears from project<br />
*09231 Writing ADCIRC weirs nodestrings corrupted when a mesh is duplicated<br />
*09139 ADCIRC BC types not correctly maintained when merging meshes<br />
'''General'''<br />
*09075 Check for Updates Not Working<br />
*09200 SRH normal depth boundary condition issue<br />
'''TUFLOW'''<br />
*09221 TUFLOW results opening switches to scatter module<br />
==SMS 12.1.8 - October 19, 2016==<br />
'''General'''<br />
*09075 Check for Updates Not Working<br />
*09145 SMS Exporting HY8 Culvert Arc Nodestrings Incorrectly<br />
*09172 Crash opening project with SRH model<br />
*09053 Default Help Option is said to be Online but Actually takes you to Local Help<br />
'''Spectral Data'''<br />
*09124 Crash When Using Display Tools in Spectral Energy Dialog<br />
'''Projection'''<br />
*09146 Opening ADCIRC mesh in geographic coords does not set the projection if the data spans the international date line<br />
'''Plots'''<br />
*09114 Isues with observation plots<br />
*09020 Observation Plot Doesn't Look As Expected<br />
'''Mesh'''<br />
*09139 ADCIRC BC types not correctly maintained when merging meshes<br />
*09057 Interpolating nodes puts mesh into disarray<br />
*08824 Deleting points of a mesh in non-display projection forgets what it is doing<br />
'''Map'''<br />
*09127 Can't make observation arcs visible<br />
'''Grids'''<br />
*09113 Bad grid created from Generic Grid generator coverage when set to "Mesh Centered" type<br />
'''Feature Objects'''<br />
*09142 Revert subset hangs or crashes<br />
*09138 Working in subset mode confuses ADCIRC boundary conditions<br />
*09144 ADCIRC nodestring with multiple instances of same node not detected and fixed<br />
'''Dynamic Model'''<br />
*09042 No default display of snapped arcs<br />
<br />
==SMS 12.1.7 - August 13, 2016==<br />
'''ADCIRC'''<br />
*08955 Edit fields for Harmonic parameters in files tab of ADCIRC model control<br />
*08937 Spatial Attribute changes not saved<br />
'''BOUSS2D'''<br />
*09008 Crash When Attempting to Save, Export, and Launch BOUSS-2D Simulation<br />
'''Contours'''<br />
*08957 Can't populate contours with proper range of values<br />
'''Datasets'''<br />
*08974 Dataset conversion from vector to scalar not working for Quadtree from Toolbox<br />
'''DISPLAY OPTIONS'''<br />
*09046 Raster Display Doesn't Update Properly when Changing Point Size and Maximum Points<br />
*08962 Incorrect update of CMS-Wave cell attribute display<br />
*08939 Display doesn't refresh after pan<br />
'''Dynamic Model'''<br />
*09029 Can't run or specify location of aswip<br />
*09027 DMI crash when referencing nonexistent dialog<br />
'''Feature Objects'''<br />
*08956 Select by Dataset Value does not work on UGrid Z dataset<br />
*08952 ADCIRC Mesh elevations revert back to old values when reopening SMS and project<br />
*08954 Nodestrings with Unassigned Boundary Conditions aren't Being Saved<br />
'''General'''<br />
*08979 Text of the Coverage to Smooth Button is Overflowing<br />
*09024 SMS Steering Menu Item<br />
*09070 User gets error message when canceling out of ImportWizard<br />
*09041 SMS is Trying to Read in Files that it Shouldn't<br />
*08960 Open File Format appears instead of an error message<br />
*09069 SMS Coverage Duplicate Issues<br />
*08942 Can't access right-click menu for datasets<br />
*08963 PTM particles remain in display after deletion<br />
*09040 Arc BC data not saved<br />
*09087 The Time Step time is not being displayed when the time is 12:00:00 AM<br />
'''Quadtree'''<br />
*08949 Can’t edit quadtree scalar datasets<br />
*08975 Quadtree transform fails to transform refined cell points<br />
*08882 Quadtree Grid menu items<br />
'''Raster'''<br />
*08921 Raster Frame and Display<br />
*08914 Crash trying to open .las file as "Raster"<br />
'''Simulation'''<br />
*08988 Crash When Creating New WAM Simulation<br />
'''Spectral Data'''<br />
*08972 The direction of the wave components converting from spectra to CGWAVE is not spectra dependent and is wrong<br />
*08971 Converting spectra to CGWAVE wave components does not clear spectral list<br />
*08940 Can't work with high number of spectral indices<br />
<br />
==SMS 12.1.6 - June 2, 2016==<br />
'''ADCIRC'''<br />
*08899 ADCIRC solution with small timestep won't read in<br />
*08813 Incorrect NWS value written to control file<br />
'''BOUSS2D'''<br />
*08768 B2D Wave maker minimum period (tmin) is not filled in anymore<br />
*08767 B2D Warning of time range is wrong<br />
'''Datasets<br />
*08795 Map Elevation command doesn't use specified dataset<br />
*08745 Floodway tool Crash<br />
*08794 Scatter Visibility affects dataset used for interpolation<br />
*08782 Data Calculator behavior type vs. paste<br />
*08757 UGrid datasets generate their own dset contour options<br />
'''Display'''<br />
*08880 CGWAVE nodestrings are numbered with bogus IDs<br />
*08865 Color of snap preview does not change after hitting OK<br />
'''Export'''<br />
*08797 DMI - If a curve is associated with a "set", it is not exported<br />
*08765 BOUSS-2D damping dataset not computed completely<br />
'''Feature Objects'''<br />
*08766 Wave maker no longer shows direction<br />
*08885 Weir from bug 8798 leaves elements in the interior<br />
*08881 ADCIRC node strings not numbered correctly<br />
*08798 Crash Creating ADCIRC Weir<br />
*08777 Canceling In Select Dataset Dialog Changes Functional Surface Options<br />
'''General'''<br />
*08866 The Line Attributes dialog is not modal<br />
*08868 XMDF File Not Loaded In Correctly<br />
*08800 Functional Surface Won't Use User Defined Dataset<br />
'''Interpolation'''<br />
*08755 Interpoate from Quadtree to Scatter vector crashes<br />
'''Map'''<br />
*08829 Incorrect polygon fill display<br />
'''Mesh'''<br />
*08830 Preview Mesh leaves a gap in the mesh.<br />
*08840 Issues with Functional Surface on Mesh<br />
*08787 Map-2D Mesh with multiple rasters<br />
'''Particles'''<br />
*08856 Crash When Writing Particles Subset If the File Name Has not Been Set<br />
'''Plots'''<br />
*08763 Observation plots not consistent<br />
*08764 Observation plot from Mesh is too long<br />
*08762 DEM Observation plot of data doesn't show up<br />
'''Project Explorer'''<br />
*08769 SMS gets confused about the mesh module<br />
*08746 Missing features for TUFLOW 1D<br />
'''Projection'''<br />
*08799 Missing Cross Section data in Summary Table<br />
*08854 Crash After Reproject All<br />
'''Raster'''<br />
*08838 Incorrect Raster Elevations<br />
'''Scatter Data'''<br />
*08907 Saving an empty scatter set corrupts project.<br />
*08908 Dialog indicates spacing is in meters when it is really in degrees<br />
*08848 Crash Saving Project After Failed Interpolation<br />
*08837 ADH Model Checker SI Units<br />
*08847 Error When Using an Existing Dataset for Extrapolation<br />
'''SRH-2D'''<br />
*08748 Can't Open SRH solution after model run<br />
'''TUFLOW'''<br />
*08846 Crash Saving TUFLOW Project<br />
<br />
==SMS 12.1.5 - April 20, 2016==<br />
'''CMCARDS''' <br />
*08739 Loading CMS-Flow project from SMS 11.2 does not associate the projection correctly<br />
'''CMS Flow''' <br />
*08668 CMS Project Crash<br />
*08695 CMS-Flow Registration Item Disrupts SRH Coverages<br />
'''Map''' <br />
*08682 Selecting Polygons Takes a Long Time<br />
*08690 SMS Does not Preserve "Bank" attribute type in the 1D Hydraulic Centerline Coverage<br />
'''General''' <br />
*08697 Splash Screen Causes SMS to Hang<br />
*08702 SMS Main Menu, and Hot Key for Help Goes to Internet Only<br />
'''GSSHA''' <br />
*08642 GSSHA Upstream Culvert<br />
'''Import''' <br />
*08711 Opening multiple surveys at a single time gives error message<br />
'''Mesh''' <br />
*08730 Map->2D Mesh is too slow "Setting nodal z values..."<br />
'''Models''' <br />
*08575 Observation Data Cannot be Defined for stream arcs with an arc type of "General Stream"<br />
'''Plots''' <br />
*08581 Drogue plot shifts when zooming out<br />
'''Quadtree''' <br />
*08673 Problems Rotating on Quadtree/CGrid with Grid Frame<br />
*08672 Able to Create Quadtree When Quadtree Not Enabled<br />
'''Scatter Data''' <br />
*08720 Converting coverage to spacing scatter gives wrong values<br />
*08719 Converting coverage to scatter hangs<br />
'''SRH-2D''' <br />
*08747 Data sets don't appear under Mesh Data after running SRH-2D.<br />
*08689 SMS Not Saving Populated WSE Value<br />
<br />
==SMS 12.1.3 - March 03, 2016==<br />
'''Contours'''<br />
*08653 Contour options are not initialized on UGrid dsets after duplicate operation<br />
'''General'''<br />
*08593 Empty spreadsheet double cells crash xms<br />
*08649 Crash opening .dep file<br />
*08596 Polygon Fill Display Incorrect<br />
'''Boundary Conditions'''<br />
*08635 Snap Preview won't stay off<br />
'''Dynamic Model Interface'''<br />
*08622 DMI range type edit boxes change values on blur<br />
*08623 DMI double clicking anywhere with polygon select tool enabled opens polygon attributes menu<br />
*08637 DMI Building New Polygons Messes Up Dependencies on Old Polygons<br />
'''Mesh'''<br />
*08597 Mesh Paving Crash<br />
*08604 Renumbering a mesh with gaps while color fill contours is on causes a crash<br />
'''UGrid'''<br />
*08595 UGrid Functional Surface doesn't display correctly when new active dataset selected<br />
'''ADCIRC'''<br />
*08607 ADCIRC files not copied to run directory when executing ADCIRC<br />
*08606 SMS does not read in ADCIRC data correctly<br />
'''Vectors'''<br />
*08615 Vector to Scalars Command Generates Dataset with Incorrect Velocities<br />
'''SRH-2D'''<br />
*08608 SRH-2D material coverage created from FESWMS coverage has bad attributes for polygons<br />
==SMS 12.1.2 - January 24, 2016==<br />
'''Datasets'''<br />
*08544 - Dataset compare feature is not working<br />
'''DMI'''<br />
*08527 - #file_name keyword is not accessible when process_on_condition is used in input_file<br />
'''PBL'''<br />
*08571 - PBL output grids not displayed correctly<br />
'''FESWMS'''<br />
*08536 - Crash After saving FESWMS Project and Reopening Saved Files<br />
'''CMS-Wave'''<br />
*08567 - Opening CMS-Wave simulation with the Display Projection set to Geographic creates incompatible display case<br />
'''CMS-Flow'''<br />
*08555 - Crash opening CMS-Flow project<br />
'''Contours'''<br />
*08478 - Contours change when they shouldn't<br />
*08549 - Contour update issue on quadtrees after interpolating datasets from one to the Z of the other<br />
'''Mesh'''<br />
*08542 - Summary table from 2dMesh uses elevation value for all datasets<br />
*08550 - Cannot edit multiple nodes simultaneously on a vtk mesh<br />
'''Quadtree'''<br />
*08547 - Min and max not set when interpolating one quadtree dataset to Z of another<br />
*08493 - Quadtree Created in the Wrong Direction after Changing Coverage Types<br />
'''General'''<br />
*08566 - Date/Time stamps for the year 2000 - 2009 are read incorrectly when written with 8 digit format<br />
*08563 - Cells in a table become blank<br />
*08560 - SMS crashes when clicking the top left cell of the Linear BC table.<br />
*08561 - Wording correcting in film loop error<br />
*08557 - Merging coverages causes duplicate node ids<br />
*08526 - Order, i_order, and j_order attributes have no effect on process_each_polygon operations on cgrids<br />
*08481 - Redistribute Verices without cubic spline causes points in bad places<br />
*08545 - Confirmation setting not used when deleting coverages with the "Del" key<br />
*08404 - Saving and Reopening Coverages Removes Certain Characters<br />
*08492 - Wrong Popup When Generating a CGrid with No Grid Frame<br />
==SMS 12.1.1 - December 07, 2015==<br />
'''CMS Flow'''<br />
*08476 - Error Popup when Opening Old CMS-Flow Project File in 12.1<br />
'''Coverage'''<br />
*08519 - Merged coverage has inappropriate atts that cause a crash when cleaning<br />
*08501 - Crash Deleting All Coverages<br />
'''Feature Object'''<br />
*08513 - Double-Clicking on point in DMI Coverage does not bring up dialog<br />
'''Grids'''<br />
*08508 - DMI unable to conditionally retrieve cell i and j based on bound coverage attribute<br />
*08511 - Points Snap to Incorrect CGRID Cells During CMS-WAVE2 DMI Export<br />
'''Map'''<br />
*08496 - Strange Behavior and Crash When Merging Polygons<br />
*08495 - Crash When Merging Polygons<br />
*08452 - Redistribution of arc that is not in display projection causes problems<br />
'''Mesh'''<br />
*08483 - Incorrect mesh preview in polygon attributes<br />
*08499 - Incorrect Mapping of BC arc to mesh<br />
*08491 - Crash committing mesh subset<br />
*08502 - SMS deletes duplicate elements without reporting what elements are being deleted<br />
'''Opening File'''<br />
*08494 - Crash or Hang when opening project<br />
*08507 - Cross sectional database with "." in the name gets trimmed<br />
'''Project'''<br />
*08522 - Crash Opening SRH Tutorial<br />
'''Project Explorer'''<br />
*08330 - Project Explorer Items not updating their display properly<br />
'''Quadtree'''<br />
*08493 - Quadtree Created in the Wrong Direction after Changing Coverage Types<br />
'''Raster'''<br />
*08488 - Observation plot options allow user to select images if raster is loaded, but then says it is invalid<br />
'''Saving'''<br />
*08473 - Crash during save of generic model<br />
'''Scatter Data'''<br />
*08482 - Crash loading project file merging dynamic database (MergeAfterAllFilesReadIn)<br />
<br />
==SMS 12.1.0 - Release November 17, 2015==<br />
*[[SMS:What's_New_in_SMS_12.1|Initial Release!!]]<br />
<br />
=[[SMS:What's New in SMS 12.0|SMS 12.0 Release]] Bugfixes=<br />
==SMS 12.0.7 - Release October 22, 2015==<br />
*'''Contours'''<br />
**8278 - Functional surface contour dialog name incomplete<br />
*'''Generic Model'''<br />
**8223 - ADH Hotstart folder created when switching models<br />
*'''GIS'''<br />
**8092 - Crash on Exit when working with GIS data<br />
*'''HY-8'''<br />
**8250 - SMS not specifying the location of the HY-8 executable in the preferences<br />
*'''Import'''<br />
**8261 - Update for Import Options in Tutorials<br />
*'''Mesh'''<br />
**7912 - Scalar Paving Meshing Results not Accurate<br />
**8254 - GIS right click menus not finished<br />
**8248 - Can't Create mesh nodes when only SRH Interface enabled<br />
**8296 - Global parameters problems in .2dm file<br />
**8280 - SMS doesn't detect the mesh nodes (or the mesh at all)<br />
**8268 - Projection not matching when trying to enter mesh subset edit<br />
**8224 - Incorrect Z Values assigned to nodes when performing Map->2D Mesh<br />
*'''NOAA'''<br />
**8270 - Tidal Data commands for the Web menu do nothing<br />
*'''Quadtree'''<br />
**8360 - Quadtree hides the contour legend and arrow become transparent<br />
*'''SRH-2D'''<br />
**8307 - SRH2D Obstruction Arc Direction Causes Termination of SRH2D<br />
**8263 - SRH-2D Time Series Option Displaying when it should not be displayed<br />
**8216 - Observation Profile Plot not Updating to Show the Active Timestep<br />
**8210 - Simple Z lines not writing to the .tgc file<br />
<br />
==SMS 12.0.6 - Release August 21, 2015==<br />
'''ADCIRC'''<br />
*8207 SMS crashes when loading fort.45.<br />
<br />
'''BOUSS2D'''<br />
*8214 STWAVE mentioned in model checker description instead of BOUSS2D<br />
*8191 SMS automatically cycles through time steps of BOUSS2D WSE Animation output dataset<br />
<br />
'''Cartesian Grid'''<br />
*8095 Generic CGrids are not saved with a project<br />
<br />
'''GenCade'''<br />
*8209 Inlets (Reservoir Model and Jetties) dialog typo<br />
*8194 GenCade coverages lose attributes when merged<br />
<br />
'''Generic Model'''<br />
*8223 ADH Hotstart folder created when switching from ADH to Generic model<br />
<br />
'''Import Options'''<br />
*8244 Name of 'Z' dataset not correct<br />
<br />
'''Mesh'''<br />
*8229 Crash computing mesh spacing<br />
*8153 Long Processing Time for Map->2D Mesh<br />
<br />
'''Plots'''<br />
*8216 Observation Profile Plot not Updating to Show the Active Timestep<br />
*8196 Crash Toggling through Timesteps with Observation Profile 2D Plot<br />
<br />
'''SRH-2D'''<br />
*8171 SRH-2D Obstruction Coverage Issues<br />
*8173 SRH-2D and HY8 Runaway Processes<br />
<br />
'''STWAVE'''<br />
*8201 STWAVE sim file import does not read projection<br />
<br />
'''TUFLOW'''<br />
*8210 Simple Z lines not writing to the .tgc file<br />
<br />
'''WAM'''<br />
*8114 WAM spectral site menu command Spectral Energy... doesn't work<br />
<br />
'''General'''<br />
*8208 SMS crashes when reopening the current open project.<br />
*8083 PTM Waves and Breaking Input File Option cannot be removed from the model<br />
<br />
<br />
==SMS 12.0.5 - Release August 4, 2015==<br />
'''ADCIRC'''<br />
*8188 SMS crashes when opening multiple files including fort.64 fort.64 and other ADCIRC files.<br />
*8177 Fixed errors in ADCIRC LTEA tutorial to work with recent changes to the LTEA meshing toolbox.<br />
*8104 SMS was not creating the unit 23 file even when it was set to be created.<br />
<br />
'''ADH'''<br />
*7984 Fixed issues with the sidewall boundary conditions.<br />
<br />
'''BOUSS-2D'''<br />
*8117 BOUSS-2D Generating arcs along land boundaries not using elevation scalar set.<br />
<br />
'''CGWAVE'''<br />
*8184 Unable to read in the solutions .cgo file.<br />
<br />
'''General'''<br />
*8108 Can't delete items from project.<br />
*8180 Save tabular data mixing of meshes and datasets.<br />
*8107 Project corrupted after saving in certain cases.<br />
*8157 Delete key unresponsive when deleting arcs and other map objects.<br />
*8130 Deleting datasets that are changed outside of SMS caused datasets in the project tree to be deleted<br />
*8123 Removed unnecessary messages from Delete All operation.<br />
*8125 Reading in a Materials file with foreign characters does not read in properly.<br />
*8026 Removed unnecessary message about remote desktop from startup.<br />
<br />
'''Images/GIS'''<br />
*8164 Can't save project with DGN data.<br />
*8138 MIF/MID importing errors.<br />
<br />
'''Map'''<br />
*8159 Creating arcs caused node numbering to change, and added gaps.<br />
*8158 Can't find feature point by ID.<br />
*8100 Incorrect Extracted Values at Observation Arcs.<br />
*8033 Right-Click Menu not defined for dynamic maps.<br />
<br />
'''2D-Mesh'''<br />
*8168 Mesh generation toolbox was missing in the menu for ADCIRC.<br />
*8162 Unable to deselect feature objects while multi-selecting in 2D mesh polygon properties dialogue.<br />
*8152 Incorrect snap preview.<br />
*8097 Mesh created with overlapping elements.<br />
*8116 SMS Not exporting BC node strings correctly.<br />
*8098 Crash optimizing triangulation of SMS generated mesh.<br />
*8099 SMS saves bad mesh after refining elements.<br />
*8091 Crash Interpolating scatter to mesh.<br />
<br />
'''Scatter Data'''<br />
*8151 Can't merge scatter sets after using to much memory.<br />
*8154 Incorrect extracted plot from scatter in certain cases.<br />
<br />
'''Simulations'''<br />
*8110 Model checker sometimes doesn't recognize the mesh and materials that are in the project.<br />
<br />
'''SRH-2D'''<br />
*8186 user defined weir coefficient input boxes displayed for wrong options.<br />
*8161 has no upstream/downstream arc assignment when using paired boundary.<br />
*8167 Model control label is "Total Simulation Time" when it should be "Simulation End Time".<br />
*8160 material display options not working as expected on SRH-2D boundary condition meshes.<br />
<br />
'''TINs'''<br />
*8137 Selecting triangles of a TIN causes SMS to crash in certain cases.<br />
<br />
'''WAM'''<br />
*8061 Model check not functioning properly.<br />
*8062 Tutorial model does not run successfully.<br />
<br />
==SMS 12.0.4 - Release June 16, 2015==<br />
'''ADCIRC'''<br />
*8031 Loading ADCIRC Meshes Causes Multiple Meshes with the Same Name<br />
<br />
'''CMS'''<br />
*8068 CMS Model Check and Sediment Datasets<br />
<br />
'''Dynamic Model Interface'''<br />
*7978 dataset not saved in DMI<br />
<br />
'''Generic Model'''<br />
*7991 Generic Mesh Model, can't uncheck Activate parameter group<br />
*7989 Generic Mesh Model does not save parameter group correlation for BC<br />
<br />
'''2D Grid'''<br />
*7994 Display of Cartesian Grid Data is Incorrect<br />
<br />
'''General'''<br />
*8060 Scale/Printing Issue<br />
*8080 Displayed snapping location is wrong when first opening the project<br />
*8029 Zoom to Selection Not working when display features are turned off<br />
*8067 Printing crash<br />
*8025 SMS does not remember the path to the HY8 executable if the registry is already set <br />
*8050 Slow vector display<br />
*8048 Plot From Observation Profile Not Appearing In Graph<br />
*8015 projection changes on load<br />
*8041 Non-admin user with partial SMS license can't set file paths<br />
*8008 Incorrect Profile Plot<br />
*7834 Various issues found while working on East End Bay project<br />
*7998 Reading project file hangs SMS<br />
<br />
'''Images/GIS'''<br />
*8030 Shapes&rarr;Map and can create duplicate coverage names<br />
<br />
'''Map'''<br />
*7591 Redistribute arc using source/target fails with bias distribution on source<br />
*8024 Spectral coverage "Projection.." right-click menu item does nothing<br />
<br />
'''2D-Mesh'''<br />
*8079 Rectangular patch not clearing previous mesh<br />
*8052 Datasets not included in Mesh&rarr;Scatter Operation<br />
*8028 Saving Mesh Subsets<br />
*8023 snapping elements not correct<br />
*7940 BC lost when editing mesh subset<br />
*7918 Z direction of multiple meshes flips<br />
<br />
'''SRH-2D'''<br />
*8032 SRH Not Outputting at Specified Interval<br />
*8071 Incorrect display of SRH boundary condition labels<br />
*8073 Changing one SRH-2D BC coverage changes other SRH-2D BC coverage<br />
*8064 SRH-2D Model Checker Crashes<br />
*8034 Time series curves linked on duplicate SRH BC coverages<br />
*7461 SRH Variable WSE tutorial files don't work<br />
*8016 SRH-2D Duplicate Coverage Errors<br />
*7999 The SRH-2D DMI writes multiple pressure cards in srhhydro file incorrectly<br />
<br />
'''STWAVE'''<br />
*7345 Can't run STWAVE through SMS<br />
<br />
==SMS 12.0.3 - Release May 20, 2015==<br />
'''ADCIRC'''<br />
*7917 Single node value not editable for ADCIRC nodal attribute<br />
<br />
'''ADH'''<br />
*7961 SMS hangs when opening ADH solution file<br />
*7878 ADH materials can't be deleted<br />
<br />
'''BOUSS Runup/Overtopping'''<br />
*7942 Checkboxes in Runup/Overtopping Model Control Dialog Aren't Being Initialized<br />
<br />
'''Dynamic Model Interface'''<br />
*7978 dataset not saved in DMI<br />
<br />
'''General'''<br />
*8008 Incorrect Profile Plot<br />
*7834 Various issues found while working on East End Bay project<br />
*7998 Reading project file hangs SMS<br />
*7963 The case of the mysterious red rectangle<br />
*7951 Vertical Units Undefined<br />
*7949 Crash performing Model Check<br />
*7934 Unidentified Label in Node Options<br />
*7938 File Import Wizard Hangs SMS<br />
<br />
'''Generic Model'''<br />
*7991 Generic Mesh Model, can't uncheck Activate parameter group<br />
*7989 Generic Mesh Model does not save parameter group correlation for BC<br />
<br />
'''2D Grid'''<br />
*7994 Display of Cartesian Grid Data is Incorrect<br />
*7979 Cell sizes change with reprojection<br />
<br />
'''Map'''<br />
*8024 Spectral coverage "Projection.." right-click menu item does nothing<br />
*7975 Incorrect BC arc labeling<br />
*7964 Crashing Stamping Feature<br />
*7915 Double-Click arc group crash<br />
*7933 Coverage created from scatter boundary has issues<br />
<br />
'''2D Mesh'''<br />
*8023 snapping elements not correct<br />
*7918 Z direction of multiple meshes flips<br />
*7940 BC lost when editing mesh subset<br />
*7985 Certain BC not available when exactly two nodestrings selected<br />
*7941 Crash refining elements<br />
*7944 Nodal BC symbols not showing up unless the nodes are also displayed<br />
<br />
'''Scatter'''<br />
*7955 Deleting scatter point converts dataset to Z<br />
*7937 Trimming a scatter set destroys the data values (only 1 dataset)<br />
<br />
'''Simulation'''<br />
*7952 Renaming Mesh doesn't update name in simulation link<br />
<br />
'''SRH-2D'''<br />
*8016 SRH-2D Duplicate Coverage Errors<br />
*7999 The SRH-2D DMI writes multiple pressure cards in srhhydro file incorrectly<br />
*7973 SRH BC not displayed<br />
*7974 SRH Geometry Nodestrings not written correctly for SRH Model<br />
*7966 SRH Project in 11.2 doesn't read correctly into 12.0<br />
*7957 Opening saved SRH-2D project creates duplicate datasets.<br />
*7950 Model Check for SRH says there is no mesh<br />
*7889 Attempting to Open a SRH-2D Causes a Crash<br />
<br />
'''STWAVE'''<br />
*7784 STWAVE Numeric Model Crashes Midway Through Running<br />
*7378 STWAVE Tutorial Crash<br />
*7199 STWAVE Crash when Use time steps is specified<br />
<br />
'''TUFLOW-FV'''<br />
*7925 Can't run TUFLOW-FV from SMS<br />
*7924 Can't read TUFLOW FV Vector Solution<br />
<br />
=Older Bugfixes=<br />
For older versions of SMS that are no longer actively supported, see the individual bugfix articles: <br />
{|<br />
!width="130"|Bugfix Article <br />
!width="200"| Release Notes<br />
|-<br />
|[[SMS:Bugfixes SMS 10.0|Bugfixes SMS 10.0]] || [[SMS:What's New in SMS 10.0|SMS 10.0 Intermediate Release]]<br />
|-<br />
|[[SMS:Bugfixes SMS 10.1|Bugfixes SMS 10.1]] || [[SMS:What's New in SMS 10.1|SMS 10.1 Intermediate Release]]<br />
|-<br />
|[[SMS:Bugfixes SMS 11.0|Bugfixes SMS 11.0]] || [[SMS:What's New in SMS 11.0|SMS 11.0 Intermediate Release]]<br />
|-<br />
|[[SMS:Bugfixes SMS 11.1|Bugfixes SMS 11.1]] || [[SMS:What's New in SMS 11.1|SMS 11.1 Intermediate Release]]<br />
|-<br />
|[[SMS:Bugfixes SMS 11.2|Bugfixes SMS 11.2]] || [[SMS:What's New in SMS 11.2|SMS 11.2 Intermediate Release]]<br />
|}<br />
<br />
= Related Topics =<br />
* [[SMS:What's New in SMS|What's New in SMS]]<br />
* [[SMS:Downloads|Downloads]]<br />
* [[SMS:Introduction to Setting up SMS|Installing and Setting up SMS]]<br />
* [[System Requirements|System Requirements]]<br />
* [[License Agreement|License Agreement]]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:What's New]]<br />
[[Category:Bugfixes|SMS]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SRH-2D_Errors&diff=119235SMS:SRH-2D Errors2017-02-07T20:28:20Z<p>Morelandtom: /* List of Error Messages */</p>
<hr />
<div>This is a list of known error messages produced by [[SMS:SRH-2D|SRH-2D]]. These errors will appear during the model run.<br />
<br />
==List of Error Messages==<br />
The first three columns in the table are sortable. Simply click the small arrows on the right side of the column header to sort in ascending or descending order.<br />
<br />
The columns in the table include:<br />
* '''Location''' indicates whether the error occurs in the SRH-2D Preprocessor or in SRH-2D itself.<br />
* '''Error Code''' gives the Error Code (if any).<br />
* '''Error Text from Model''' gives the full text of the error message. Errors that do not produce any error text will have "no text" in this field.<br />
* '''Description''' gives more details about the error.<br />
* '''Solution''' gives steps necessary to correct the issue.<br />
<br />
{| class="wikitable sortable" style="border:1px solid black;"<br />
! style="width:5%;" | Location<br />
! style="width:5%;" | Error Code<br />
! style="width:25%;" | Error Text from Model<br />
! style="width:25%;" class="unsortable" | Description<br />
! style="width:40%;" class="unsortable" | Solution<br />
<!-- Use the following as a template to add new entries<br />
|-<br />
| location<br />
| code<br />
| text<br />
| description<br />
| solution<br />
--><br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in uti_qwin_xyplot.f90 TIME_SIMU <br />
| Inconsistent time control<br />
| The end time is prior to the start time in the model control. Adjust so it is later than the start time.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| unable to open srhhydro file! <br />
| Unable to open srhhydro file<br />
| The path length for the SMS project is too long. Therefore, the SRH-2D preprocessor could not read the exported files from SMS. Reduce the path length to less than 300 characters.<br />
|-<br />
| SRH-2D<br />
| <br />
| No cells cover an obstruction in structure_obstruction.f90<br />
| Obstruction feature area of influence does not cover the centroid of at least one element<br />
| The "Obstruction Width/Diameter:" value in the ''Obstructions Properties'' dialog is set to "0" and/or an obstruction arc is positioned just beyond half the width/diameter defined in the properties from the centroid of a mesh element. <br />
|-<br />
| SRH-2D<br />
| <br />
| Stopped in structure_culvert.f90 ICELL error#5<br />
| BC arc mesh snapping does not match inactive material zone snapping<br />
| Some paired arc 1D structures require an "unassigned" material zone between the structure arcs. If the material zone snapping does not match the BC arc snapping, there will be element inactivity problems at the face of the structure. <br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| More than 99 obstructions exist<br />
| SRH-2D has a built in limit to how many obstructions can be included in a model. Currently this limit is 99. Reduce the number of obstructions to 99 or fewer.<br />
|-<br />
| SRH-2D<br />
| <br />
| a face cannot be found given two mesh points<br><br />
Two points are: 7262 591<br><br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Errors from final_touch.f90 **** on MONITOR LINE#2<br><br />
Monitor line nodestring not snapped correctly<br />
| When the monitor line is snapped to the mesh as a nodestring, the nodestring does not have a continuous string of nodes but rather skips a node so that the nodestring crosses the middle of the element diagonally. This is a bug that has been fixed.<br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| If you specify a ''z'' elevation to a bridge arc that is too high in the structures exercise, SRH doesn't run.<br />
| bug<br />
|-<br />
| SRH-2D<br />
| 2<br />
| ALL INLET cells are dry from bc_mdot2.f90! Code may have blow up due to input errors or too-large time-step.<br />
| All material polygons unassigned<br />
| This occurs when none of the materials have been assigned to the material polygons. Also occurs when all material polygons covering the inflow BC are inactive.<br />
|-<br />
| SRH-2D<br />
| <br />
| FATAL ERROR The code diverged; further reduction of time step would help the convergence!<br />
| Too large of a time step<br />
| Reduce the size of the time steps<br />
|-<br />
| <br />
| <br />
| No mesh that matches the scalar set.<br />
| No mesh that matches the scalar set.<br />
| Nodes &#x7C; Renumber. It is a good idea after you are done editing your mesh to renumber the nodes, to make sure SMS and SRH-2D have the same numbers on every node.<br />
|-<br />
| <br />
| <br />
| <br />
| WSE error directly under the bridge in the form of waves oscillating through the channel<br />
| Use larger, quadrilateral elements in the area of deep flow (as you have found). This means that the piers need to be switched to obstructions<br />
|-<br />
| <br />
| <br />
| The following coverage(s) have an unsupported type and will be converted to area property: Mat_Test" error message<br />
| Mat_Test" error message<br />
| Opening a map file with out an accompanying project file. If the coverage type is under Model (which the .map file provided indicated it was) then the type is stored in the project file so that error will appear when opening just the .map file.<br />
|-<br />
| SRH-2D<br />
| <br />
| Exit code 0<br />
| Exit code 0<br />
| SRH-2D has stopped or finished (whether "successfully executed" or not), adjust the parameters to make converge if not succesfully executed<br />
|-<br />
| <br />
| 1<br />
| Error code 1<br />
| srhmat file does not exist<br />
| File didn't export successfully, Make sure assigned materials in the materials coverage, possibly too many monitoring lines (20 or less okay)<br />
|-<br />
| SRH-2D<br />
| <br />
| a face cannot be found given two mesh points<br><br />
Two points are: 7262 591<br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Errors from final_touch.f90 on MONITOR LINE#2<br />
| rebuild the arcs<br />
|-<br />
| PreSRH-2D<br />
| <br />
| forrtl: severe (157): Program Exception - access violation<br />
| <br />
| Set up file location Preferences to the correct location for SRH-Pre<br />
|-<br />
| SRH-2D<br />
| 4<br />
| All INLET cells are dry sets are dry from bc_mdot2.f90! Code may have blow up (sic) due to input errors or too-large time-step. <br />
| <br />
| This problem typically arises because the polygons that you have given for the obstructions do not overlap any element centroids. The problem can be solved by refining the elements in the area of the obstructions until the obstruction polygon is well represented by elements whose centroids lie within the spatial extent of the polygons.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| MESH-UNIT: Enter one of the following options for the unit of the mesh<br />
| Mesh unit error<br />
| SRH requires that vertical and horizontal units be in either meters or U.S survey feet<br />
|-<br />
| SRH-2D<br />
| 8<br />
| Inconsistent cell ID in mesh_connectivity: maybe due to wrong nodestring<br />
| <br />
| Possibly due to overlapping elements<br />
|-<br />
| PreSRH-2D<br />
| <br />
| a face cannot be found given two mesh points<br><br />
Two points are: 38383 38494<br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Errors from final touch.f90 on MONITOR LINE#2<br><br />
Inconsistent or disconnected nodestring for a monitor line<br />
| This was caused by having a monitoring line run across a large "hole" in the mesh. The hole was large enough that we were not snapping the monitor line to a valid nodestring.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Stopped in add_nbdf.90 DIS<br />
| Issue with BC nodestrings<br />
| In this case, this issue was from a bug where SMS was exporting the nodestring in the SRHGEOM file incorrectly for two HY8 culvert arcs. SMS was essentially writing the same string of nodes for both the upstream and downstream culvert arcs.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in face_wd.f90 PRESS#1<br />
| Issue with Pressure Flow BC and "Piers"<br />
| In this problem, SRH2D did not allow holes in the mesh that represented bridge piers within the Pressure flow zone. This is only a problem in SMS v.12.1 and the SRH executable supplied with it. SMS 12.2 and the SRH executable supplied with it now allows holes in the mesh within Pressure zones. The same error will also be shown if an "unassigned" material type is specified in the pressure zone, again this is only a problem in SMS v12.1 and the SRH exe supplied with it, 12.2 allows "unassigned" material types in the pressure flow zone.<br />
|-<br />
| SRH-2D<br />
| <br />
| Program Stopped as Mesh is different in RST file<br><br />
One of the following is different:<br><br />
Ncell Nvert Nface Nclfc Nclvt in RESTART file<br><br />
do not match those in the input file<br><br />
Ncell Nvert Nface Nclfc Nclvt<br><br />
in restart file are: 13604 7374 20977 41693 41693<br><br />
in casename.GRD file are: 15459 8277 23735 47225<br><br />
Mesh topology has to be the same for irest>=1 or init_method=3<br />
| Using a restart file that was created with another mesh<br />
| Restart files can only be used with simulations using the exact same mesh.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| Could not find a mesh cell which contains the monitoring point! Check if you have the right input of (X Y) coordinates for a monitoring points<br />
| Monitor Point Outside of Mesh<br />
| Monitor point must be somewhere within a mesh element.<br />
|-<br />
| SRH-2D<br />
| 6940<br />
| <br />
| <br />
| Ensure that areas upstream of the upstream culvert location and areas downstream of the downstream culvert location have a valid material type assigned.<br />
|}<br />
<br />
==Related Topics==<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
* [[SMS:Bugfixes|SMS Bugfixes]]<br />
<br />
<br />
{{Navbox SMS}}<br />
<br />
[[Category:SRH-2D|Errors]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SRH-2D_Errors&diff=119180SMS:SRH-2D Errors2017-02-06T23:44:38Z<p>Morelandtom: </p>
<hr />
<div>This is a list of known error messages produced by [[SMS:SRH-2D|SRH-2D]]. These errors will appear during the model run.<br />
<br />
==List of Error Messages==<br />
The first three columns in the table are sortable. Simply click the small arrows on the right side of the column header to sort in ascending or descending order.<br />
<br />
The columns in the table include:<br />
* '''Location''' indicates whether the error occurs in the SRH-2D Preprocessor or in SRH-2D itself.<br />
* '''Error Code''' gives the Error Code (if any).<br />
* '''Error Text from Model''' gives the full text of the error message. Errors that do not produce any error text will have "no text" in this field.<br />
* '''Description''' gives more details about the error.<br />
* '''Solution''' gives steps necessary to correct the issue.<br />
<br />
{| class="wikitable sortable" style="border:1px solid black;"<br />
! style="width:5%;" | Location<br />
! style="width:5%;" | Error Code<br />
! style="width:25%;" | Error Text from Model<br />
! style="width:25%;" class="unsortable" | Description<br />
! style="width:40%;" class="unsortable" | Solution<br />
<!-- Use the following as a template to add new entries<br />
|-<br />
| location<br />
| code<br />
| text<br />
| description<br />
| solution<br />
--><br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in uti_qwin_xyplot.f90 TIME_SIMU <br />
| Inconsistent time control<br />
| The end time is prior to the start time in the model control. Adjust so it is later than the start time.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| unable to open srhhydro file! <br />
| Unable to open srhhydro file<br />
| The path length for the SMS project is too long. Therefore, the SRH-2D preprocessor could not read the exported files from SMS. Reduce the path length to less than 300 characters.<br />
|-<br />
| SRH-2D<br />
| <br />
| No cells cover an obstruction in structure_obstruction.f90<br />
| Obstruction feature area of influence does not cover the centroid of at least one element<br />
| The "Obstruction Width/Diameter:" value in the ''Obstructions Properties'' dialog is set to "0" and/or an obstruction arc is positioned just beyond half the width/diameter defined in the properties from the centroid of a mesh element. <br />
|-<br />
| SRH-2D<br />
| <br />
| Stopped in structure_culvert.f90 ICELL error#5<br />
| BC arc mesh snapping does not match inactive material zone snapping<br />
| Some paired arc 1D structures require an "unassigned" material zone between the structure arcs. If the material zone snapping does not match the BC arc snapping, there will be element inactivity problems at the face of the structure. <br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| More than 99 obstructions exist<br />
| SRH-2D has a built in limit to how many obstructions can be included in a model. Currently this limit is 99. Reduce the number of obstructions to 99 or fewer.<br />
|-<br />
| SRH-2D<br />
| <br />
| a face cannot be found given two mesh points<br><br />
Two points are: 7262 591<br><br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Errors from final_touch.f90 **** on MONITOR LINE#2<br><br />
Monitor line nodestring not snapped correctly<br />
| When the monitor line is snapped to the mesh as a nodestring, the nodestring does not have a continuous string of nodes but rather skips a node so that the nodestring crosses the middle of the element diagonally. This is a bug that has been fixed.<br />
|-<br />
| SRH-2D<br />
| <br />
| <br />
| If you specify a ''z'' elevation to a bridge arc that is too high in the structures exercise, SRH doesn't run.<br />
| bug<br />
|-<br />
| SRH-2D<br />
| 2<br />
| ALL INLET cells are dry from bc_mdot2.f90! Code may have blow up due to input errors or too-large time-step.<br />
| All material polygons unassigned<br />
| This occurs when none of the materials have been assigned to the material polygons. Also occurs when all material polygons covering the inflow BC are inactive.<br />
|-<br />
| SRH-2D<br />
| <br />
| FATAL ERROR The code diverged; further reduction of time step would help the convergence!<br />
| Too large of a time step<br />
| Reduce the size of the time steps<br />
|-<br />
| <br />
| <br />
| No mesh that matches the scalar set.<br />
| No mesh that matches the scalar set.<br />
| Nodes &#x7C; Renumber. It is a good idea after you are done editing your mesh to renumber the nodes, to make sure SMS and SRH-2D have the same numbers on every node.<br />
|-<br />
| <br />
| <br />
| <br />
| WSE error directly under the bridge in the form of waves oscillating through the channel<br />
| Use larger, quadrilateral elements in the area of deep flow (as you have found). This means that the piers need to be switched to obstructions<br />
|-<br />
| <br />
| <br />
| The following coverage(s) have an unsupported type and will be converted to area property: Mat_Test" error message<br />
| Mat_Test" error message<br />
| Opening a map file with out an accompanying project file. If the coverage type is under Model (which the .map file provided indicated it was) then the type is stored in the project file so that error will appear when opening just the .map file.<br />
|-<br />
| SRH-2D<br />
| <br />
| Exit code 0<br />
| Exit code 0<br />
| SRH-2D has stopped or finished (whether "successfully executed" or not), adjust the parameters to make converge if not succesfully executed<br />
|-<br />
| <br />
| 1<br />
| Error code 1<br />
| srhmat file does not exist<br />
| File didn't export successfully, Make sure assigned materials in the materials coverage, possibly too many monitoring lines (20 or less okay)<br />
|-<br />
| SRH-2D<br />
| <br />
| a face cannot be found given two mesh points<br><br />
Two points are: 7262 591<br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Errors from final_touch.f90 on MONITOR LINE#2<br />
| rebuild the arcs<br />
|-<br />
| PreSRH-2D<br />
| <br />
| forrtl: severe (157): Program Exception - access violation<br />
| <br />
| Set up file location Preferences to the correct location for SRH-Pre<br />
|-<br />
| SRH-2D<br />
| 4<br />
| All INLET cells are dry sets are dry from bc_mdot2.f90! Code may have blow up (sic) due to input errors or too-large time-step. <br />
| <br />
| This problem typically arises because the polygons that you have given for the obstructions do not overlap any element centroids. The problem can be solved by refining the elements in the area of the obstructions until the obstruction polygon is well represented by elements whose centroids lie within the spatial extent of the polygons.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| MESH-UNIT: Enter one of the following options for the unit of the mesh<br />
| Mesh unit error<br />
| SRH requires that vertical and horizontal units be in either meters or U.S survey feet<br />
|-<br />
| SRH-2D<br />
| 8<br />
| Inconsistent cell ID in mesh_connectivity: maybe due to wrong nodestring<br />
| <br />
| Possibly due to overlapping elements<br />
|-<br />
| PreSRH-2D<br />
| <br />
| a face cannot be found given two mesh points<br><br />
Two points are: 38383 38494<br />
Check your mesh node list; you may do this using _SIF.dat file directly!<br />
| Errors from final touch.f90 on MONITOR LINE#2<br><br />
Inconsistent or disconnected nodestring for a monitor line<br />
| This was caused by having a monitoring line run across a large "hole" in the mesh. The hole was large enough that we were not snapping the monitor line to a valid nodestring.<br />
|-<br />
| PreSRH-2D<br />
| 1<br />
| Stopped in add_nbdf.90 DIS<br />
| Issue with BC nodestrings<br />
| In this case, this issue was from a bug where SMS was exporting the nodestring in the SRHGEOM file incorrectly for two HY8 culvert arcs. SMS was essentially writing the same string of nodes for both the upstream and downstream culvert arcs.<br />
|-<br />
| SRH-2D<br />
| 1<br />
| Stopped in face_wd.f90 PRESS#1<br />
| Issue with Pressure Flow BC and "Piers"<br />
| In this problem, SRH2D did not allow holes in the mesh that represented bridge piers within the Pressure flow zone. This is only a problem in SMS v.12.1 and the SRH executable supplied with it. SMS 12.2 and the SRH executable supplied with it now allows holes in the mesh within Pressure zones. The same error will also be shown if an "unassigned" material type is specified in the pressure zone, again this is only a problem in SMS v12.1 and the SRH exe supplied with it, 12.2 allows "unassigned" material types in the pressure flow zone.<br />
|-<br />
| SRH-2D<br />
| <br />
| Program Stopped as Mesh is different in RST file<br><br />
One of the following is different:<br><br />
Ncell Nvert Nface Nclfc Nclvt in RESTART file<br><br />
do not match those in the input file<br><br />
Ncell Nvert Nface Nclfc Nclvt<br><br />
in restart file are: 13604 7374 20977 41693 41693<br><br />
in casename.GRD file are: 15459 8277 23735 47225<br><br />
Mesh topology has to be the same for irest>=1 or init_method=3<br />
| Using a restart file that was created with another mesh<br />
| Restart files can only be used with simulations using the exact same mesh.<br />
|-<br />
| PreSRH-2D<br />
| <br />
| Could not find a mesh cell which contains the monitoring point! Check if you have the right input of (X Y) coordinates for a monitoring points<br />
| Monitor Point Outside of Mesh<br />
| Monitor point must be somewhere within a mesh element.<br />
|-<br />
| SRH-2D<br />
| 6940<br />
| <br />
| <br />
| Ensure that areas approaching and leaving culverts have a valid material type assigned.<br />
|}<br />
<br />
==Related Topics==<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
* [[SMS:Bugfixes|SMS Bugfixes]]<br />
<br />
<br />
{{Navbox SMS}}<br />
<br />
[[Category:SRH-2D|Errors]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119075SMS:Community Version2017-02-03T22:16:41Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Version." This version provides limited access to the [[SMS:SRH-2D|SRH-2D]] model interface. Access to the Community Version can be obtained by requesting a license code via the internet from the [[SMS:Registering SMS|''Register'']] dialog in SMS reached through the [[SMS:Help Menu|''Help | '''Register''']] menu command. In the ''Register'' dialog, select the '''Change Registration''' button then click the '''Request License''' button to be sent to Aquaveo's website.<br />
<br />
A license can also be requested directly at: [http://www.aquaveo.com/request-community www.aquaveo.com]<br />
<br />
Please note technical support is not provided for the Community Version.<br />
<br />
The Community Version main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to paving and patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (*.dhp, *.dem, *.dtm, *.asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (*.dwg, *.dxf, *.dgn, etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (*.xyz, *.las, *.h5, *.tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features and Capabilities NOT available in the Community Version<br />
|-<br />
| Advanced Meshing Tools including Scalar Paving Density<br />
|-<br />
| Export GIS Files<br />
|-<br />
| Export CAD Files<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|-<br />
| Dataset Toolbox and Data Calculator<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119037SMS:Community Version2017-02-02T23:09:25Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Version." This version provides limited access to the [[SMS:SRH-2D|SRH-2D]] model interface. Access to the Community Version can be obtained by requesting a license code via the internet from the ''Registration Wizard'' in SMS (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Please note that Technical support is not provided for the Community Version.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features and Capabilities NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density<br />
|-<br />
| Export GIS files<br />
|-<br />
| Export CAD files<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119036SMS:Community Version2017-02-02T23:09:10Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Version." This version provides limited access to the [[SMS:SRH-2D|SRH-2D]] model interface. Access to the Community Version can be obtained by requesting a license code via the internet from the ''Registration Wizard'' in SMS (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Please note that Technical support is not provided for the Community Version.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features and Capabilities NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density<br />
|-<br />
| Export GIS files<br />
|-<br />
| Export CAD files<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119035SMS:Community Version2017-02-02T23:08:49Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Version". This version is provides limited access to the [[SMS:SRH-2D|SRH-2D]] model interface. Access to the Community Version can be obtained by requesting a license code via the internet from the ''Registration Wizard'' in SMS (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Please note that Technical support is not provided for the Community Version.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features and Capabilities NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density<br />
|-<br />
| Export GIS files<br />
|-<br />
| Export CAD files<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119033SMS:Community Version2017-02-02T22:55:37Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Technical support is not provided for the Community Edition.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features and Capabilities NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density<br />
|-<br />
| Export GIS files<br />
|-<br />
| Export CAD files<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119032SMS:Community Version2017-02-02T22:55:06Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Technical support is not provided for the Community Edition.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density.<br />
|-<br />
| Export GIS files<br />
|-<br />
| Export CAD files<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119031SMS:Community Version2017-02-02T22:54:41Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Technical support is not provided for the Community Edition.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| Import HEC-RAS Cross Sections ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|}<br />
<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density.<br />
|-<br />
| Exporting GISdata<br />
|-<br />
| Exporting CAD data<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119029SMS:Community Version2017-02-02T22:51:48Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
Technical support is not provided for the Community Edition.<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|- <br />
| 3D Viewing ||<br />
|-<br />
| Lighting Model ||<br />
|}<br />
<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!Features NOT available in the Community Version<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density.<br />
|-<br />
| Exporting GISdata<br />
|-<br />
| Exporting CAD data<br />
|-<br />
| Texture Mapping<br />
|-<br />
| ARR Plots and Mesh Quality Scatter Sets<br />
|-<br />
| Feature Stamping<br />
|-<br />
| Functional Surface<br />
|-<br />
| Calibration Tools<br />
|-<br />
| Observation Tools and Plots<br />
|}<br />
<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119025SMS:Community Version2017-02-02T22:43:15Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
The Community Edition main capabilities and limitations are as follows:<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh. Meshing options limited to Paving and Patches.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import GIS Data (.dhp, .dem, .dtm, .asc, etc.) || Export to GIS or shapefile not available.<br />
|-<br />
| Import CAD Data (.dwg, .dxf, .dgn etc.) || Export to CAD format not available.<br />
|-<br />
| Import Terrain Data (.xyz, .las, .h5, .tin, etc.) || <br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|- <br />
| 3D Viewing ||<br />
|-<br />
| Lighting Model ||<br />
|}<br />
<br />
Features not available in the Community Version:<br />
{| class="wikitable"<br />
|-<br />
!Feature<br />
|-<br />
| Advanced meshing tools including Scalar Paving Density.<br />
|-<br />
| a<br />
|}<br />
<br />
Technical support is NOT provided for the Community Edition.<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119023SMS:Community Version2017-02-02T22:35:36Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
The Community Edition capabilities and limitations are as follows:<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import CAD/GIS Data ||<br />
|-<br />
| [[SMS:Display Options|Display Options]] ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|- <br />
| 3D Viewing ||<br />
|-<br />
| Lighting Model ||<br />
|}<br />
<br />
Technical support is NOT provided for the Community Edition.<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119022SMS:Community Version2017-02-02T22:33:56Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Request License''').<br />
<br />
The Community Edition capabilities are as follows:<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import CAD/GIS Data ||<br />
|-<br />
| [[SMS:Display Options|Display Options]] ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|- <br />
| 3D Viewing ||<br />
|-<br />
| Lighting Model ||<br />
|}<br />
<br />
Technical support is NOT provided for the Community Edition.<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119020SMS:Community Version2017-02-02T22:32:38Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Get Community Edition License''').<br />
<br />
The Community Edition capabilities are as follows:<br />
{| class="wikitable"<br />
|-<br />
!Feature !! Notes and Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import CAD/GIS Data ||<br />
|-<br />
| [[SMS:Display Options|Display Options]] ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|- <br />
| 3D Viewing ||<br />
|-<br />
| Lighting Model ||<br />
|}<br />
<br />
Technical support is NOT provided for the Community Edition.<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Community_Version&diff=119019SMS:Community Version2017-02-02T22:30:46Z<p>Morelandtom: </p>
<hr />
<div>{{Version SMS 12.2}}<br />
Starting at version 12.2 there is a free version of SMS called "Community Edition". It is limited to include only the [[SMS:Mesh_Module|2D mesh module]] and the [[SMS:SRH-2D|SRH-2D]] model interface. Any SHR-2D project can be imported, but if there is more than one mesh or one simulation, the project cannot be saved. The community edition must still be [[SMS:Registering_SMS|registered]] using a license code which can be obtained via the internet from the ''Registration Wizard'' (''Help | Register | Change Registration'' | '''Get Community Edition License''').<br />
<br />
The Community Edition capabilities are as follows:<br />
{| class="wikitable"<br />
|-<br />
!Included Feature !! Limitations<br />
|-<br />
| [[SMS:Mesh Module|2D Mesh Module]] || Limited to one mesh.<br />
|-<br />
| [[SMS:Map Module|Conceptual/Map Module Tool]] ||<br />
|-<br />
| [[SMS:SRH-2D|SRH-2D Interface]] || Limited to one simulation.<br />
|-<br />
| Import CAD/GIS Data ||<br />
|-<br />
| [[SMS:Display Options|Display Options]] ||<br />
|-<br />
| [[SMS:Images|Import Images]] ||<br />
|-<br />
| [[Get Online Maps|Online Maps]] ||<br />
|- <br />
| 3D Viewing ||<br />
|-<br />
| Lighting Model ||<br />
|}<br />
<br />
Technical support is NOT provided for the Community Edition.<br />
<br />
==Related Topics==<br />
* [[SMS:Registering SMS|Registering SMS]]<br />
<br />
<br />
{{Navbox SMS}}<br />
[[Category:SMS General Information]]<br />
[[Category:Support]]<br />
[[Category:Set Up]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Dynamic_Model_Interface_Schema&diff=108228SMS:Dynamic Model Interface Schema2016-07-14T14:19:50Z<p>Morelandtom: /* Attributes A-C */</p>
<hr />
<div>The dynamic model interface is available in SMS version 11.2 and later. It is primarily a tool for developers. The dynamic model interface provides a way to quickly generate an interface for a numeric model.<br />
<br />
{{TOC hidden}}<br />
<br />
==Dynamic Dialogs==<br />
Dynamic dialogs are a quick way to generate dialogs without having to compile code. To add or delete a widget on a dynamic dialog, the user simply modifies the XML document. When the modified document is loaded, the new/modified dialog exists. The XML document defines the layout, behavior and the different dialog controls.<br />
<br />
The dialog is divided into 2 sections: the tree view and the widget view. The tree is on the left side of the dialog and contains groups and items that represent data. Clicking on a group or item will result in the widget view being updated to match the selected tree or group item.<br />
<br />
* Order of the tree items and groups will match the order defined in the XML file.<br />
* Clicking on group will display all children items in the widget view.<br />
* Clicking on a single item will display associated widgets in widget view.<br />
* Tree item will also display the values in a non-editable field.<br />
* Unique_name use format: file::unique_name#value <br />
* Multiple widgets, when displayed on the right side, can be expanded/collapsed.<br />
* Can have nested groups.<br />
* Keywords are words SMS has reserved in the schema and can not be used as unique names. All keywords will start with a "#". <br />
<br />
===Available Keywords===<br />
This is a list of available keywords. Additional keywords are defined with the various custom control widgets. Note that in changing from version 1 to version 2, all tags that were <code><custom_control_XXXX></code> were changed to <code><control_XXXX></code>.<br />
<br />
<!-- template for this section <br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | General Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="100" style="text-align:left;" | '''entry''' <br />
| width="500" style="text-align:left;" | description or &nbsp;<br />
|-<br />
|&nbsp; '''entry''' <br />
| description or &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''entry''' <br />
| description or &nbsp;<br />
|-<br />
|&nbsp; '''entry''' <br />
| description or &nbsp;<br />
|}<br />
<br />
--><br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | General Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="100" style="text-align:left;" |&nbsp; '''&#35;card_name''' <br />
| width="500" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;geom_name''' <br />
| name of geometry as it shows up in the project explorer<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;project_name''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;value''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;units''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;xmdf_path''' <br />
| path inside the XMDF file<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;file_name''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;file_path''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;sms_path''' <br />
| path in sms project explorer once inside a geometric item<br />
|-<br />
|&nbsp; '''&#35;count''' <br />
| used for a widget in a table for counting the rows/columns<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;geom_guid''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | Arc Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="140" style="text-align:left;" |&nbsp; '''&#35;arc_id''' <br />
| width="460" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;arc_count''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;arc_point_count''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | Coverage Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="160" style="text-align:left;" |&nbsp; '''&#35;area_property ''' <br />
| width="440" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;activity_classification''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;cgrid_generator''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;location''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;mapping''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;mesh_generator''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;observation''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;quadtree_generator''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;spectral''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | executable_progress_update Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="140" style="text-align:left;" |&nbsp; '''&#35;progress_amount''' <br />
| width="460" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;progress_max''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | Material Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="120" style="text-align:left;" |&nbsp; '''&#35;material_id''' <br />
| width="480" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;material_name''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;material_count''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;unassigned''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | Point Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="100" style="text-align:left;" |&nbsp; '''&#35;point_count''' <br />
| width="500" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;point_id''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;point_x''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;point_y''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;point_z''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | Polygon Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="160" style="text-align:left;" |&nbsp; '''&#35;polygon_id''' <br />
| width="440" style="text-align:left;" | &nbsp;<br />
|-<br />
|&nbsp; '''&#35;polygon_count''' <br />
| &nbsp;<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;polygon_point_count''' <br />
| &nbsp;<br />
|}<br />
<br />
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;"<br />
|- <br />
! width="400" style="text-align:left;" colspan="2" | Projection Keywords<br />
|- style="background-color:#F0F0FF;"<br />
| width="140" style="text-align:left;" |&nbsp; '''&#35;horizontal_datum''' <br />
| width="460" style="text-align:left;" | NAD83, NAD27, LOCAL<br />
|-<br />
|&nbsp; '''&#35;horizontal_system''' <br />
| UTM, STATE_PLANE, GEOGRAPHIC, LOCAL<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;horizontal_units''' <br />
| FEET, METERS, DEGREES<br />
|-<br />
|&nbsp; '''&#35;horizontal_zone''' <br />
| 3104, etc.<br />
|- style="background-color:#F0F0FF;"<br />
|&nbsp; '''&#35;vertical_datum''' <br />
| &nbsp;<br />
|-<br />
|&nbsp; '''&#35;vertical_units''' <br />
| &nbsp;<br />
|}<br />
<br />
==Elements== <br />
Sorted alphabetically by element name.<br />
<br />
===Elements A - C===<br />
{{XML entry<br />
| name = arc_att<br />
| info = Used to specify what attributes should be used for the arcs of a coverage.<br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = attribute_set<br />
| info = This represents an item in the project explorer that is some sort of grouping.<br />
| version = 4<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Elements <takes>|takes]], [[SMS:Dynamic Model Interface Schema#Elements <menu_item>|menu_item]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Elements <model>|model]]<br />
| example = See the model example.<br />
}}<br />
<br />
{{XML entry<br />
| name = card<br />
| info = Determines the card name and format when the item is exported. For more examples see [[SMS:Dynamic Model Interface Schema#Element <export_format>|<export_format>]].<br />
| version = 1<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], anything beginning with "process_each_", [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Attribute <use_parameter>|use_paramter]].<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]] (version 1), file_def (version 2)<br />
| example = <item text = "Formulation"><br />
<card><br />
<card_name>FORMULATION</card_name><br />
<export_format>card "formulationUnits"</export_format><br />
</card> <br />
}}<br />
<br />
{{XML entry<br />
| name = card_name<br />
| info = The name of the card which is used in the card file.<br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = check_box<br />
| info = Widget that displays text that is checked/unchecked.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Element <default>|default]], <br />
[[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_checked]], <br />
[[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_unchecked]], <br />
[[SMS:Dynamic Model Interface Schema#Element <text>|text]], <br />
[[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]].<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]]<br />
| example = <br />
<check_box text = "Calculate Sediment Transport" <br />
default = "checked"<br />
unique_name = "togCalcSedimentTransport" <br />
export_text_checked = "ON" <br />
export_text_unchecked = "OFF"><br />
<dependency>…</dependency>…<br />
</ check_box ><br />
}}<br />
<br />
{{XML entry<br />
| name = color<br />
| info = The color of an item, expressed in red, green, and blue values ranging from 0 to 255. All 0 values for red, green and blue are black. Added in SMS 11.2.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <blue>, <green>, <red>|red]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <blue>, <green>, <red>|green]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <blue>, <green>, <red>|blue]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| example = <br />
This would change the text to a bright red color.<br />
<text_style> <br />
<color red = "255" green="0" blue="0"></color><br />
<text_style><br />
}}<br />
<br />
{{XML entry<br />
| name = column<br />
| info = Definition of the column in the table. A widget defined in a column will be the widget used for each cell in the column.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <read_only>|read_only]], <br />
[[SMS:Dynamic Model Interface Schema#Element <optional>|optional]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with "control_", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element < table >|table]]<br />
| example = Column1 is read only, Column 2 isn't read only and is also optional.<br/> This means the column can have empty fields and a warning message won't be displayed.<br />
<br />
< table ><br />
<br />
. . .<br />
<column text = "Column1" read_only><br />
</column><br />
< column text = "Column2 optional></ column><br />
</table><br />
}}<br />
<br />
{{XML entry<br />
| name = combo_box<br />
| info = Widget that displays list of options. Only 1 can be selected. If no default is specified and the optional tag is present, then an empty option will be added to the combo box. If there is no default tag, and no optional tag, then the first item will be default.<br />
<br />
In version 2, if a combo box has display_options, and is part of a dialog that is used as an arc attribute, then a limited set of display options will appear for the options of the combo box. The display option for each option of the combo box will only be line thickness and color. The display option is NOT saved at any point and will be reset every time SMS is opened.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <optional>|optional]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <optional>|optional]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]] (version 2)<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Creates a combo box with hours, minutes and seconds. Hours is the default item.<br />
<combo_box unique_name="cbxTransportUnits"> <br />
<option text = "hours" default></option><br />
<option text = "minutes"></option><br />
<option text = "seconds"></option><br />
<dependency>…</dependency>…<br />
</ combo_box ><br />
}}<br />
<br />
{{XML entry<br />
| name = command_args<br />
| info = Defines the command line arguments to run a particular executable.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_file>|use_file]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]]<br />
| example = See executable example.<br />
}}<br />
<br />
{{XML entry<br />
| name = comment<br />
| info = Defines a character or sequence of characters that defines the start of a comment on a line. Comments are always terminated by an end of line.<br />
| version = 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <use_file_def>|use_file_def]]<br />
| example = The following example has a file where the exclamation point starts the comment.<br />
<br />
<file_def><br />
...<br />
<comment>!</comment><br />
…<br />
</file_def><br />
}}<br />
<br />
{{XML entry<br />
| name = condition<br />
| info = Evaluates two or more objects using GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, EQUALS, AND, OR, NOT, CHECKED, UNCHECKED, EMPTY. If condition is not met, then message is displayed (if model_check) or widget is hidden/dimmed (if dependency). String literals, such as an entry in a combo-box, must be enclosed in double-quotes (ex. "Combo box entry").<br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| example = <br />
< table ><br />
<column text="A"><br />
<edit_box unique_name="colA"><br />
</edit_box><br />
</column><br />
…// other columns also defined<br />
<br />
<model_check problem_text="Column D or E is required"><br />
<condition>( (colA EQUALS 0.0 OR colB LESS_THAN 0.0) AND NOT(colD NOT EQUALS EMPTY OR colE NOT EQUALS "Some value"))</condition><br />
</model_check><br />
< /table ><br />
}}<br />
<br />
{{XML entry<br />
| name = contains<br />
| info = Holds all the groups and items of a group.<br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]]<br />
| used_by = group<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = control_curve<br />
| info = Displays a curve push button. When pushed, the xy curve values can be updated and a curve is displayed.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <flags>|flags]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Attribute <max_row_count>|max_row_count]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <x_column>|x_column]], [[SMS:Dynamic Model Interface Schema#Element <y_column>|y_column]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = This example creates a curve limited to 10 rows.<br />
<item><br />
<control_curve unique_name="myCurve1"<br />
max_row_count="10"<br />
flags = "XY_USEDATE"><br />
<x_column text="Time"></x_column><br />
<y_column text="Velocity"> <br />
</y_column> <br />
</control_curve><br />
…<br />
<br />
}}<br />
<br />
{{XML entry<br />
| name = control_dataset<br />
| info = Displays an edit box, and push buttons for select, delete and create. Once selected, the dataset string is placed into the edit box. The dataset_type can be scalar or vector. Possible keyword outputs are file_name (which is the name of the dataset without path), geom_name, and file_path (full path c:\somewhere) and sms_path.<br />
<br />
By default, all datasets of geometries that are part of the simulation (or part of the parameters if one or more use_parameter is used) can be selected. The the geometry attribute is set to "all", then the datasets from all geometries currently loaded into SMS can be selected from, regardless of relation to the simulation and assuming no other attribute prevents it. If "all" is used, then the dataset values will be interpolated to the geometry in the simulation.<br />
<br />
The time_type attribute can be set to "all" (default), "transient", or "steady state". When "transient" is used, only datasets with multiple timesteps may be selected. When "steady state" is used, only timesteps without timesteps may be selected.<br />
<br />
The select_time attribute can be set to "all" (default), "single", or "range". If "single" is used, then only a single timestep of the dataset will be selected. If "range" is used, then both a starting and ending timestep can be selected. By default, all timesteps of a dataset are used.<br />
<br />
(For possible future use.)The interpret_time attribute can be set to "true" or "false" (default). When true, this attribute tells SMS to interpolate dataset values at the timesteps in the selected dataset to values at timesteps calculated from a start time, end time, and delta time that is specified by the user.<br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <geometry>|geometry]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <time_type>|time_type]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <select_time>|select_time]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <interpret_time>|interpret_time]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <dataset_type>|dataset_type]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <name>|name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <push_button>|push_button]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <dataset_name>|dataset_name]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]] (version 2), [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], use_parameter<br />
| example = This example creates the custom control with only the select and delete buttons.<br />
<item><br />
<control_dataset dataset_type="scalar"><br />
<push_button>select<push_button><br />
<push_button>delete</push_button><br />
</control_dataset><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_date<br />
| info = Displays date and time selector, where a date can be selected.<br/> Possible output is value, which will be the date formatted as specified in SMS preferences.<br/> Possible outputs are year, month, day, hour, minute, second.<br />
<br />
Keywords:<br />
* #DAY_DIGIT <br />
* #DAY_DIGIT_ZERO <br />
* #DAYS_IN_YEAR <br />
* #DAY_SHORT_NAME <br />
* #DAY_LONG_NAME <br />
* #MONTH_DIGIT <br />
* #MONTH_DIGIT_ZERO <br />
* #MONTH_SHORT_NAME <br />
* #MONTH_LONG_NAME<br />
* #YEAR_2 <br />
* #YEAR_4 <br />
* #HOUR <br />
* #HOUR_ZERO<br />
* #HOUR_24<br />
* #HOUR_24_ZERO<br />
* #MINUTE<br />
* #MINUTE_ZERO<br />
* #SECOND<br />
* #SECOND_ZERO<br />
* #AM_PM <br />
* #AM_PM_CAPS <br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = <br />
<item text ="Start date><br />
<control_date unique_name="edtDate"><br />
</control_date><br />
<card><br />
<card_name>DATE</card_name><br />
<export_format>"%s Day:%s Month:%s Year:%s Hour:%s Minute%s Second:%s\n", #card_name, edtDate#DAY_DIGIT, edtDate#MONTH_LONG_NAME, edtDate#YEAR_4, edtDate#HOUR_24, edtDate#MINUTE_ZERO, edtDate#SECOND_ZERO</export_format><br />
</card><br />
}}<br />
<br />
{{XML entry<br />
| name = control_density<br />
| info = Displays an edit box and combo box. Combo box can contain kg/m^3, gr/cm^3, lb/ft^3. Possible outputs are value and units.<br />
<br />
Keywords:<br />
* #MPV_MG_PER_L<br />
* #MPV_G_PER_L<br />
* #MPV_KG_PER_CU_M<br />
* #MPV_G_PER_CU_CM<br />
* #MPV_LB_PER_CU_FT<br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Element <default>|default]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = <br />
Displays kg/m^3 and lb/ft^3 in combo box. If kg/m^3 selected and exported, returns the text "kg m".<br />
<item><br />
<text>Density </text><br />
<control_density><br />
<option text="kg/m^3"<br />
export_text = "kg m"<br />
unit_keyword="#MPV_KG_PER_CU_M"><br />
</option><br />
<option text="lb_ft^3"<br />
export_text ="lbs ft"<br />
unit_keyword = "#MPV_LB_PER_CU_FT"><br />
</option><br />
</control_density><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_duration<br />
| info = Displays an edit box and combo box. Combo box contains days, hours, minutes, seconds. Possible outputs are value and units.<br />
<br />
Keywords:<br />
* #TIME_SECONDS<br />
* #TIME_MINUTES<br />
* #TIME_HOURS<br />
* #TIME_DAYS<br />
* #TIME_WEEKS<br />
* #TIME_YEARS<br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Displays only minutes and hours in combo box. If hours selected and exported, returns the text "hrs".<br />
<item text ="Transport Time Step"><br />
<control_duration><br />
<option text="minutes"<br />
export_text = "min"<br />
unit_keyword = "#TIME_MINUTES"><br />
</option><br />
<option text = "hours"<br />
export_text = "hrs"<br />
unit_keyword = "#TIME_HOURS"<br />
default><br />
</option><br />
</control_duration><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_executable<br />
| info = Displays a button for running a simulation from a dialog. Unlike the normal simulations found in the project explorer, these simulations are generally hidden from the user. As such, the options that can be used are significantly less than those of a normal simulation.<br />
<br />
The model attribute defines the name of the model to be executed. The model may be one that is already defined by another XML file. Dialogs can be specified for data that will be kept for the model, but will not be shown to the user. The simulation and files specified with this control may not be the same as one already specified in another XML file.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <model>|model]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]], dependency, text_style, [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <dialogs>|dialogs]], [[SMS:Dynamic Model Interface Schema#Element <files>|files]]<br />
| example = This example declares a control_executable that runs "MyModel".<br />
<br />
<control_executable model = "MyModel" <br />
unique_name="exeMyModel"><br />
<declare dialogs><br />
<declare dialog name="Arc BC"><br />
<pages><br />
<page_def name="ArcBC"<br />
display="NO_NAV"><br />
<contains><br />
<item><br />
<edit_box unique_name="edtMyModelText"><br />
</edit_box><br />
</item><br />
</contains><br />
</page_def><br />
</pages><br />
</dialog><br />
</dialogs><br />
<simulation><br />
<executable name ="MyModel"><br />
<use_parameter>HydroFile</use_parameter><br />
<execute_command><br />
<command_args>" \"%s\"", edtMyModelText</command_args><br />
<execute>"%s", #executable_name</execute> <br />
</execute_command><br />
</executable><br />
<input_files><br />
<input_file><br />
<use_file_def>myFile</use_file_def><br />
<export_location>"%s.srhhydro", #project_name</export_location><br />
<declare_parameter>HydroFile</declare_parameter><br />
<input_file> <br />
</input_files> <br />
</simulation><br />
<files><br />
<declare file_def name=MyFile type=CARD_ASCII> <br />
<comment>! this is myfile</comment><br />
</declare file_def><br />
</files><br />
</control_executable><br />
}}<br />
<br />
{{XML entry<br />
| name = control_feature_selector<br />
| info = Push button that opens a canvas window that allows users to select one or more points, arcs or polygons that are in the main window.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <feature>|feature]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <range>|range]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Allows the user to select 1 to 10 arcs<br />
<item><br />
<control_feature_selector feature = "arc"><br />
unique_name="mySelector"><br />
<range>1-10</range> <br />
</control_feature_selector><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_file_selector<br />
| info = Push button that opens a file open dialog to select files. Possible outputs are file_path.<br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <create_file>|create_file]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <filter>|filter]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Opens a file dialog, filtering on files with *.h5 and *.cmcards extensions<br />
<item><br />
<text>File:</text><br />
<control_file_selector<br />
filter = "Cmcards file (.cmcards)"> <br />
</control_file_selector><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_length<br />
| info = Displays an edit box and combo box. Combo box can contain meters, cm, mm, um, ft, in. Possible outputs are value and units.<br />
<br />
Keywords:<br />
* #LEN_MM<br />
* #LEN_CM<br />
* #LEN_M<br />
* #LEN_KM<br />
* #LEN_INCH<br />
* #LEN_FT<br />
* #LEN_YD<br />
* #LEN_MILE<br />
* #LEN_UM<br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Displays only cm, and mm in combo box. If cm is selected and exported, returns the text "centimeter".<br />
<item text = "Length"><br />
<control_length unique_name="myLength"><br />
<option><br />
text = "cm"<br />
export_text="centimeter"<br />
unit_keyword = "#LEN_CM"><br />
</option><br />
<option><br />
text = "mm"<br />
export_text = "mm"><br />
unit_keyword="#LEN_MM"<br />
default<br />
</option><br />
</control_length><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_nesting<br />
| info = Push button that opens a special dialog to create nesting points. The dialog allows the user to select a parent and child grid and a coverage to put the nesting sites in.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Creates the nesting dialog widget<br />
<item><br />
<control_nesting unique_name="ccNesting"><br />
</control_nesting><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_set<br />
| info = Table like widget that allows for multiple points, polygons, or arcs to be joined together as a set. An example usage would be to join two arcs in creating a weir. By default the <control_set> contains two columns, object and role. The object column identifies the arc, point, or poly id. The role column is a user defined combo box that allows for customization of types and behavior. See <roles>. Addition columns can be added by simply adding a <column> tag with a widget. See tables. When exporting you can use the #object or #role keyword for retrieving data from those particular columns.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <min>|min]] (default = 0), <br />
[[SMS:Dynamic Model Interface Schema#Attribute <max>|max]] (default = 2.147 billion),<br />
[[SMS:Dynamic Model Interface Schema#Attribute <increment>|increment]] (default is 1), <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <roles>|roles]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Example of a culvert widget with a extra "Name" column. The culvert requires 2 arcs. <br />
<control_set min = "2" <br />
max = "2"<br />
unique_name = "tblSetCulverts"><br />
<roles behavior = "SWAP"><br />
<role text = "upper"><br />
<range>1-1</range><br />
</role><br />
<role text = "lower"><br />
<range>1-1</range> <br />
</role><br />
</roles><br />
<column text = "Name"><br />
<edit_box unique_name="edtMyArcsName"<br />
type="text"> <br />
</edit_box><br />
</column><br />
</control_set><br />
<br />
User allows for either 2 or 4 arcs on a weir. <br />
<control_set min = "2" max = "4" increment = "2" ><br />
….<br />
}}<br />
<br />
{{XML entry<br />
| name = control_velocity<br />
| info = Displays an edit box and combo box. Combo box can contain m/sec, m/min, m/hours, etc.... Also could be m/sec, cm/sec, ft/sec, etc... The option tag specifies which options are displayed. The edit box will display doubles, within the given range, if provided. Possible outputs are value and units.<br />
<br />
Keywords:<br />
* #VEL_M_PER_S<br />
* #VEL_KM_PER_H<br />
* #VEL_FT_PER_S<br />
* #VEL_MPH<br />
* #VEL_KNOTS<br />
* #VEL_CM_PER_S<br />
* #VEL_MM_PER_S<br />
| version = 1 (<custom_control_XXXX>), 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Displays m/sec and cm/sec in combo box. If m/sec selected and exported, returns the text "m sec".<br />
<item><br />
<text>Velocity </text><br />
<control_velocity unique_name="ccVelocity"><br />
<range>0-100</range><br />
<option text="m/sec"<br />
export_text = "m sec"<br />
unit_keyword = "#VEL_M_PER_S"><br />
</option><br />
<option text = "cm/sec"<br />
export_text = "cm sec"xt<br />
unit_keyword = "#VEL_CM_PER_S"><br />
</option><br />
</control_velocity><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = control_volume_flow<br />
| info = Displays an edit box and combo box. Combo box can contain m^3/sec, m^3/min, m^3/hours, etc.... Also could be m^3/sec, cm^3/sec, ft^3/sec, etc... The option tag specifies which options are displayed. The edit box will display doubles, within the given range, if provided. Possible outputs are value and units.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = Displays m^3/sec and cm^3/sec in combo box. If m^3/sec selected and exported, returns the text "m^3 sec".<br />
<item text="Volume flow"><br />
<control_volume_flow unique_name ="ccVolumeFlow"> <br />
<range>0-100</range><br />
<option<br />
text = "m^3/sec"<br />
export_text = "m^3 sec"<br />
unit_keyword = "#VFLOW_CU_M_PER_SEC"><br />
</option><br />
<option<br />
text = "cm^3/sec"<br />
export_text = "cm^3 sec"<br />
unit_keyword = "#VFLOW_CU_CM_PER_SEC"><br />
</option><br />
</control_volume_flow><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = count_filter<br />
| info = Specifies the range on which the process_on_count is valid.<br />
| version = 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_on_count>|process_on_count]]<br />
| example = <br />
}}<br />
<br />
===Elements D - H===<br />
{{XML entry<br />
| name = dataset_name<br />
| info = Determines the name of the dataset to be created. Uses the standard printf and sprintf format ([http://www.cplusplus.com/reference/clibrary/cstdio/printf/ www.cplusplus.com/reference/clibrary/cstdio/printf/]). The keywords #row_number, #column_number, #row_name, and #column_name are used when the dataset is in a table.<br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
| example = <br />
<control_dataset> <br />
<dataset_name>"Five percent Layer %d", #row_number</dataset_name><br />
…<br />
</control_dataset><br />
}}<br />
<br />
{{XML entry<br />
| name = declare_coverage<br />
| info = Defines a coverage type for the model.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <z_is_elev>|z_is_elev]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <bind_to>|bind_to]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <use_icon>|use_icon]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <point_att>|point_att]], <br />
[[SMS:Dynamic Model Interface Schema#Element <arc_att>|arc_att]], <br />
[[SMS:Dynamic Model Interface Schema#Element <polygon_att>|polygon_att]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <material_att>|material_att]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <menu_item>|menu_item]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]]<br />
| example = This defines a coverage that can be created.<br />
<br />
<declare_coverage z_is_elev = "true" name="MyCov"><br />
<point_att><br />
<menu_item text = "Assign BC…" use_dialog = "NodeAtt"><br />
</menu_item><br />
</point_att><br />
<arc_att><br />
<menu_item text = "Assign BC…" use_dialog= "NodestringBC"><br />
</menu_item><br />
</arc_att><br />
<material_att use_dialog= "MaterialProp"</material_att><br />
</coverage><br />
}}<br />
<br />
{{XML entry<br />
| name = declare_dialogs<br />
| info = Contains all the dialogs used in a model.<br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = declare_dialog<br />
| info = Used to define a dialog. <br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <help_button_url>|help_button_url]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <help_button_wiki>|help_button_wiki]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <pages>|pages]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dialogs>|dialogs]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = declare_file<br />
| info = A way to declare a file that will be used in the future.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], [[SMS:Dynamic Model Interface Schema#Attribute <file_type>|file_type]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <comment>|comment]], [[SMS:Dynamic Model Interface Schema#Element <identifier>|identifier]], [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export>|export]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <files>|files]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = declare_pages<br />
| info = Signals the beginning of page creation for a dialog. One or more pages may be created using declare_page.<br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dialog>|dialog]]<br />
| example = <br />
<declare_dialog name ="Model Control"><br />
<declare_pages><br />
<declare_page text="Page1"><br />
….<br />
</declare_pagef><br />
<declare_page text ="Page2"><br />
….<br />
</declare_page><br />
</declare_pages><br />
}}<br />
<br />
{{XML entry<br />
| name = declare_page<br />
| info = This defines the page or tab of a dialog. If there is only one page_def in a dialog, then no tabs will appear.<br />
| version = 3<br />
| attributes = text, display<br />
| children = contains<br />
| used_by = declare_pages<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = declare_parameter<br />
| info = A way to declare data that will be used in the future.<br />
| version = 3<br />
| attributes = none<br />
| children = none<br />
| used_by = input_file, anything beginning with "process_each", takes<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = dependency<br />
| info = Dependencies allow widgets to be hidden, dimmed (grayed out), or shown based on the state/value of another widget. The [[SMS:Dynamic Model Interface Schema#Element <dependency>|<dependency>]] tag can be placed in any widget, combo-box option, item, or group. A user needs to specify the condition that this object is dependent upon and what the value(s) need(s) to be in order for the object to be shown/not dimmed. If the condition is false, by default the control is hidden. To have the control dimmed, use the [[SMS:Dynamic Model Interface Schema#Element <dim>|<dim>]] tag.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <dim>|dim]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], any element that begins with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <group>|group]]<br />
| example = '''Example 1'''<br />
We only want our edit_box displayed if the check_box is checked (true). If check_box is not checked, we want to dim (show but is grayed out) the edit_box.<br />
<br />
<check_box unique_name = "MyBox"><br />
…<br />
<br />
<edit_box><br />
<dependency dim> <br />
<condition>MyBox EQUALS CHECKED</condition><br />
</dependency><br />
<br />
'''Example 2'''<br />
We want our text_box displayed if the edit_box has a value between 0-3 or if the combo box has the value minutes or days.<br />
<br />
<edit_box unique_name="MyEdit_box"><br />
…<br />
<combo_box unique_name = "MyComboBox"><br />
<option text = "hours"></option><br />
<option text ="minutes"></option><br />
…<br />
<br />
<br />
<text_box><br />
<dependency><br />
<condition>(MyEdit_box GREATER_THAN_EQUALS 0 AND MyEdit_box LESS_THAN_EQUALS 3) OR (MyComboBox EQUALS "minutes" OR MyComboBox EQUALS "days")</condition><br />
</dependency><br />
</text_box><br />
}}<br />
<br />
{{XML entry<br />
| name = display_options<br />
| info = Specifies that the options in the combo box are to be used as arc/nodestring boundary condition display options. This element should only be used once in a combo_box and once in a edit_box per dialog.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <type>|type]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <text>|text]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]]<br />
| example = <br />
<combo_box unique_name="cbxArcDeleteMe"><br />
<display_options type= "point" text ="Save Points Name"></display_options><br />
<option text="Hydro" default></option><br />
<option text="Sediment"></option><br />
</combo_box><br />
}}<br />
<br />
{{XML entry<br />
| name = dynamic_model<br />
| info = Used to define a dynamic model.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <file_type>|file_type]] &ndash; always "dynamic model", <br />
[[SMS:Dynamic Model Interface Schema#Attribute <version>|version]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <model>|model]]<br />
| used_by = none<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = edit_box<br />
| info = Widget that displays text or numbers. If [[SMS:Dynamic Model Interface Schema#Element <type>|<type>]] not specified, default to double. The type can also be text, or integer.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <optional>|optional]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <type>|type]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = <br />
<edit_box type="double" <br />
default="1.0" <br />
unique_name="edtBox5"<br />
optional><br />
<range>0, 2.2</range><br />
<dependency>…</dependency>…<br />
</ edit_box ><br />
}}<br />
<br />
{{XML entry<br />
| name = end_card<br />
| info = Defines that the card end with a single iteration of the enclosing <process_each_XXX><br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = anything starting with process_each<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = executable<br />
| info = Represents a single executable used by the model.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <executable_order>|executable_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <default_executable_name32>|default_executable_name32]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <default_executable_name64>|default_executable_name64]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <executable_progress_update>|executable_progress_update]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]]<br />
| example = '''Example 1'''<br />
<executable name ="MyModel" executable_order = "1" <br />
default_executable_name32="MyModel32.exe"<br />
default_executable_name64="MyModel64.exe"><br />
<use_parameter>HydroFile</use_parameter><br />
<execute_command><br />
<command_args>" \"%s\"", edtMyModelText</command_args><br />
<execute>"%s", #executable_name</execute><br />
</execute_command><br />
</executable><br />
<input_files><br />
<input_file><br />
<use_file_def>myFile</use_file_def><br />
<export_location>"%s.srhhydro", #project_name</export_location><br />
<declare_paremeter>HydroFile</declare_parameter><br />
<input_file> <br />
</input_files> <br />
<br />
'''Example 2'''<br />
In the following example, one instance of the numeric model is executed per coverage. A file will be exported per coverage and no command line arguments are used when launching the model.<br />
<br />
<executable name = "SRH 2D" executable_order="1" </executable><br />
<use_parameter>MyCaseFile</use_parameter><br />
<executable_command><br />
<command_args>"\"%s\"", #file_name</command_args><br />
<execute>"%s - %s", #executable_name, #geom_name</execute><br />
</executable_command><br />
</executable><br />
<input_files><br />
<input_file><br />
<process_each_coverage><br />
<use_file_def>caseFile</use_file_def><br />
<export_location>"%s/%s", #geom_name, #project_name</export_location><br />
<declare_paramter>MyCaseFile</declare_parameter><br />
</process_each_coverage><br />
</input_file><br />
</input_files><br />
<br />
'''Example 3'''<br />
In the following example, only one instance of the numeric model is executed. A file will be exported per coverage and no command line arguments are used when launching the model.<br />
<br />
<executable name ="SRH 2D executable_order="1""</executable><br />
<executable_command><br />
<execute>"%s", #executable_name</execute><br />
</executable_command><br />
</executable><br />
<input_files><br />
<input_file><br />
<use_file_def>caseFile</use_file_def><br />
<process_each_coverage><br />
<export_location>"%s/%s", #geom_name, #project_name</export_location><br />
</process_each_coverage><br />
</input_file><br />
</input_files><br />
}}<br />
<br />
{{XML entry<br />
| name = executable_command<br />
| info = Defined command line arguments for the executable.<br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <command_args>|command_args]], [[SMS:Dynamic Model Interface Schema#Element <execute>|execute]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], anything starting with process_<br />
| example = See executable example.<br />
}}<br />
<br />
{{XML entry<br />
| name = executable_progress_update<br />
| info = Updates the status bar of the model based on output from the model.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <amount>|amount]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <max>|max]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <update_text>|update_text]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]<br />
| example = For a model that outputs "CASE 1 of 35","CASE 2 of 35" etc.. <br />
<br />
<executable name="My Model Main"><br />
<executable_progress_update <br />
progress_amount="0" progress_max ="35"><br />
<update_text>"CASE %d of %d" #progress_amount, #progress_max <br />
</update_text><br />
</executable_progress_update> <br />
</executable><br />
}}<br />
<br />
{{XML entry<br />
| name = execute<br />
| info = Defines when to run an executable. The text of this element is the text that will be displayed as the process name when running the model.<br />
| version = 2<br />
| attributes = none<br />
| children = none<br />
| used_by =[[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]]<br />
| example = See executable example.<br />
}}<br />
<br />
{{XML entry<br />
| name = export_format<br />
| info = Placed inside the [[SMS:Dynamic Model Interface Schema#Element <card>|<card>]] to determine how the card format will be displayed when exporting to a text file. Uses the standard printf and sprintf format (www.cplusplus.com/reference/clibrary/cstdio/printf/). "#card_name" should be used when displaying the card. When using an element that starts with "custom_control", a user can use the # character to get to the value or units.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]] (version 1), [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]] (Version 1), [[SMS:Dynamic Model Interface Schema#Element <export_each_coverage>|export_each_coverage]] (version 1), [[SMS:Dynamic Model Interface Schema#Element <export_each_polygon>|export_each_polygon]] (version 1), [[SMS:Dynamic Model Interface Schema#Element <export_each_arc>|export_each_arc]] (version 1), [[SMS:Dynamic Model Interface Schema#Element <export_each_point>|export_each_point]] (version 1),<br />
anything starting with process_each_<br />
| example = '''Example 1'''<br />
<br />
<edit_box unique_name="MyEditBox"><br />
</edit_box><br />
…<br />
<card><br />
<card_name>FIFTH_GRAIN</card_name><br />
<export_format>"%s %lf\n", #card_name, MyEditBox</export_format><br />
</card><br />
<br />
If the edit_box has the value of 15, this would print out:<br />
FIFTH_GRAIN 15<br />
<br />
'''Example 2'''<br />
If export_format was changed to this:<br />
<export_format>"%s \"%lf\" // comment\n", #card_name, MyEditBox<br />
</export_format><br />
<br />
FIFTH_GRAIN "15" // comment<br />
<br />
<control_length unique_name="MyLength"><br />
<br />
'''Example 3'''<br />
<br />
...<br />
</control_length><br />
…<br />
<card><br />
<card_name>ADAPTATION_LENGTH_TOTAL</card_name><br />
<export_format>"%s %lf, %s\n", #card_name, MyLength#value,<br />
MyLength#units</export_format><br />
</card><br />
<br />
ADAPTATION_LENGTH_TOTAL 25 cm<br />
}}<br />
<br />
{{XML entry<br />
| name = export_group<br />
| info = A way of grouping optional exports.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <required>|required]]<br />
| children = Any element beginning with "process_" and required (version 2), [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <mxmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]]<br />
| used_by = Any element beginning with "process_".<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = export_location<br />
| info = Relative or absolute path of the export file (.cmcards). Can be used multiple times if exporting to more than 1 file location. Keywords can be #PROJECT_NAME and #GEOMETRY.<br />
| version = 1, 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <inpute_file>|input_file]] (version 2), [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]] (version 2). If it used just within group then everything within the element will use the same export location unless specified in the child group or item card.<br />
| example = '''Example 1'''<br />
<export_location>\\Ideal__Inlet.cmcards</export_location><br />
<br />
'''Example 2'''<br />
<export_location>\\#PROJECT_NAME_#GEOMETRY.cmcards</export_location><br />
<export_location>"\\%s__%s.cmcards", #PROJECT_NAME, #GEOMETRY</export_location><br />
}}<br />
<br />
{{XML entry<br />
| name = export_optional<br />
| info = Indicator of text that might be included. If it has default as a child, then SMS will write out the text included in this element.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <default>|default]]<br />
| children = Any element beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <default>|default]] (version 2), [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], xmdf_dataset, xmdf_data, xmdf_group, xmdf_geometry, [[SMS:Dynamic Model Interface Schema#Element <section>|section]]<br />
| used_by = Any element beginning with "process_".<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = files<br />
| info = <br />
| version = 2<br />
| attributes = <br />
| children = file_def <br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_control_executable>|model_control_executable]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = group<br />
| info = Tree group item that contains one or more items or groups. <br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <item>|item]] (version 1), [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], contains (version 2)<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <link_to>|link_to]] (version 1), [[SMS:Dynamic Model Interface Schema#Element <page_def>|page_def]] (version 2), another <group> if nested (version 1), [[SMS:Dynamic Model Interface Schema#Element <contains>|<contains>]] (version 2)<br />
| example = <br />
<group text = "Timing"><br />
<item><br />
… tree item stuff<br />
</item><br />
</group><br />
}}<br />
<br />
===Elements I - O===<br />
{{XML entry<br />
| name = input_file<br />
| info = Defines a file to be used for input for an executable.<br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <use_file_def>|use_file_def]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <inpute_files>|input_files]]<br />
| example = See executable example.<br />
}}<br />
<br />
{{XML entry<br />
| name = input_files<br />
| info = A container to place all of the input files into for a simulation.<br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <input_file>|input_file]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = item<br />
| info = Tree item contains one or more widgets ([[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], etc). A tree item can contain multiple cards (version 1), but those cards must be mutually exclusive. <br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], any element starting with "control", [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <new_line>|new_line]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]]<br />
| example = <br />
<item><br />
<text>Transport Time Step</text><br />
<edit_box>…. </edit_box><br />
<card>…</card><br />
}}<br />
<br />
{{XML entry<br />
| name = location<br />
| info = Used to specify which point locations to export. Point locations are defined as: "corner", "mid", "center", "disjoint" and "all". Point locations can have a slightly different meaning based on their context as described below.<br />
<br />
Exporting coverage arc points: <br />
*mid = middle points of arc<br />
*corner = 2 end points of an arc<br />
*disjoint = not valid<br />
*center = not valid<br />
<br />
Exporting coverage polygon points:<br />
*mid = non nodes in the polygon<br />
*corner = nodes in the polygon<br />
*disjoint = not valid<br />
*center = not valid<br />
<br />
Exporting grid/quad points:<br />
*mid = midside points on the cell<br />
*corner = corner points on the cell<br />
*disjoint = not valid<br />
*center = center point on cell<br />
<br />
Exporting mesh points:<br />
*disjoint = disjoint points only<br />
*corner = end points of arcs, nodes in polygons<br />
*mid = mid points in arcs, mid points in polygons<br />
*center = not valid <br />
| version = 3<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]]<br />
| example = <br />
// writes out snapped coordinates of the 2 end points of each arc<br />
<process_each_coverage><br />
<use_parameter>myCov</use_parameter><br />
<process_each_arc source = "snap"><br />
<process_each_point source = "snap"><br />
<location>corner</location><br />
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z<br />
</export_format><br />
</process_each_point><br />
</process_each_arc><br />
</process_each_coverage><br />
<br />
// writes out all points of each arc<br />
<process_each_coverage><br />
<use_parameter>myCov</use_parameter><br />
<process_each_arc source = "snap"><br />
<process_each_point source = "snap"><br />
<location>corner</location><br />
<location>mid</location><br />
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z<br />
</export_format><br />
</process_each_point><br />
</process_each_arc><br />
</process_each_coverage> <br />
<br />
// writes disjoint nodes in a mesh<br />
<process_each_geometry><br />
<use_parameter>myMesh</use_parameter><br />
<process_each_point source = "geometry"><br />
<location>disjoint</location><br />
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z<br />
</export_format><br />
</process_each_point><br />
</process_each_geometry><br />
<br />
// writes all midpoints in a grid<br />
<process_each_geometry><br />
<use_parameter>myGrid</use_parameter><br />
<process_each_point source = "geometry"><br />
<location>mid</location><br />
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z<br />
</export_format><br />
</process_each_point><br />
</process_each_geometry><br />
}}<br />
<br />
{{XML entry<br />
| name = material_att<br />
| info = Used to specify what attributes should be used for materials of a coverage.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_dialog>|use_dialog]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]]<br />
| example = See coverage example.<br />
}}<br />
<br />
{{XML entry<br />
| name = max_rows<br />
| info = Optional element used to limit the number of rows the user can specify in a control_curve. If this element is not used, the max_rows is unlimited.<br />
| version = 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]]<br />
| example = This example creates a curve button with the date/time flag.<br />
<item><br />
<control_curve><br />
<unique_name>myCurve1</unique_name><br />
<max_rows>10</max_rows><br />
<x_column><br />
<text>Time</time><br />
</x_column><br />
<y_column><br />
<text>Velocity</text> <br />
</y_column> <br />
</control_curve><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = menu_item<br />
| info = Item to be placed in a menu. The text is the text displayed in the menu, use_dialog describes the dialog to be launched, dependency describes what needs to be true in order for the menu item to appear.<br />
The double_click attribute (if true) indicates that this is the menu item to be launched on a double click event. For example, if a menu_item is in an arc_att, and has double_click = "true", then when an arc is double clicked, the dialog specified by the menu item is launched.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <double_click>|double_click]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <use_dialog>|use_dialog]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <text>|text]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <attribute_set>|attribute_set]] (version 3), [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <point_att>|point_att]], [[SMS:Dynamic Model Interface Schema#Element <arc_att>|arc_att]], [[SMS:Dynamic Model Interface Schema#Element <polygon_att>|polygon_att]], [[SMS:Dynamic Model Interface Schema#Element <material_att>|material_att]]<br />
| example = See the model example.<br />
}}<br />
<br />
{{XML entry<br />
| name = msg<br />
| info = Used to display text to the user when a model check condition has failed.<br />
| version = (Version 3 replaced with problem_text, description_text and fix_text)<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]]<br />
| example = <br />
< table ><br />
<column text="A><br />
<edit_box unique_name = "colA"><br />
</edit_box><br />
</column><br />
…// other columns also defined<br />
<br />
<model_check problem_text = "Column D or E is required." <br />
description_text = "This model requires column D."<br />
fix_text = "To fix do the following: …... "><br />
<condition>( (colA OR colB) AND NOT(colD OR colE))</condition><br />
</model_check><br />
< /table ><br />
}}<br />
<br />
{{XML entry<br />
| name = model<br />
| info = Defines the model interface that is being created.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <version>|version]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <dialogs>|dialogs]], [[SMS:Dynamic Model Interface Schema#Element <files>|files]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dynamic_model>|dynamic_model]]<br />
| example = A simple model that has one coverage type, one dialog, and one file definition. This interfaces with version 4 of "MyModel".<br />
<br />
<dynamic_model filetype="dynamic model"><br />
version="2"><br />
<model name="MyModel" version="4"><br />
<simulation><br />
…<br />
</simulation><br />
<declare_coverage name= "MyCov">l</coverage><br />
...<br />
</coverage><br />
<declare_dialogs><br />
…<br />
</declare_dialogs><br />
<file_def><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = model_check<br />
| info = Used to validate data of multiple combinations when the '''OK''' button is clicked. Displays an error message if the logic in the [[SMS:Dynamic Model Interface Schema#Element <condition>|<condition>]] is false. Can use AND, OR, LESS_THAN, GREATER_THAN, EQUALS and NOT.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <problem_text>|problem_text]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <description_text>|description_text]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <fix_text>|fix_text]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_geometry>|process_each_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]] (version 1), [[SMS:Dynamic Model Interface Schema#Eleements <model_checks>|model_checks]] (version 2)<br />
| example = <br />
< table ><br />
<column text="A"><br />
<edit_box unique_name="colA"><br />
</edit_box><br />
</column><br />
…// other columns also defined<br />
< /table ><br />
<br />
<model_check problem_text = "Column D or E is required." <br />
description_text = "This model requires column D."<br />
fix_text = "To fix do the following: …... "><br />
<condition>( (colA EQUALS 0.0 OR colB EQUALS 0.0) AND NOT(colD EQUALS 0.0 OR colE EQUALS 0.0))</condition><br />
</model_check><br />
}}<br />
<br />
{{XML entry<br />
| name = model_checks<br />
| info = Contains all model checks<br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]]<br />
| used_by = <br />
| example = <br />
<declare_dialogs><br />
<declare_dialog><br />
...<br />
< table ><br />
<column text="A"><br />
<edit_box unique_name="colA"><br />
</edit_box><br />
</column><br />
…// other columns also defined<br />
< /table ><br />
...<br />
<declare_dialog><br />
<declare_dialogs><br />
<model_checks><br />
<model_check problem_text = "Column D or E is required." <br />
description_text = "This model requires column D."<br />
fix_text = "To fix do the following: …... "><br />
<condition>( (colA EQUALS 0.0 OR colB EQUALS 0.0) AND NOT(colD EQUALS 0.0 OR colE EQUALS 0.0))</condition><br />
</model_check><br />
<model_checks><br />
}}<br />
<br />
{{XML entry<br />
| name = new_line<br />
| info = Creates a new line before adding the next widget in a tree item. <br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]]<br />
| example = In the dialog there would be:<br />
Breaking Efficency: [edit box] (new_line called)<br />
Friction Efficency:<br />
<br />
<item><br />
<text>Non-cohesive bedload entrainment</text><br />
<text_box><br />
<text>Breaking Efficency:</text><br />
</text_box><br />
<edit_box unique_name="edtBreakingEff"><br />
</edit_box><br />
<new_line></new_line><br />
<text_box text="Friction Efficency:"><br />
</text_box><br />
}}<br />
<br />
{{XML entry<br />
| name = option<br />
| info = Widget that displays list of options. Only 1 can be selected.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unit_keyword>|unit_keyword]], <br />
display_options_hide<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], any element that starts with "custom_control" and has units<br />
| example = Creates a combo box with hours, minutes and seconds. Minutes is the default item.<br />
<combo_box unique_name="cbxTransportUnits"> <br />
<option text="hours"><br />
</option><br />
<option text="minutes" <br />
default><br />
</option><br />
<option text="seconds"><br />
</option><br />
<dependency>…</dependency>…<br />
</ combo_box ><br />
}}<br />
<br />
{{XML entry<br />
| name = output_file<br />
| info = Defines a file to be created by the executable.<br />
| version = 1<br />
| attributes = none<br />
| children = use_file_def, [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <export_table>|export_table]], [[SMS:Dynamic Model Interface Schema#Element <export_each_coverage>|export_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <export_each_material>|export_each_material]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]<br />
| example = See executable example.<br />
}}<br />
<br />
{{XML entry<br />
| name = output_files<br />
| info = A container to place all of the output files into for a simulation. <br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]]<br />
| example = See executable example.<br />
}}<br />
<br />
===Elements P - S===<br />
{{XML entry<br />
| name = page_def<br />
| info = This defines the page or tab of a dialog. If there is only one page_def in a dialog, then no tabs will appear. <br />
| version = 2 (depreciated use <delcare_page>)<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <display>|display]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <contains>|contains]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dialog>|dialog]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = point_att<br />
| info = Used to specify what attributes should be used for the points of a coverage. <br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <coverage>|coverage]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = polygon_att<br />
| info = Used to specify what attributes should be used for the polygon of a coverage. <br />
| version = 2<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <coverage>|coverage]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_arc<br />
| info = Indicator to loop through each arc in the given context. <br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute ''<source''>|source]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_coverage<br />
| info = Indicator to loop through each coverage in the given context.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], <br />
source<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <process_each_set>|process_each_set]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <cprocess_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], count_range, [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_material<br />
| info = Indicator to loop through each material in the given context.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], <br />
source<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], count_range, [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_neighbor<br />
| info = Indicator to loop through each neighbor in the given context.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <corner_skip>|corner_skip]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <feature>|feature]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]],<br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <interior_polygon>|interior_polygon]],<br />
[[SMS:Dynamic Model Interface Schema#Attribute <null_id>|null_id]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <neighbor_per_edge>|neighbor_per_edge]],<br />
source<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_point<br />
| info = Indicator to loop through each point in the given context.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], <br />
source, <br />
[[SMS:Dynamic Model Interface Schema#Attribute <dataset_widget>|dataset_widget]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_ neighbor]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_polygon<br />
| info = Indicator to loop through each polygon in the given context. <br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], <br />
source<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_each_row<br />
| info = Indicator to loop through each row in a table. Has the widget attribute that must be used. The widget attribute needs to be set to the name of a widget which belongs to the table to be iterated through. To iterate through the rows of a curve widget, use the name of the curve widget and a keyword, such as "#x".<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], <br />
widget, <br />
[[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]]<br />
| example = <br />
<process_each_row widget = "someColumnWidget"><br />
}}<br />
<br />
{{XML entry<br />
| name = process_on_condition<br />
| info = Indicator to perform a certain action only if the condition is satisfied.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_geometry>|process_each_geometry]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_formt>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]], [[SMS:Dynamic Model Interface Schema#Element <use_file_def>|use_file_def]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]], [[SMS:Dynamic Model Interface Schema#Element <process_on_count>|process_on_count]], [[SMS:Dynamic Model Interface Schema#Element <process_model>|process_model]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = process_on_count<br />
| info = Indicator to perform a certain action only on certain iterations of a loop.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_geometry>|process_each_geometry]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <count_filter>|count_filter]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = push_button<br />
| info = The button to be used for a control_dataset. Can be SELECT, CREATE, or DELETE. <br />
| version = 1, 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
| example = See control_dataset example.<br />
}}<br />
<br />
{{XML entry<br />
| name = range<br />
| info = Determines the range of acceptable values in an [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]]. Can use the keywords GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN and LESS_THAN_EQUALS. Numbers assumed inclusive unless otherwise specified.<br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], any element that starts with "control" except: control_file_selector, control_dataset and control_date<br />
| example = '''Example 1'''<br />
<edit_box> <br />
<range>0-1</range><br />
</ edit_box ><br />
<br />
'''Example 2'''<br />
<range>0 – 5.6546</range><br />
<br />
'''Example 3'''<br />
<range>GREATER_THAN 0</range><br />
<br />
'''Example 4'''<br />
<range>GREATER_THAN 0.0 - LESS_THAN 5.0</range><br />
<br />
'''Example 5'''<br />
Both examples are equivalent<br />
<range>0.0 - LESS_THAN 5.0</range><br />
<range>GREATER_THAN_EQUALS 0.0 - LESS_THAN 5.0</range><br />
}}<br />
<br />
{{XML entry<br />
| name = required<br />
| info = Used to indicate that something from the exported group must be used. <br />
| version = 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = role<br />
| info = A single entry in a combo box option for <roles>. Used to define the displayed text and range. The range specifies how many objects that can have this role. <br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], [[SMS:Dynamic Model Interface Schema#Attribute <range>|range]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <roles>|roles]]<br />
| example = Example of a culvert widget with a extra "Name" column <br />
<control_set unique_name="tblSetCulverts"><br />
<roles behavior = "SWAP"><br />
<role text="upper"><br />
<range>1-1</range><br />
</role><br />
<role text="lower"><br />
<range>1-1</range> <br />
</role><br />
</roles><br />
<column text = "Name"><br />
<edit_box unique_name="edtMyArcsName"<br />
type="text"><br />
</edit_box><br />
</column><br />
</control_set><br />
}}<br />
<br />
{{XML entry<br />
| name = roles<br />
| info = Defines the behavior of each role.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <behavior>|behavior]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <role>|role]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]]<br />
| example = Example of a culvert widget with a extra "Name" column <br />
<control_set unique_name="tblSetCulverts"><br />
<roles behavior = "SWAP"><br />
<role text="upper"><br />
<range>EQUALS 1</range><br />
</role><br />
<role text = "lower"><br />
<range>EQUALS 1</range> <br />
</role><br />
</roles><br />
<column text="Name"><br />
<edit_box unique_name="edtMyArcsName"<br />
type="text"><br />
</edit_box><br />
</column><br />
</control_set><br />
}}<br />
<br />
{{XML entry<br />
| name = row<br />
| info = Typically you would only use row if you had a fixed table and wanted to display row text or to specify specific rows as read only. Row tags are placed inside a [[SMS:Dynamic Model Interface Schema#Element < table >|< table >]]. <br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <read_only>|read_only]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <optional>|optional]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element < table >|table]]<br />
| example = Row 1 is read only, row 2 isn’t<br />
<br />
< table ><br />
…<br />
<row text = "Row1" read_only></row><br />
<row text = "Row2"></row><br />
< /table ><br />
}}<br />
<br />
{{XML entry<br />
| name = separator<br />
| info = Determines how to separate text that is being exported into a text file.<br />
| version = 1<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element<export_each_row>|export_each_row]]<br />
| example = See [[SMS:Dynamic Model Interface Schema#Element<export_table>|<export_table>]]<br />
}}<br />
<br />
{{XML entry<br />
| name = simulation<br />
| info = The simulation object that represents what will run and be exported upon launching a model. There can only be one per model.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_icon>|use_icon]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <takes>|takes]], [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <input_files>|input_files]], [[SMS:Dynamic Model Interface Schema#Element <output_files>|output_files]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]]<br />
| example = See the model example.<br />
}}<br />
<br />
{{XML entry<br />
| name = snap<br />
| info = Snaps the arc, point or polygon in a coverage to the underlying geometry (mesh, grid, etc) that is defined by the [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|<declare_coverage>]] bind_to attribute <br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <snap_exterior>|snap_exterior]], [[SMS:Dynamic Model Interface Schema#Element <snap_extrior>|snap_interior]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <arc_att>|arc_att]], [[SMS:Dynamic Model Interface Schema#Element <point_att>|point_att]], [[SMS:Dynamic Model Interface Schema#Element <polygon_att>|polygon_att]]<br />
| example = Snaps an arc boundary condition to the interior of the mesh when the arc type is Monitor Line and to the exterior when the arc is a Inlet-Q.<br />
<br />
<declare_coverage name= "Boudary Conditions" bind to ="MESH2D"><br />
<arc_att><br />
<menu_item double_click = "true" text = "Assign Linear BC"<br />
link_to = "Linear BC" </menu_item><br />
<snap><br />
<snap_exterior><br />
<condition>cbxLineType EQUALS "Inlet-Q"<br />
</condition><br />
</snap_exterior><br />
<snap_interior><br />
<condition>cbxLineType EQUALS "Monitor-Line" </condition><br />
</snap_interior> <br />
</snap><br />
</arc_att><br />
</coverage><br />
}}<br />
<br />
{{XML entry<br />
| name = snap_exterior<br />
| info = Snaps the arc, point or polygon in a coverage to the closest exterior point, arc, or polygon of the underlying geometry.<br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]]<br />
| example = See <snap><br />
}}<br />
<br />
{{XML entry<br />
| name = snap_interior<br />
| info = Snaps the arc, point or polygon in a coverage to the closest interior point, arc, or polygon of the underlying geometry.<br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]]<br />
| example = See <snap>.<br />
}}<br />
<br />
===Elements T - Z===<br />
{{XML entry<br />
| name = table<br />
| info = Table widget with columns and rows. Will most likely have multiple column and row tags (version 3). Using the attribute fixed_row_count means that the user can’t add or delete rows. Not using the fixed_row_count , an insert and delete button will be included at the bottom of the table.<br />
| version = 1<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <read_only>|read_only]], <br />
[[SMS:Dynamic Model Interface Schema#Attribute <fixed_row_count>|fixed_row_count]] (version 3), <br />
[[SMS:Dynamic Model Interface Schema#Attribute <max_row_count>|max_row_count]] (version3), <br />
[[SMS:Dynamic Model Interface Schema#Attribute <min_row_count>|min_row_count]] (version 3), <br />
[[SMS:Dynamic Model Interface Schema#Attribute <min_height>|min_height]] (version3), <br />
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]]<br />
| example = (version 3) Read only table with 2 columns and 3 rows. The number of rows are fixed.<br />
< table unique_name = "myTable" <br />
read_only<br />
fixed_row_count="3"><br />
<column text = "hours"</column><br />
<column text = "minutes"</column><br />
</ table ><br />
}}<br />
<br />
{{XML entry<br />
| name = take_coverage<br />
| info = Represents a coverage that can be taken in the project explorer.<br />
| version = 2<br />
| attributes = limit<br />
| children = declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]], [[SMS:Dynamic Model Interface Schema#Element <use_coverage>|use_coverage]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], attribute_set(version 3)<br />
| example = See takes example.<br />
}}<br />
<br />
{{XML entry<br />
| name = take_mesh2d<br />
| info = Represents a coverage that can be taken in the project explorer.<br />
| version = 2<br />
| attributes = limit, linear<br />
| children = declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], attribute_set(version 3)<br />
| example = See takes example.<br />
}}<br />
<br />
{{XML entry<br />
| name = takes<br />
| info = Represents what can be dragged under another object in the project explorer. <br />
| version = 2<br />
| attributes = none<br />
| children = declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <take_coverage>|take_coverage]], [[SMS:Dynamic Model Interface Schema#Element <take_mesh2d>|take_mesh2d]], take_grid2d<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], attribute_set(version 3)<br />
| example = '''Example 1''' This example shows a simulation that can take a coverage and a 2D mesh which uses linear elements.<br />
<takes><br />
<take_coverage limit = "1"><br />
<use_coverage>My Cov</use_coverage><br />
<condition>""</condition><br />
</take_coverage><br />
<take_mesh2d limit = "1" linear = "true"><br />
<condition>""</condition><br />
</take_mesh2d><br />
<declare_parameter>meshCov</declare_parameter><br />
</takes><br />
<br />
'''Example 2'''<br />
This example shows taking one type of coverage OR another type of coverage.<br />
<takes><br />
<take_coverage limit = "1"><br />
<use_coverage>My Cov</use_coverage><br />
<use_coverage>My Other Cov</use_coverage><br />
<condition>""</condition><br />
</take_coverage><br />
<declare_parameter>monitorCov</declare_parameter><br />
</takes><br />
}}<br />
<br />
{{XML entry<br />
| name = text_box<br />
| info = Widget that displays text that is not editable. <br />
| version = 1<br />
| attributes = alignH, alignV, text, unique_name<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]<br />
| example = <br />
<text_box unique_name = "edtD50Units" alignH= "CENTER" <br />
text = "mm"><br />
</text_box><br />
}}<br />
<br />
{{XML entry<br />
| name = text_size<br />
| info = Sets the point size of the text. Ranges from 8 to 20. Added in SMS 11.2. <br />
| version = 1, 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
| example = This would set the size of the text to 20pt. when the value in the [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]] is less than 0.0.<br />
<edit_box><br />
<unique_name>edtA</unique_name><br />
<default>1.0</default><br />
<text_style><br />
<text_size>20</text_size><br />
<condition>edtA LESS_THAN 0.0</condition><br />
<text_style><br />
</edit_box><br />
}}<br />
<br />
{{XML entry<br />
| name = text_style<br />
| info = Holds the style options for the text. Added in SMS 11.2.<br />
| version = 1<br />
| attributes = bold, italic, strike_through, text_size, underline<br />
| children = color, condition<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <options>|options]]<br />
| example = This would bold the text when the value in the edit_box is less than 0.0.<br />
<edit_box><br />
<unique_name>edtA</unique_name><br />
<default>1.0</default><br />
<text_style bold text_size="12"><br />
<condition>edtA LESS_THAN 0.0</condition><br />
<text_style><br />
</edit_box><br />
}}<br />
<br />
{{XML entry<br />
| name = title_format<br />
| info = This indicates what the title of an object in an h5 file is. Uses the standard printf and sprintf format ([www.cplusplus.com/reference/clibrary/cstdio/printf/ www.cplusplus.com/reference/clibrary/cstdio/printf/]). Works the same as [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]].<br />
| version = 3<br />
| attributes = none<br />
| children = none<br />
| used_by = h5_group, h5_geometry, h5_dataset, h5_data<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = unique_link_name<br />
| info = A unique name given to a link when using link_to_xml. This is needed to identify the unique_name elements from the file, especially when a linked to XML file is used multiple times. Hence, when using link_to_xml, this tag is required. No spaces or punctuation are allowed in the name. <br />
| version = 1, 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <link_to_xml>|link_to_xml]]<br />
| example = See link_to_xml example.<br />
}}<br />
<br />
{{XML entry<br />
| name = update_text<br />
| info = Used to match the output text from a model to determine the progress amount.<br />
| version = 3<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable_progress_update>|executable_progress_update]]<br />
| example = Lets say our model outputs "CASE 1 of 35" then "CASE 2 of 35" etc.. <br />
<br />
<executable name="My Model Main"</executable><br />
<executable_progress_update amount="0" max ="35"><br />
<update_text>"CASE %d of %d" #progress_amount, #progress_max <br />
</update_text><br />
</executable_progress_update> <br />
</executable> <br />
}}<br />
<br />
{{XML entry<br />
| name = use_coverage<br />
| info = Use a coverage that has previously been defined in the attribute type in <declare_coverage><br />
| version = 2<br />
| attributes = none<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <take_coverage>|take_coverage]]<br />
| example = See the coverage example and the takes example.<br />
}}<br />
<br />
{{XML entry<br />
| name = use_file_def<br />
| info = A way to access file data that has been previously declared with <declare_file_def>.<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <coontrol_file>|control_file]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]], [[SMS:Dynamic Model Interface Schema#Element <input_file>|input_file]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <file>|file]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = use_parameter<br />
| info = A way to access file data that has been previously declared with <declare_parameter>.<br />
| version = 3<br />
| attributes = none<br />
| children = none<br />
| used_by = anything beginning with "process_each", [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = x_column<br />
| info = Used to define the attributes in the x column such as text (heading).<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]]<br />
| example = This example creates a curve button with the date/time flag.<br />
<item><br />
<control_curve><br />
<unique_name>myCurve1</unique_name><br />
<max_rows>10</max_rows><br />
<x_column><br />
<text>Time</time><br />
</x_column><br />
<y_column><br />
<text>Velocity</text> <br />
</y_column> <br />
</control_curve><br />
…<br />
}}<br />
<br />
{{XML entry<br />
| name = xmdf_data<br />
| info = Writes data to the XMDF file. The attributes rows, columns and layers indicate what information should be written for each row, column or layer respectively. By default, the attributes are set to "#specified". If no attributes are set then each export_format will be assumed to be a new row. The attribute columns can only be set if the rows attribute is set. The attribute layers can only be set if both the rows attribute and the columns attribute is set. The datatype attribute can be set to "float", "double", "integer", or "text". If the datatype attribute is not set or is set to "text" then export_format can be used. Otherwise, only export can be used. If more than 1 dimension is used, then the datatype cannot be "text". If 3 dimensions are used, then the datatype cannot be "integer". <br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <datatype>|datatype]]<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], [[SMS:Dynamic Model Interface Schema#Element <export>|export]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], file_def, and anything beginning with "process_each".<br />
| example = This writes out 6 different widgets’ values, one on each row.<br />
<xmdf_data datatype = "text"><br />
<export_format>"%s", widget1</export_format><br />
<export_format>"%s", widget2</export_format><br />
<export_format>"%s", widget3</export_format><br />
<export_format>"%s", widget4</export_format><br />
<export_format>"%s", widget5</export_format><br />
<export_format>"%s", widget6</export_format><br />
</xmdf_data><br />
<br />
This writes out a table with each row being a different timestep and each column a different point. Each export would be written to different layers.<br />
<xmdf_data rows = "#timestep" columns = "#point" datatype = "double"><br />
<export>#component1</export><br />
<export>#component2</export><br />
</xmdf_data><br />
}}<br />
<br />
{{XML entry<br />
| name = xmdf_dataset<br />
| info = Writes out all of the data of a dataset in an SMS friendly format to an xmdf file. The attribute null_value is optional. If used, it specifies a numeric value that will be treated by the model as inactive. By default, SMS will write an activity array. The attribute location specifies where data should be taken from. The attribute widget specifies to only write the dataset referenced by the named widget. If no title_format is used, then the name of the dataset will be used.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <null_value>|null_value]],<br />
[[SMS:Dynamic Model Interface Schema#Attribute <location>|location]],<br />
widget<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]]<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]].<br />
| example = This writes out the hardbottom dataset as specified by the widget edtHardBottomWidget that exists in some dialog. Any value that is inactive is written as -999.0.<br />
<xmdf_dataset widget = "edtHardBottomWidget" location = "all" null_value = "-999.0"><br />
<title_format>"Hardbottom"</title_format><br />
</xmdf_dataset><br />
}}<br />
<br />
{{XML entry<br />
| name = xmdf_dimension<br />
| info = <br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <dimension>|dimension]]<br />
| children = <br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]]<br />
| example = '''Example 1:''' The following shows how to write out the text rows of a single column of a table into a single column XMDF dataset.<br />
<xmdf_group><br />
<title_format>"Test"</title_format><br />
<xmdf_data><br />
<title_format>"Table"</title_format><br />
<process_each_row widget="myColumn1"><br />
<xmdf_dimension dimension="rows"><br />
<export_format>"%s", myColumn1</export_format><br />
</xmdf_dimension><br />
</process_each_row><br />
</xmdf_data><br />
</xmdf_group><br />
'''Example 2:''' The following shows how to write out two columns of a table into two columns of single XMDF dataset. It should be noted that multi-column XMDF datasets may not be text.<br />
<xmdf_group><br />
<title_format>"Test"</title_format><br />
<xmdf_data datatype="double"><br />
<title_format>"Table"</title_format><br />
<process_each_row widget="myColumn1"><br />
<xmdf_dimension dimension="rows"><br />
<xmdf_dimension dimension="columns"><br />
<export>myColumn1</export><br />
</xmdf_dimension><br />
<xmdf_dimension dimension="columns"><br />
<export>myColumn2</export><br />
</xmdf_dimension><br />
</xmdf_dimension><br />
</process_each_row><br />
</xmdf_data><br />
</xmdf_group><br />
}}<br />
<br />
{{XML entry<br />
| name = xmdf_geometry<br />
| info = Writes a geometric object in an SMS friendly format to an XMDF file. Different geometric types will be written differently from each other. If no title_format is used, then the name of the geometry will be used.<br />
| version = 3<br />
| attributes = none<br />
| children = [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]]<br />
| used_by = file_def, [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]]<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = xmdf_group<br />
| info = Writes an XMDF group to the xmdf file. A title_format must be used. The group_type attribute must be used.<br />
| version = 3<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <group_type>|group_type]]<br />
| children = xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], and anything beginning with "process_each".<br />
| used_by = file_def, xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], and anything beginning with "process_each".<br />
| example = <br />
}}<br />
<br />
{{XML entry<br />
| name = y_column<br />
| info = Used to define the attributes in the y column such as text (heading).<br />
| version = 2<br />
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]]<br />
| children = none<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]]<br />
| example = See example in x_column<br />
}}<br />
<br />
==Attributes==<br />
===Attributes A-C===<br />
{{XML attributes<br />
| name = alignH<br />
| info = Align text horizontally in a text box. <br />
| values = bottom, top, center<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = alignV<br />
| info = Align text vertically in a text box. <br />
| values = bottom, top, center<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = amount<br />
| info = <br />
| values = integer<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <execute_progress_update>|execute_progress_update]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = behavior<br />
| info = When a user changes a role, you can define behaviors that automatically update the roles.<br />
| values = ''None'': no enforcement of rules in the dialog<br />
<br />
''Swap'': all assigned up front. When some object is being assigned a role and is there are already a max number of objects assigned to the role, then any objects that had that role will be switched to the old role of the object being asgined until we surpass the maximum amount of that role, then unassigned.<br />
<br />
''Max_hide'': Don’t allow the role to show up in the combo box to be assigned to a "object" if the max has been reached for that role.<br />
<br />
''Swap_max_default'': (not implemented yet) Enforce max with default is like swap, but instead of the old option, it changes it to the default or unassigned (if no default provided) value. Chooses the first or last "object" of the role it encounters to change.<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <roles>|roles]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = bind_to<br />
| info = Binds a coverage to a mesh, or grid<br />
| values = MESH2D, CGRID<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = blue<br />
| info = A color. Ranges from 0 to 255. Added in SMS 11.2. See also green and red.<br />
| values = integer (0 to 255)<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <color>|color]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = bold<br />
| info = Sets the text to be bolded when this attribute is used. Added in SMS 11.2.<br />
| values = none<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = columns<br />
| info = Represents a column in the H5 file that we are mapping to<br />
| values = #timestep, #point, #arc, #polygon, #coverage, #material<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = corner_skip<br />
| info = Skip corners when exporting neighbors<br />
| values = true, false<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = create_file<br />
| info = If attribute is specified, then create_file is true<br />
| values = none<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_file_selector>|control_file_selector]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = dataset_type<br />
| info = Specify the dataset type as scalar or vector. Default is scalar.<br />
| values = scalar, vector<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = dataset_widget<br />
| info = When exporting points from a dataset, the attribute identifies the dataset widget being used (contains the selected dataset).<br />
| values = Name of the dataset_widget<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = datatype<br />
| info = <br />
| values = float, double, integer, text<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = default<br />
| info = Sets the initial default value of a widget. Can also be used to state the default combo-box option.<br />
| values = <br />
''edit_box'' or any element that begins with ''custom_control'': double<br/><br />
''check_box'': checked, unchecked<br/><br />
''combo_box'': no values or empty string<br/><br />
''export_optional'': true, false<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <option>|option]], any element that begins with "control" ("custom_control" in version 1), [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = default_executable_name32<br />
| info = Sets the initial default file name for the 32-bit executable.<br />
| values = text<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = default_executable_name64<br />
| info = Sets the initial default file name for the 64-bit executable.<br />
| values = text<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = description_text<br />
| info = A detailed description of why a model check failed. This text is displayed to the user.<br />
| values = string<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = dim<br />
| info = Specifies that when the dependency is false, the widget should be dimmed, not hidden.<br />
| values = none<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = dimension<br />
| info = Specifies values for rows, columns and layers.<br />
| values = rows, columns, layers<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_dimension>|xmdf_dimension]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = display<br />
| info = This is used to describe how the dialog should display. <br />
<br />
''flex'' is the default. In this mode, there is a tree on the left hand side of the dialog. Clicking on an item in the tree will display that portion of the tree along with any child items below the clicked item. Other items will be hidden on the right hand side.<br />
<br />
''full'' will show a tree on the left hand side of the dialog. Clicking on an item in the tree will move the scroll bars on the right hand side to make the item visible. All items that are not disabled due to dependencies are shown on the right hand side of the dialog in this mode.<br />
<br />
''no_nav'' will have no left hand side tree. Instead, all items that are not disabled due to dependencies are shown in this mode. Added in SMS 11.2.<br />
| values = flex, full, no_nav<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = display_options_hide<br />
| info = Don’t show a specific combo-box option in the display option dialog of SMS. This only applies to <combo_box> ‘s that have included the <display_options> element. Default value is false.<br />
| values = true, false<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <option>|option]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = double_click<br />
| info = The double_click attribute (if true) indicates that this is the menu item to be launched on a double click event.<br />
| values = true, false<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]]<br />
}}<br />
<br />
===Attributes E-L===<br />
{{XML attributes<br />
| name = executable_order<br />
| info = Defines the order in which this executable should run relative to other executables in the same simulation.<br />
| values = integer ≥ 1<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = feature<br />
| info = Determine whether to select points, arcs or polygons (poly).<br />
| values = point, arc, poly<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_feature_selector>|control_feature_selector]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = fix_text<br />
| info = A brief summary of what steps to take to fix a model check failure. This text is displayed to the user.<br />
| values = string<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = file_type<br />
| info = Specifies a file type of <declare_file_def> defines the file type.<br />
| values = CARD_ASCII, SEQUENTIAL_ASCII, SEQUENTIAL_BINARY, XMDF<br />
| versions = 2<br />
| used_by = declare_file_def, [[SMS:Dynamic Model Interface Schema#Element <section>|section]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = filter<br />
| info = When selecting a file, used to filter the available files by the extension type. The filter tag contains two parts. The first part is the text describing the filter that gets displayed to the user. The second part is a pair of parentheses that contains the actual filter. For example: Cmcards file (.cmcards)<br />
| values = string (string)<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_file_selector>|control_file_selector]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = flags<br />
| info = Flags are optional, and are used to modify the behavior/appearance of the control_curve. Only 1 flag is currently defined: XY_USEDATE. When this flag is set, the x column becomes a date/time calendar.<br />
| values = XY_USEDATE<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = footer<br />
| info = Exported text inside a table that is placed at the end.<br />
| values = string <br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_table>|export_table]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = geometry<br />
| info = The default behavior is to only allow geometric objects that are contained under a simulation to be a candidate for selection. Otherwise "all" geometries are candidates.<br />
| values = all<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = green<br />
| info = A color. Ranges from 0 to 255. Added in SMS 11.2. See also blue and red.<br />
| values = integer (0 to 255)<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <color>|color]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = header<br />
| info = Exported text inside a table that is placed at the beginning.<br />
| values = string <br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_table>|export_table]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = help_button_url<br />
| info = Provides online help when the help button is clicked. Loads the specified url in a web browser. Example: help_button_url="www.aquaveo.com"<br />
| values = string<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = help_button_wiki<br />
| info = Provides online help when the help button is clicked. Loads the specified url in a web browser. Example: help_button_wiki="DynSrhModelControl"<br />
| values = string <br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = increment<br />
| info = An increment values. Used Increment from the min time to the max time, using the increment.<br />
| values = Integer ≥ 1<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = interior_polygon<br />
| info = Only used for polygons when finding neighbors. Specify the polygon preference.<br />
| values = interior_first, exterior_first, interior_only, exterior_only<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = italic<br />
| info = Sets the text to be italicized when the element is specified. Added in SMS 11.2.<br />
| values = none<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = i_order<br />
| info = Start at min i and go to max. Only used by cartesian grids and process_each_neighbor on quad trees.<br />
| values = ascending, descending<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = j_order<br />
| info = Start at min j and go to max. Only used by cartesian grids and process_each_neighbor on quad trees.<br />
| values = ascending, descending<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = layers<br />
| info = Represents a layer in the H5 file to which we are mapping.<br />
| values = #timestep, #point, #arc, #polygon, #coverage, #material<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = location<br />
| info = The location from which we will be getting dataset values.<br />
| values = TBD<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]]<br />
}}<br />
<br />
===Attributes M-S===<br />
{{XML attributes<br />
| name = max<br />
| info = A max value. The default is 2.147 billion.<br />
| values = Integer ≥ 1<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]], [[SMS:Dynamic Model Interface Schema#Element <execute_progress_update>|execute_progress_update]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = max_row_count<br />
| info = Used to set the maximum number of rows allowed in a table or curve.<br />
| values = integer<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element < table >|table]], [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = min<br />
| info = A minimum value. The default is 0 (zero).<br />
| values = Integer ≥ 1<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = model<br />
| info = Specify the model name of the executable<br />
| values = string<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_executable>|control_executable]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = name<br />
| info = Specify a name. When used by dialog this is required.<br />
| values = string<br />
| versions = 3<br />
| used_by = declare_file_def, [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]], [[SMS:Dynamic Model Interface Schema#Element <model>|model]], [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverag>|declare_coverage]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = neighbor_per_edge<br />
| info = Minimum number of neighbors in any direction. The default value is 0 (zero).<br />
| values = integer<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = null_id<br />
| info = Integer for an id of a neighbor not found<br />
| values = integer<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = null_value<br />
| info = The null_value for the dataset.<br />
| values = any integer, any double<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = optional<br />
| info = Placed inside widgets to suppress a warning message from being displayed if the widgets data is empty. By default, data associated with a widget is required. If the <optional> tag is included and the widget’s data is empty, a warning message won’t be displayed.<br />
| values = none<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], any element that starts with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = order<br />
| info = The way spatial entity objects are to be sorted before iterating. Currently only available for Cartesian grids and quadtrees (process_each_neighbor).<br />
| values = clockwise, counter_clockwise, ij, ji<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = problem_text<br />
| info = A brief summary of why a model check failed. This text is displayed to the user.<br />
| values = string<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = red<br />
| info = A color. Ranges from 0 to 255. Added in SMS 11.2. See also blue and green.<br />
| values = integer (0 to 255)<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <color>|color]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = required<br />
| info = Specifies that at least one option in the group must be present.<br />
| values = true<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = rows<br />
| info = Represents a row in the .h5 file to map to<br />
| values = #timestep, #point, #arc, #polygon, #coverage, #material<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = select_time<br />
| info = <br />
| values = single, #range, #all<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = source<br />
| info = When exporting things such as point or arc locations, the source identifies the desired location such as on the coverage or on the geometry (grid, mesh)<br />
| values = coverage (use locations from coverage), snapped (use the snapped location on a geometry from a coverage), geometry (use locations from geometry)<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = strike_through<br />
| info = Sets the text to have a line through the middle when the element is specified. Added in SMS 11.2.<br />
| values = none<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
}}<br />
<br />
===Attributes T-Z===<br />
{{XML attributes<br />
| name = text<br />
| info = Text that is displayed in the SMS user interface.<br />
| values = any text string<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <x_column>|x_column]], [[SMS:Dynamic Model Interface Schema#Element <y_column>|y_column]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]], [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = type<br />
| info = For <display_options> defines point, or arc<br />
| values = ''display_options'': arc, point<br/><br />
''edit_box'': text, integer, double<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = time_type<br />
| info = Type of time either transient, steady state, or all. Default is all.<br />
| values = transient, steady state, all<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = underline<br />
| info = Sets the text to be underlined when this attribute is specified. Added in SMS 11.2.<br />
| values = none<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = unique_name<br />
| info = A unique name given to an widget, which determines how to reference the widget. This is needed if the widget is being used as a dependency (parent), or if the widget value is being exported. When a unique_name is being referenced it should be by the file (nothing if current file), then unique_name. No spaces or punctuation (except _) are allowed in the name. The name must contain at least 1 non-numeric letter. The name must be unique. Names are not case sensitive, hence "aaa" is the same as "AAA".<br />
| values = string (unique)<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], all elements starting with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = unit_keyword<br />
| info = The units of a widget that begins with "control_" (where applicable). This provides a mapping for SMS to know the unit type.<br />
| values = <br />
Length:<br />
* #LEN_KM (kilometers)<br />
* #LEN_M (meters)<br />
* #LEN_FT (feet)<br />
* #LEN_CM (cm)<br />
* #LEN_MM (mm)<br />
* #LEN_INCH (inch)<br />
* #LEN_YD (yd)<br />
* #LEN_MILE (mile)<br />
* #LEN_UM (um)<br />
<br />
Time:<br />
* #TIME_SECONDS<br />
* #TIME_HOURS<br />
* #TIME_MINUTES<br />
* #TIME_DAYS<br />
* #TIME_WEEKS<br />
<br />
Volume:<br />
* #VFLOW_CU_FT_PER_SEC<br />
* #VFLOW_CU_M_PER_SEC<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <option>|option]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = use_dialog<br />
| info = Determines which dialog definition we are linking to<br />
| values = string<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <material_att>|material_att]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = use_file<br />
| info = Complex command arguments can be built by referencing a <declare_file>.<br />
| values = string = a <declare_filename ><br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <command_args>|command_args]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = use_icon<br />
| info = Allows for a custom icon to be imported into sms for coverages and simulations. When a coverage or simulation is create the custom icon will be shown instead of the default one in the tree structure. The icon must be given to Aquaveo in advance. The icon dimensions are 16x16 pixels.<br />
| values = string = (icon_name.bmp)<br />
| versions = 3<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = version<br />
| info = Sets the version number<br />
| values = integer<br />
| versions = 1<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]], [[SMS:Dynamic Model Interface Schema#Element <dynamic_model>|dynamic_model]]<br />
}}<br />
<br />
{{XML attributes<br />
| name = z_is_elev<br />
| info = If the z value is elevation, set this to true. Default is false.<br />
| values = true, false<br />
| versions = 2<br />
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]]<br />
}}<br />
<br />
==Converting to the Dynamic Model Interface==<br />
The Dynamic Model Interface offers more flexibility to model developers than the Generic Model Interface which was used before. Generic Model Interface files can be converted into files for the Dynamic Model Interface. [http://www.aquaveo.com/contact-us Contact Aquaveo] for more information.<br />
<br />
==Tutorial Links==<br />
For more information on using the Dynamic Model Interface, download the XML file tutorial:<br />
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMI_XML_File.pdf DMI XML File Tutorial]<br />
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DynamicSample.zip DMI Tutorial Data] <!--The Dynamic Model Dataset DMI Tutorial Data download does not include the DMITemplate.XML file needed for the tutorial--><br />
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISamplePreProc.exe DMI Sample Pre-Processing Executable]<br />
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISample.exe DMI Sample Executable]<br />
<br />
<br />
{{Navbox SMS}}<br />
<br />
[[Category:Dynamic Model Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:RiverFlow2D&diff=100069SMS:RiverFlow2D2016-02-11T17:22:49Z<p>Morelandtom: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= RiverFlow2D<br />
|model_type= 2D current and sediment transport simulation.<br />
|developer= Dr. Reinaldo Garcia<br />
|web_site= [http://hydronia.net/computer-models-software hydronia.net]<br />
|tutorials= <br />
General Section<br />
* Data Visualization<br />
* Mesh Editing<br />
* Observation<br />
}}<br />
<br />
RiverFlow2D is a hydrodynamic, mobile bed model for rivers and estuaries that uses a stable and powerful finite element method to compute high resolution flood hydraulics, including supercritical and subcritical flows over dry or wet river beds. Use of flexible triangular mesh allows resolving the flow field, sediment transport and bed elevation changes around key features in complex river environments. RiverFlow2D has been applied on numerous river projects worldwide including large rivers in the United States, South America, Europe and Asia.<br />
<br />
==Functionality==<br />
Features<br />
*Flexible triangular finite element meshes<br />
*Mesh refinement to resolve complex river features<br />
*Supercritical and subcritical flow<br />
*Steady and time-dependent flow<br />
*Mobile-bed sediment transport<br />
*Numerically stable explicit solution scheme<br />
*Dry-wet bed capability not requiring initially wet elements<br />
*Parallelized code for multiple-core processor computers<br />
*Documented input ASCII, free format files<br />
*Comprehensive ASCII output files<br />
*Graphical output in a variety of formats<br />
<br />
==Using the Model / Practical Notes==<br />
<br />
The RiverFlow2D installation package includes several executable files. To connect SMS to the numeric engine:<br />
# Select the '''Preferences''' command from the ''Edit'' menu<br />
# Click on the ''File Locations'' tab in the [[SMS:Preferences| ''Preferences'']] dialog<br />
# In the ''Model Executables'' area, scroll down to the ''Generic'' line and click on the button on the right side. A dialog to select the executable will appear.<br />
# Browse to the RiverFlow2D program folder and select the RiverFlow2D program.<br />
# Click the '''Open''' button to select the file and the '''OK''' button to close the ''preferences'' dialog.<br />
<br />
==RiverFlow2D Components==<br />
In RiverFlow2D there are different supported components that can be specified by selecting the nodestring or element and assigning a Component or Boundary Condition to them. These options are not used is this tutorial but are available for other simulations. Here is an overview of the different options:<br />
<br />
====Nodestring====<br />
*'''''Exterior Boundary Condition''''': Allows users to specify one of the supported exterior boundary conditions. See the RiverFlow2D manual for more details for the different boundary condition types. This is normally done through the model but can be assigned directly to a nodestring.<br />
*'''''Interior Boundary Condition''''': Allows users to specify a stage-discharge rating table along an internal line in the model. More details are in the RiverFlow2D documentation<br />
*'''''Weir''''': A weir may be defined across a nodestring to have RiverFlow2D use the weir equation to calculate the flow from the upstream elements to the downstream.<br />
<br />
====Element====<br />
*'''''Pier''''': Pier locations at the centroid of the element may be specified and RiverFlow2D will simulate them using the drag equation. Users may also simulate a pier by representing it with a polygon and turning the meshing option off in the polygon attributes in the model.<br />
*'''''Source/Sink''''': The user may provide a hydrograph to simulate a point inflow or outflow. The Source/Sink location is the centroid of the element it is assigned to.<br />
*'''''Culvert Inlet''''': A culvert can be defined be selecting an inlet and outlet element and specifying the culvert parameters in the ''Culvert Inlet'' dialog. The culvert parameters are then set depending on the culvert component type option.<br />
*'''''Culvert Outlet''''': The outlet location of the culvert. The only parameter in this component is the name of the culvert specified in the ''Culvert Inlet'' dialog. This allows specifying multiple culverts. All other parameters are set in the ''Culvert Inlet'' dialog.<br />
<br />
==Graphical Interface==<br />
RiverFlow2D uses the [[SMS:Generic_Model_Graphical_Interface|Generic Model Graphical Interface]] which allows users to construct the grid, assign model parameters and boundary conditions based on a template provided by the RiverFlow2D developers, and view the output of an analysis.<br />
<br />
===Global Parameters===<br />
The 2DM file for RiverFlow2D has been set up with the following options in the ''Global Parameters'' dialog:<br />
*''Control Data'' &ndash; Sets the model run control parameters like run time and time step duration. Users may switch from a steady state model to a transient model and the associated parameters will be displayed and Boundary Condition options will update automatically. The initial conditions of the model can also be specified here.<br />
*''Sediment Control'' &ndash; Displays one of the different sediment discharge formulas supported. After selecting the method, the required inputs are displayed.<br />
*''Rainfall/Evaporation'' &ndash; Defines time varying rainfall and evaporation data. The RiverFlow2D model assumes that this rainfall or evaporation is constant over your entire model.<br />
*''Graphic Output Options'' &ndash; Contains the parameters that can be set for the graphical output plots that are generated while RiverFlow2D is running. These plots are useful to view potential problems so as to not have to wait until the model converges to see any major issues.<br />
*''Component Controls'' &ndash; Allows turning on and off the different specified components. Instead of deleting, for example, a set of piers, the user can simply turn the pier flag on and off to run the simulation with and without the effects of the piers.<br />
The options in the ''Global Parameters'' dialog can be changed using the [[SMS:Generic_Model_Graphical_Interface|Generic Model Graphical Interface]].<br />
<br />
==Modeling hints for RiverFlow2D ==<br />
* In the model parameters, RiverFlow2D supports a ''Variable Time step'' option. When this is on, the user must specify a multiplier. Experience has shown that users may need to try various values for this multiplier in order to get proper mass conservation.<br />
* The global parameter group ''Graphic Output Options'' causes the engine to launch a separate window during analysis to provide graphical feedback of its progress.<br />
<br />
==Reading Legacy Projects into SMS==<br />
An existing RiverFlow2D project consists of the following files:<br />
* *.dat &ndash; basic input data<br />
* *.fed &ndash; geometry<br />
* *.ifl &ndash; boundary conditions in open countours<br />
* *.hvt &ndash; water surface elevation vs. time<br />
* *.qvt &ndash; flow rate vs. time<br />
* *.plt &ndash; plot options<br />
* *.sed &ndash; sediment data<br />
* *.tba &ndash; list of boundary nodes<br />
<br />
Aquaveo does not currently have a utility to convert these files directly to SMS format. In order to work with data from this project in the SMS environment follow these steps:<br />
<br />
'''Mesh Data'''<br />
*Open the *.fed file in a file editing program such as Notepad ++. Copy and paste the data into Microsoft Excel.<br />
*In Excel, click on the ''data'' menu and select '''Text to Columns'''. Then select '''Fixed Width'''. This will divide the data into individual columns. Click '''next''' twice, then '''finish'''. <br />
*Most users are only concerned with the data in the first three columns so delete the data in the other columns. <br />
*Users will delete one more sets of data now. Scroll down and notice that the data changes. This is because it switches from mesh data to element data. Delete the element data so only the mesh data remains. <br />
*Do a file 'Save as' and save the file as a comma delimited (*.csv) file. Click '''Ok''', then click '''No'''. The file is now ready to be read into SMS. <br />
*When reading the file into SMS, use the Import Wizard. In the ''Import Wizard'', make sure the file is set to ''Delimited'' and click '''next'''. Change the ''SMS data type'' to ''mesh'', then click '''finish'''.<br />
*Once read into SMS, delete the undesired elements.<br />
<br />
'''Nodestring Boundary Conditions'''<br />
*Open the *.hvt file in a file editor and copy and paste the data into Excel. Click on the ''data'' menu and select '''Text to Columns'''. Then select ''Fixed Width''. Click '''next''' twice, then '''Finish'''. <br />
*Repeat the above step for the *.qvt file. The data in these files are now ready to be copied and pasted into SMS and assigned as boundary conditions in their respective nodestrings. <br />
<br />
'''Control Data'''<br />
<br />
The *.dat file does not need to be converted<br />
*Open the *.dat file into the Argus One RiverFlow2D engine. Note the data that appears. <br />
*In SMS, click on the ''RiverFlow2D'' menu and click ''Global Parameters''. Click on the ''Control Data'' tab and record the data from the *.dat file in the RiverFlow2D engine. <br />
<br />
'''Remaining Files'''<br />
<br />
These files are also read into the Argus One RiverFlow2D engine, and the data from there can be manually recorded in SMS under their respective tabs in ''RiverFlow2D'' | '''Global parameters'''.<br />
<br />
==Case Studies / Sample Problems==<br />
=== Hoh River Washington ===<br />
This [http://www.aquaveo.com/software/sms-learning-tutorials tutorial] is distributed with RiverFlow2D and includes a typical riverine application and floodplain.<br />
<br />
==External Links==<br />
* [http://www.hydronia.net www.hydronia.net]<br />
<br />
==Related Topics==<br />
* [[SMS:Generic_Mesh_Model|Generic Model Interface]]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|R]]<br />
[[Category:RiverFlow2D|R]]<br />
[[Category:Generic Interface|R]]<br />
[[Category:Archived]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:RiverFlow2D&diff=100068SMS:RiverFlow2D2016-02-11T17:20:02Z<p>Morelandtom: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= RiverFlow2D<br />
|model_type= 2D current and sediment transport simulation.<br />
|developer= Dr. Reinaldo Garcia<br />
|web_site= [http://hydronia.net/computer-models-software hydronia.net]<br />
|tutorials= <br />
General Section<br />
* Data Visualization<br />
* Mesh Editing<br />
* Observation<br />
}}<br />
<br />
RiverFlow2D is a hydrodynamic, mobile bed model for rivers and estuaries that uses a stable and powerful finite element method to compute high resolution flood hydraulics, including supercritical and subcritical flows over dry or wet river beds. Use of flexible triangular mesh allows resolving the flow field, sediment transport and bed elevation changes around key features in complex river environments. RiverFlow2D has been applied on numerous river projects worldwide including large rivers in the United States, South America, Europe and Asia.<br />
<br />
==Functionality==<br />
Features<br />
*Flexible triangular finite element meshes<br />
*Mesh refinement to resolve complex river features<br />
*Supercritical and subcritical flow<br />
*Steady and time-dependent flow<br />
*Mobile-bed sediment transport<br />
*Numerically stable explicit solution scheme<br />
*Dry-wet bed capability not requiring initially wet elements<br />
*Parallelized code for multiple-core processor computers<br />
*Documented input ASCII, free format files<br />
*Comprehensive ASCII output files<br />
*Graphical output in a variety of formats<br />
<br />
==Using the Model / Practical Notes==<br />
<br />
The RiverFlow2D installation package includes several executable files. To connect SMS to the numeric engine:<br />
# Select the '''Preferences''' command from the ''Edit'' menu<br />
# Click on the ''File Locations'' tab in the [[SMS:Preferences| ''Preferences'']] dialog<br />
# In the ''Model Executables'' area, scroll down to the ''Generic'' line and click on the button on the right side. A dialog to select the executable will appear.<br />
# Browse to the area where SMS is installed (the default is in "Program Files\SMS 11.1 ##-bit"). From there browse into the "models\RiverFLO-2D" folder.<br />
# Select the executable file named "RiverFLO-2Dm3.exe". This is the engine itself that SMS will launch to analyze a simulation.<br />
# Click the '''Open''' button to select the file and the '''OK''' button to close the ''preferences'' dialog.<br />
<br />
==RiverFlow2D Components==<br />
In RiverFlow2D there are different supported components that can be specified by selecting the nodestring or element and assigning a Component or Boundary Condition to them. These options are not used is this tutorial but are available for other simulations. Here is an overview of the different options:<br />
<br />
====Nodestring====<br />
*'''''Exterior Boundary Condition''''': Allows users to specify one of the supported exterior boundary conditions. See the RiverFlow2D manual for more details for the different boundary condition types. This is normally done through the model but can be assigned directly to a nodestring.<br />
*'''''Interior Boundary Condition''''': Allows users to specify a stage-discharge rating table along an internal line in the model. More details are in the RiverFlow2D documentation<br />
*'''''Weir''''': A weir may be defined across a nodestring to have RiverFlow2D use the weir equation to calculate the flow from the upstream elements to the downstream.<br />
<br />
====Element====<br />
*'''''Pier''''': Pier locations at the centroid of the element may be specified and RiverFlow2D will simulate them using the drag equation. Users may also simulate a pier by representing it with a polygon and turning the meshing option off in the polygon attributes in the model.<br />
*'''''Source/Sink''''': The user may provide a hydrograph to simulate a point inflow or outflow. The Source/Sink location is the centroid of the element it is assigned to.<br />
*'''''Culvert Inlet''''': A culvert can be defined be selecting an inlet and outlet element and specifying the culvert parameters in the ''Culvert Inlet'' dialog. The culvert parameters are then set depending on the culvert component type option.<br />
*'''''Culvert Outlet''''': The outlet location of the culvert. The only parameter in this component is the name of the culvert specified in the ''Culvert Inlet'' dialog. This allows specifying multiple culverts. All other parameters are set in the ''Culvert Inlet'' dialog.<br />
<br />
==Graphical Interface==<br />
RiverFlow2D uses the [[SMS:Generic_Model_Graphical_Interface|Generic Model Graphical Interface]] which allows users to construct the grid, assign model parameters and boundary conditions based on a template provided by the RiverFlow2D developers, and view the output of an analysis.<br />
<br />
===Global Parameters===<br />
The 2DM file for RiverFlow2D has been set up with the following options in the ''Global Parameters'' dialog:<br />
*''Control Data'' &ndash; Sets the model run control parameters like run time and time step duration. Users may switch from a steady state model to a transient model and the associated parameters will be displayed and Boundary Condition options will update automatically. The initial conditions of the model can also be specified here.<br />
*''Sediment Control'' &ndash; Displays one of the different sediment discharge formulas supported. After selecting the method, the required inputs are displayed.<br />
*''Rainfall/Evaporation'' &ndash; Defines time varying rainfall and evaporation data. The RiverFlow2D model assumes that this rainfall or evaporation is constant over your entire model.<br />
*''Graphic Output Options'' &ndash; Contains the parameters that can be set for the graphical output plots that are generated while RiverFlow2D is running. These plots are useful to view potential problems so as to not have to wait until the model converges to see any major issues.<br />
*''Component Controls'' &ndash; Allows turning on and off the different specified components. Instead of deleting, for example, a set of piers, the user can simply turn the pier flag on and off to run the simulation with and without the effects of the piers.<br />
The options in the ''Global Parameters'' dialog can be changed using the [[SMS:Generic_Model_Graphical_Interface|Generic Model Graphical Interface]].<br />
<br />
==Modeling hints for RiverFlow2D ==<br />
* In the model parameters, RiverFlow2D supports a ''Variable Time step'' option. When this is on, the user must specify a multiplier. Experience has shown that users may need to try various values for this multiplier in order to get proper mass conservation.<br />
* The global parameter group ''Graphic Output Options'' causes the engine to launch a separate window during analysis to provide graphical feedback of its progress.<br />
<br />
==Reading Legacy Projects into SMS==<br />
An existing RiverFlow2D project consists of the following files:<br />
* *.dat &ndash; basic input data<br />
* *.fed &ndash; geometry<br />
* *.ifl &ndash; boundary conditions in open countours<br />
* *.hvt &ndash; water surface elevation vs. time<br />
* *.qvt &ndash; flow rate vs. time<br />
* *.plt &ndash; plot options<br />
* *.sed &ndash; sediment data<br />
* *.tba &ndash; list of boundary nodes<br />
<br />
Aquaveo does not currently have a utility to convert these files directly to SMS format. In order to work with data from this project in the SMS environment follow these steps:<br />
<br />
'''Mesh Data'''<br />
*Open the *.fed file in a file editing program such as Notepad ++. Copy and paste the data into Microsoft Excel.<br />
*In Excel, click on the ''data'' menu and select '''Text to Columns'''. Then select '''Fixed Width'''. This will divide the data into individual columns. Click '''next''' twice, then '''finish'''. <br />
*Most users are only concerned with the data in the first three columns so delete the data in the other columns. <br />
*Users will delete one more sets of data now. Scroll down and notice that the data changes. This is because it switches from mesh data to element data. Delete the element data so only the mesh data remains. <br />
*Do a file 'Save as' and save the file as a comma delimited (*.csv) file. Click '''Ok''', then click '''No'''. The file is now ready to be read into SMS. <br />
*When reading the file into SMS, use the Import Wizard. In the ''Import Wizard'', make sure the file is set to ''Delimited'' and click '''next'''. Change the ''SMS data type'' to ''mesh'', then click '''finish'''.<br />
*Once read into SMS, delete the undesired elements.<br />
<br />
'''Nodestring Boundary Conditions'''<br />
*Open the *.hvt file in a file editor and copy and paste the data into Excel. Click on the ''data'' menu and select '''Text to Columns'''. Then select ''Fixed Width''. Click '''next''' twice, then '''Finish'''. <br />
*Repeat the above step for the *.qvt file. The data in these files are now ready to be copied and pasted into SMS and assigned as boundary conditions in their respective nodestrings. <br />
<br />
'''Control Data'''<br />
<br />
The *.dat file does not need to be converted<br />
*Open the *.dat file into the Argus One RiverFlow2D engine. Note the data that appears. <br />
*In SMS, click on the ''RiverFlow2D'' menu and click ''Global Parameters''. Click on the ''Control Data'' tab and record the data from the *.dat file in the RiverFlow2D engine. <br />
<br />
'''Remaining Files'''<br />
<br />
These files are also read into the Argus One RiverFlow2D engine, and the data from there can be manually recorded in SMS under their respective tabs in ''RiverFlow2D'' | '''Global parameters'''.<br />
<br />
==Case Studies / Sample Problems==<br />
=== Hoh River Washington ===<br />
This [http://www.aquaveo.com/software/sms-learning-tutorials tutorial] is distributed with RiverFlow2D and includes a typical riverine application and floodplain.<br />
<br />
==External Links==<br />
* [http://www.hydronia.net www.hydronia.net]<br />
<br />
==Related Topics==<br />
* [[SMS:Generic_Mesh_Model|Generic Model Interface]]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|R]]<br />
[[Category:RiverFlow2D|R]]<br />
[[Category:Generic Interface|R]]<br />
[[Category:Archived]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Error_Summary_Plot&diff=97267SMS:Error Summary Plot2015-12-08T20:07:31Z<p>Morelandtom: </p>
<hr />
<div>An ''Error Summary'' plot is used to display a text listing of the mean error, mean absolute error, and root mean squared error for a dataset and the observed values associated with a mesh or grid on observation points in the [[SMS:Observation Coverage|Observation coverage]]. The errors shown are the mean errors for all observation points with computed data.<br />
<br />
: '''''Mean Error''''' &ndash; This is the average error for the points. This value can be misleading since positive and negative errors can cancel.<br />
<br />
: '''''Mean Absolute Average''''' &ndash; This is the mean of the absolute values of the errors. It is a true mean, not allowing positive and negative errors to cancel.<br />
<br />
: '''''Root Mean Square''''' &ndash; This takes the average of the square of the errors and then takes its square root. This norm tends to give more weight to cases where a few extreme error values exist. <br />
<br />
Error Summary plots are created in the [[SMS:Plot_Window#Plot_Wizard|''Plot Wizard'']] by setting the plot type to ''Error Summary''. A sample plot is shown in the figure.<br />
<br />
<br />
[[Image:ErrorSummary.gif]]<br />
<br />
<br />
== Error Summary Plot Options ==<br />
<br />
After the plot type is set in the first step of the ''Plot Wizard'', the '''Next''' button is clicked to move to the second step of the ''Plot Wizard''.<br />
<br />
'''Coverage''' &ndash; Displays the name of the coverage where the current data for the plot is coming from.<br />
<br />
'''Measurement''' &ndash; This is the name of the current measurement, created in the ''Feature Objects'' | '''Attributes''' dialog, being plotted.<br />
<br />
'''Feature Objects''' &ndash; Displays which feature object is utilized in the current plot, points or arcs.<br />
<br />
== Related Topics ==<br />
* [[SMS:Plot Window|Plot Window]]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS Plots]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=GMS:Error_Summary_Plot&diff=97266GMS:Error Summary Plot2015-12-08T20:07:01Z<p>Morelandtom: /* Error types */</p>
<hr />
<div>{{MODFLOW Links}}<br />
An ''Error Summary'' plot is one of the plot types that can be created by the [[GMS:Plot Wizard|''Plot Wizard'']]. See the [[GMS:Plot_Wizard#Error_Summary|Error Summary]] plot section on the Plot Wizard page for a basic description. The ''Error Summary'' plot is used to display a text listing of the mean error, mean absolute error, and root mean squared error for an observation measurement in a coverage. The error values may be listed for a single time step of a dataset or for all time steps.<br />
<br />
==Error types==<br />
: '''''Mean Error''''': This is the average error for the points. This value can be misleading since positive and negative errors can cancel.<br />
<br />
: '''''Mean Absolute Average''''': This is the mean of the absolute values of the errors. It is a true mean, not allowing positive and negative errors to cancel.<br />
<br />
: '''''Root Mean Square''''': This takes the average of the square of the errors and then takes its square root. This norm tends to give more weight to cases where a few extreme error values exist.<br />
<br />
== Time matching ==<br />
When the measurement is transient (i.e., observed heads at various times) then it is very unlikely that the output times from the model match the times when the field measurements were taken. In this case GMS will interpolate an observed value at the model output time. If the model output time is before the first field measurement for a particular point then the interpolated value is the first measurement. Similarly if the model output time is after the last field measurement then the interpolated value is the last measurement. When the model output time is between the first and last measurement then GMS will find the 2 closest field measurments to the model output time and use linear interpolation to compute the "observed" value at that time.<br />
<br />
== MODFLOW errors ==<br />
The ''Error Summary Plot'' is most useful with models that do not make error computations from observation data. MODFLOW does compute error computations from observation data, and these errors are available in the [[GMS:MODFLOW Solution Properties Dialog|''MODFLOW properties'' dialog]]. Therefore, when using MODFLOW, you should use the MODFLOW properties dialog and not the ''Error Summary Plot''. The errors shown in the Error Summary Plot are not the same as those found in the MODFLOW properties dialog due to the time matching and interpolation issues described above. The MODFLOW properties dialog shows the errors computed by MODFLOW for the observations at the actual observation times and is therefore superior. The errors reported by MODFLOW have nothing to do with the model output times, only observation times.<br />
<br />
== Plot creation ==<br />
''Error Summary'' plots are created in the ''Plot Wizard'' by setting the plot type to ''Error Summary''. A sample plot is shown in the figure.<br />
<br />
{{hide in print|[[Image:ErrorSummary.gif]]}}<br />
{{only in print|[[Image:ErrorSummary.gif|frame|center|325px]]}}<br />
<br />
== Error Summary Plot Options ==<br />
<br />
After the plot type is set in the first step of the ''Plot Wizard'', the '''Next''' button is clicked to move to the second step of the ''Plot Wizard''.<br />
<br />
: '''''Coverage''''': Displays the name of the coverage where the current data for the plot is coming from.<br />
<br />
: '''''Measurement''''': This is the name of the current measurement, created in the ''Feature Objects'' | '''Attributes''' dialog, being plotted.<br />
<br />
: '''''Feature Objects''''': Displays which feature object is utilized in the current plot, points or arcs.<br />
<br />
{{Navbox GMS}}<br />
<br />
[[Category:Calibration]]<br />
[[Category:MODFLOW|E]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=GMS:MODFLOW_Solution_Properties_Dialog&diff=97265GMS:MODFLOW Solution Properties Dialog2015-12-08T20:06:36Z<p>Morelandtom: /* Comment on different error values */</p>
<hr />
<div>{{MODFLOW Links}}<br />
The MODFLOW ''Properties'' dialog box is opened by right-clicking on the MODFLOW solution folder in the project explorer.<br />
<br />
{{hide in print|[[Image:ModflowProperties.JPG]]}}<br />
{{only in print|[[Image:ModflowProperties.JPG|center|125px]]}}<br />
The data in this dialog come from the *._os, *._ww, *._r, *._w files computed by the MODFLOW Observation process. The computation from MODFLOW will include any observed flows combined with the observed heads to calculate a single error value. In a transient model, the error value includes all of the observations at the various times. The error shown in this dialog is different from the error found in the [[GMS:Error_Summary_Plot|Error Summary Plot]].<br />
<br />
[[Image:ModflowPropertiesDialogBox.jpg|thumb|none|left|350 px|MODFLOW ''Properties'' dialog box]]<br />
<br />
==Comment on different error values==<br />
*Mean Residual &ndash; Average error for the observations. This can be misleading because the positive and negative errors can cancel.<br />
* Mean Absolute Residual &ndash; Mean of the absolute error values for the observations. This is a true mean, not allowing positive and negative errors to cancel.<br />
* Root Mean Squared Residual &ndash; RMS is calculated by taking the average of the square of the errors for the observations and then taking its square root. This tends to give more weight to cases where a few extreme error values exist.<br />
* Sum of Squared Weighted Residual &ndash; This is the error value that is minimized by a PEST run.<br />
<br />
===Point head observation errors===<br />
: ''Mean Residual (Head)''. <br />
: ''Mean Absolute Residual (Head)''. <br />
: ''Root Mean Squared Residual (Head)''.<br />
<br />
===Flow observation errors===<br />
: ''Mean Residual (Flow)''.<br />
: ''Mean Absolute Residual (Flow)''.<br />
: ''Root Mean Squared Residual (Flow)''.<br />
<br />
===Combined head and flow error values===<br />
: ''Mean Weighted Residual (Head+Flow)''.<br />
: ''Mean Absolute Weighted Residual (Head+Flow)''.<br />
: ''Root Mean Squared Weighted Residual (Head+Flow)''.<br />
: ''Sum of Squared Weighted Residual (Head+Flow)''.<br />
<br />
<br />
{{Navbox GMS}}<br />
<br />
[[Category:MODFLOW]]<br />
[[Category:Calibration]]<br />
[[Category:MODFLOW Dialogs]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=92170SMS:SMS Models2015-09-17T17:09:56Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>{{TOCright}}<br />
[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of SMS.<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW FV|TUFLOW FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. There are partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v12.0<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
* [[SMS:Simulations|Simulations]]<br />
* [[SMS:Model Checker|Model Checker]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=92169SMS:SMS Models2015-09-17T17:09:16Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>{{TOCright}}<br />
[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of SMS.<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW FV|TUFLOW FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. There are partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v12.0<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| V3 & V4 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
* [[SMS:Simulations|Simulations]]<br />
* [[SMS:Model Checker|Model Checker]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=92168SMS:SMS Models2015-09-17T17:08:45Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>{{TOCright}}<br />
[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of SMS.<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW FV|TUFLOW FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. There are partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v12.0<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
* [[SMS:Simulations|Simulations]]<br />
* [[SMS:Model Checker|Model Checker]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=92167SMS:SMS Models2015-09-17T17:07:45Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>{{TOCright}}<br />
[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of SMS.<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW FV|TUFLOW FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. There are partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v12.0<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| Not Available <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v12.0 --><br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v12.0 --><br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
* [[SMS:Simulations|Simulations]]<br />
* [[SMS:Model Checker|Model Checker]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Feature_Stamping&diff=89301SMS:Feature Stamping2015-07-15T18:58:29Z<p>Morelandtom: /* External Links */</p>
<hr />
<div>[[Image:StampedGuidebankPoints.jpg|thumb|300px|right|A stamped embankment with a guidebank]]<br />
Feature stamping is the terminology used to refer to the insertion of man-made structures into a natural topography or bathymetry set. In common terms, this means adding an embankment (such as a levy) or dredging a channel. A stamped feature usually follows a linear object or centerline. However, it can also be based around a single point to create a mound or pit, or applied to only one side of a closed line (a polygon) to create a flat topped mound or flat bottomed pit.<br />
<br />
== The Process ==<br />
The basic steps to define a linear stamped feature include:<br />
# Define the stamping [[SMS:Coverages|coverage]] and centerline (or focal point) of the stamped feature <br />
# Assign attributes to the centerline including:<br />
## The elevation along the centerline<br />
## The cross sections along the centerline<br />
# Stamp the feature. This converts the centerline and its attributes to:<br />
## Another coverage containing all the extents and details of the feature<br />
## A scatter set defining the elevation for the feature.<br />
<br />
Sample problems in the section below illustrate the procedure.<br />
<br />
=== Define the Coverage and Centerline ===<br />
[[File:StampingCoverageAttributes.png|thumb|235 px|Example of the ''Stamping Coverage Attributes'' dialog]]<br />
SMS utilizes a [[SMS:Coverages|coverage]] of type "Stamping" to create the stamped features. Depending on the application, a user may want to have multiple "Stamping" coverages to represent different design alternatives. Each coverage may contain multiple features. Create a "Stamping" coverage by right-clicking on the "Map Data" entry in the ''Project Explorer'' and selecting the '''New Coverage''' command. Then right-click on the new coverage and set its type to "Stamping".<br />
<br />
The ambient geometry is defined by a scatter set (and one of its associated datasets). This surface determines the cut-off for the sloped banks of a stamped feature. Right-clicking on the coverage and selecting '''Properties''' brings up the dialog that associates a specific dataset to the stamping coverage. It's necessary to also specify whether this surface is defined as elevations (positive up) or depths (positive down). By default, SMS interprets this surface as elevation data.<br />
<br />
[[Image:StampedCenterLine.jpg|thumb|none|250px|A centerline arc &ndash; simple]]<br />
<br />
=== Define Feature Attributes ===<br />
Any arc or point created in a "Stamping" coverage has attributes to create a stamped feature. Attributes are assigned in the ''Stamping Point Attributes'' dialog or ''Stamping Arc Attributes'' dialog. Attributes include:<br />
* A feature name &ndash; This will be used when SMS creates stamped feature coverages and scatter sets from the stamping coverage.<br />
* The feature type (cut = channel or fill = embankment) &ndash; If there is a stamped feature that contains both cut and fill sections, create one coverage as a cut, then duplicate the coverage and change the copies type to fill.<br />
* A base elevation (the top elevation of the embankment or the bottom of the channel) &ndash; This can be specified from the node/vertex elevations, as a constant, or extracted from a curve of elevation -vs- distance.<br />
* The cross sectional shape(s) &ndash; The cross section can be defined as a template, which is propagated all along an arc, or can be individually specified at each vertex in an arc. The cross section can also be defined individually for the left and right side of the arc. One point on each side of the cross section can be specified as the "shoulder". For a channel, this would be the "toe", but the reference in SMS is the shoulder point. When the arcs representing the shoulder are created, the user has the option to create an arc along this shoulder. If vertical walled structures are desired, the cross section can simply stop at the edge (shoulder). This will result in a feature arc at the edge and a scatter set for the top of the structure.<br />
* The method for treating the ends of the structure &ndash; The options include:<br />
<blockquote><br />
* Wingwalls<br />
* A sloped abutment (spillthrough)<br />
* A guidebank<br />
</blockquote><br />
{|<br />
|-<br />
|[[Image:WingWalls.jpg|thumb|200px|left|Wing Walls]]<br />
|[[Image:Spillthrough.jpg|thumb|200px|center|Spillthrough]]<br />
|[[Image:Guidebank.jpg|thumb|200px|right|Guidebank]]<br />
|}<br />
[[File:StampingArcAttributes.png|thumb|none|700 px|Example of a ''Stamping Arc Attributes'' dialog]]<br />
<br />
=== Stamping the Feature ===<br />
[[Image:StampedGuidebankArcs plan.jpg|thumb|200px|right|Stamped Feature Arcs &ndash; Created from Centerline]]<br />
To create the stamped feature, right-click on the "Stamping" coverage and select '''Convert &rarr; Stamp Features ...'''. This brings up a dialog that allows the user to specify what output should be created from the process. Specifically, the process can create:<br />
* A new scatter set which defines the elevation points for the new structure. This is named based on the stamped feature name. SMS triangulates all these points to create a surface and trims the scatter set to the extents of the stamped feature. The arcs that make up the stamped feature are converted to scatter [[SMS:Breaklines|breaklines]] to assist in the triangulation.<br />
* A new coverage which defines the breaks and extents of the new coverage. The dialog allows the user to specify the type of the coverage. Generally, it is recommended that the coverage type be selected to match the numeric engine that will evenutally be used for the simulation. Options also exist to determine whether the stamped feature will include the center line, the shoulders, and the cross sections. The extents of the stamped feature are always generated.<br />
{|<br />
|-<br />
|[[Image:StampedGuidebankArcs.jpg|thumb|350px|left|Stamped Feature Arcs &ndash; Oblique view]]<br />
|[[Image:StampedGuidebankPoints.jpg|thumb|350px|center|Stamped Feature Scatter Set &ndash; Oblique view]]<br />
|}<br />
<br />
== Case Studies / Sample Problems ==<br />
There are a wide variety of stamped features that can be created using this tool. The Feature Stamping tutorial in the general section of the [[SMS:Tutorials|tutorials]] may be helpful for learning to use them.<br />
<br />
* Embankments on a flat plain<br />
<blockquote><br />
* Vertical sides on an embankment<br />
* Sloped sides on an embankment<br />
</blockquote><br />
<br />
==Related Topics==<br />
* [[SMS:Generic Coverages|Generic Coverages]]<br />
<br />
==External Links==<br />
* Emery, R. N. (2005). Refining and Expanding the Feature Stamping Process. Thesis, Brigham Young University. [http://scholarsarchive.byu.edu/cgi/viewcontent.cgi?article=1642&context=etd]<br />
* Christensen, J. R. (2001). Stamped Features: Automatic Generation of Flow Modifying Structures in Conceptual Models. Thesis, Brigham Young University.<br />
* Zundel, Alan K. and J. Ryan Christensen, “Stamped Features: Creation of Engineered Structures in Conceptual Models”, International Journal of Hyrdroinformatics, Vol. 4, No. 1, February 2002, pp. 63-72.<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS Coverages|F]]<br />
[[Category:SMS Map|F]]<br />
[[Category:External Links]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=Annotations&diff=86847Annotations2015-05-21T15:28:18Z<p>Morelandtom: /* Viewing Annotations At Specific Time Intervals */</p>
<hr />
<div>{{TOCright}}<br />
==Annotation Objects==<br />
The GMS and SMS applications contain tools to annotate the data in an application for presentations, animations and screen shots.<br />
<br />
These tools (annotation objects)are accessed through the Annotations Module and include:<br />
* Images<br />
* North Arrows<br />
* Scale Bars<br />
* Text<br />
* Lines<br />
* Ovals<br />
* Rectangles<br />
<br />
==Screen vs World Space Layers==<br />
All annotation layers either contain objects referenced to world or screen coordinates. Objects referenced to world coordinates will change size and position on the screen with the underlying data. This is useful to identify specific locations in the model such as peir locations. Objects associated with screen coordinates do not move on the screen with the underlying data. This is useful for titles, legends such as north arrows and scale bars, and logos. Some types of annotations can only be created in screen space layers. These include North Arrows, Images, and scale bars.<br />
<br />
When the first annotation object created, the program will ask which type of layer (screen or world space) the user wishes to create and add the object to. The user can create additional layers by right-clicking on the ''Annotation Data tree'' item and selecting '''Create Screen Space Layer''' or '''Create World Space Layer'''. Layers are differentiated by including an 'S' for screen space layers or 'W' for world space layers in their icons in the project explorer.<br />
<br />
If multiple layers exist, any newly created annotation object will be placed in the "current" layer.<br />
<br />
[[Image:AnnotationTree.jpg|border]]<br />
<br />
==Annotation Object Attributes==<br />
The extents of annotation objects defined by a frame. The user defines this frame initially when creating the annotation object by left-clicking at any point on the screen and dragging a rectangle with the mouse (left button still down). The display will show the frame while dragging with the mouse. (Points and lines defining degenerate frames are not allowed.) <br />
<br />
When the user creates a annotation, if the frame is too big for the window, it will be resized appropriately. Annotations can't be resized or moved even partially outside of the borders of the window. If the user resizes a annotation through a quick mouse drag and the cursor lands outside the window, the annotation will be redrawn to take up all the window space in that direction. <br />
<br />
This frame bounds the region of the screen where the object will appear with the modeling data. The user interacts with the object by interacting with its frame and specifying its attributes or properties (see the section on selection below). The frame anchors the annotation object on the screen. This anchoring defines both the size and position of the object. The x-location, y-location, x-size and y-size are all defined independently as either a pixel value or percentage of the screen. <br />
<br />
Horizontally, the user can position the left edge, the right edge or the center of the object. If the user positions the left edge, the object position is defined relative to the left edge of the screen. If the user positions the right edge, the object position is defined relative to the right edge of the screen. If the user positions the center of the object, the object position is defined relative to the horizontal center of the screen.<br />
<br />
For example, the left side of the frame may be specified as 100 pixels from the left edge of the screen. Alternatively, the user may specify that the right edge of the frame should be 10% of screen width from the right edge. Finally, the user may specify that the center of the object is 100 pixels to the right of the center of the screen.<br />
<br />
The vertical position and sizes of the object are similarly specified in the anchoring attribute of the object.<br />
<br />
All annotation objects also have attributes. The specific attributes depend on the type of object. The attributes define color, line thickness, fill properties, associated images, etc.<br />
<br />
==Screen Space Images==<br />
A screen space image is simply a graphics icon mapped to the screen. A typical application would be to display a company, department, or municipality logo next to the numeric model being displayed in the graphics window.<br />
<br />
Attributes of the screen space images include:<br />
* General anchoring attributes<br />
* The image file being displayed as part of the project<br />
* Whether the image is being displayed as a scaled (distorted object), scaled based on its original aspect ratio, or locked at another aspect ratio.<br />
* Transparency &ndash; The image properties dialog have a transparency checkbox. When checked it will cause the image to be redrawn with the most used color in the image. When that it is checked, it also causes the color checkbox and the tolerance edit field to become available. If the color checkbox is checked, it will activate the color button and the color button will have the latest chosen image color painted on it or the most used color in the image, if it has not been activated before. Clicking on the down arrow part of the color button causes a color popup to be displayed with swaths of the 40 most used colors in the image or all the colors in the image, if the image has less than 40 colors. Clicking on one of those colors will cause the image to be redrawn with that color made transparent in the image. The tolerance edit field allows for variation in the matching of the red, green and blue components. The tolerance field ranges in allowable values from 0.0 to 1.0. 0.0 means the red, green and blue components must exactly match. Values higher than 0.0 indicate the degree of variation from the given color. Clicking the transparency checkbox to the off state causes the image to be redrawn with no transparency.<br />
<br />
==Scale Bars==<br />
A scale bar occupies a fixed size of the screen to display the relative size of the objects in the simulation. The user defines the minimum width of the scale bar section (in pixels), along with a minimum and maximum height of the scale (also in pixels). The XMS application adds a "Units" label (meters in the image shown below) and labels for the model distance related to the scale divisions.<br />
<br />
[[Image:Scale.jpg|border|150px]]<br />
<br />
The program will compute a well conditioned number to use as the scale increment that fits in the specified scale bar extents.<br />
<br />
Attributes of the scale bar include:<br />
* General anchoring attributes.<br />
* The minimum spacing between distance labels.<br />
* The minimum division width (in pixels). The XMS application determines the number of divisions based on the minimum divisiion width and the width of the frame.<br />
* The minimum and maximum height of the scale bar object.<br />
* The font (style, color, size) used to label the scale bar.<br />
* Whether or not the area behind the scale bar will be filled, and if so, with what color.<br />
<br />
==North Arrows==<br />
[[Image:North-arrow.jpg|left|50 px]]<br />
<br />
North arrow objects consist of automatically rotating screen space images. When an XMS application is installed, at least one default North Arrow image will be included in the application's home directory. Users may create or download as many north arrow icons as desired. These icons are displayed at the specified location (anchored with the standard options), but will rotate as the view direction changes so that the "up" direction of the icon always aligns with the "North" or positive "Y" direction.<br />
<br />
Attributes of north arrows include:<br />
* See screen space image attributes.<br />
<br />
==Text==<br />
Text can be created in world or screen space layers.<br />
<br />
A user can enter text by clicking in the graphics window with the '''Create Text''' tool active.<br />
<br />
A user can set the following attributes for text:<br />
* Font &ndash; including size<br />
* Color<br />
* Background &ndash; fill behind with the background color or another color<br />
* Border and border thickness<br />
<br />
==Lines/Arrows==<br />
A user can create Lines/Arrows using the '''Create Line''' Tool. Lines/Arrows can be created in screen or world space layers.<br />
<br />
The attributes available for Lines/Arrows include:<br />
* Type &ndash; Dashed or solid w/ thickness<br />
* Color<br />
* Arrowheads &ndash; location (beginning, end, both) and size<br />
<br />
==Ovals==<br />
A user can create ovals by dragging a box with '''Create Oval''' tool active. Ovals can be created in world or screen space layers.<br />
<br />
The attributes that can be specified for ovals include:<br />
* Line type &ndash; dashed/solid with width<br />
* Line color<br />
* Fill and color or No Fill<br />
<br />
==Rectangles==<br />
Rectangles can be created in screen or world space layers. Their attributes are the same as those available for ovals.<br />
<br />
== Selection ==<br />
The first toolbar button is used to select and set attributes for annotation objects. This requires that objects exist to be selected. In this case when the user presses this tool and then left-click in the annotation object, the object frame will be drawn around the annotation. In addition to the frame, the XMS application displays grab handles on the corners and edges of the frame. The user modifies the rectangular shape of the annotation by dragging one of the grab handles and changes the position of the object by dragging the annotation (click at any point in the object interior).<br />
<br />
When this tool is active the right mouse button will pop up a menu of all dialogs for that particular type of annotation. This will include at least "Attributes" which will display a dialog of the objects attributes for editing.<br />
<br />
== Viewing Annotations At Specific Time Intervals ==<br />
<br />
Available in SMS v11.1 and higher, annotations can be setup to be viewed at specific time intervals. This feature is currently under development in GMS. To setup annotations so they only are displayed at specified time intervals do the following:<br />
<br />
* Right-click on the Annotation layer in the tree then select ''Properties...''. <br />
* This dialog will display the ''Annotation Layer Properties'' dialog.<br />
* Check the ''Apply time range'' checkbox<br />
* Modify the "begin" and "end" time controls to specify the range for when annotations are visible.<br />
* Click '''Ok'''.<br />
<br />
Annotations will not be displayed when the specified time range is active. This applies to data in the graphics window and film loops.<br />
<br />
==See also==<br />
* [[GMS:GMS|GMS]]<br />
* [[SMS:SMS|SMS]]<br />
* [http://www.xmswiki.com/index.php?title=SMS:Layout Layout of the Graphical Interface]<br />
<br />
[[Category:GMS Models]]<br />
[[Category:SMS Models]]<br />
[[Category:WMS Models]]<br />
[[Category:Numerical Models|A]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=Annotations&diff=86846Annotations2015-05-21T15:23:54Z<p>Morelandtom: /* Scale Bars */</p>
<hr />
<div>{{TOCright}}<br />
==Annotation Objects==<br />
The GMS and SMS applications contain tools to annotate the data in an application for presentations, animations and screen shots.<br />
<br />
These tools (annotation objects)are accessed through the Annotations Module and include:<br />
* Images<br />
* North Arrows<br />
* Scale Bars<br />
* Text<br />
* Lines<br />
* Ovals<br />
* Rectangles<br />
<br />
==Screen vs World Space Layers==<br />
All annotation layers either contain objects referenced to world or screen coordinates. Objects referenced to world coordinates will change size and position on the screen with the underlying data. This is useful to identify specific locations in the model such as peir locations. Objects associated with screen coordinates do not move on the screen with the underlying data. This is useful for titles, legends such as north arrows and scale bars, and logos. Some types of annotations can only be created in screen space layers. These include North Arrows, Images, and scale bars.<br />
<br />
When the first annotation object created, the program will ask which type of layer (screen or world space) the user wishes to create and add the object to. The user can create additional layers by right-clicking on the ''Annotation Data tree'' item and selecting '''Create Screen Space Layer''' or '''Create World Space Layer'''. Layers are differentiated by including an 'S' for screen space layers or 'W' for world space layers in their icons in the project explorer.<br />
<br />
If multiple layers exist, any newly created annotation object will be placed in the "current" layer.<br />
<br />
[[Image:AnnotationTree.jpg|border]]<br />
<br />
==Annotation Object Attributes==<br />
The extents of annotation objects defined by a frame. The user defines this frame initially when creating the annotation object by left-clicking at any point on the screen and dragging a rectangle with the mouse (left button still down). The display will show the frame while dragging with the mouse. (Points and lines defining degenerate frames are not allowed.) <br />
<br />
When the user creates a annotation, if the frame is too big for the window, it will be resized appropriately. Annotations can't be resized or moved even partially outside of the borders of the window. If the user resizes a annotation through a quick mouse drag and the cursor lands outside the window, the annotation will be redrawn to take up all the window space in that direction. <br />
<br />
This frame bounds the region of the screen where the object will appear with the modeling data. The user interacts with the object by interacting with its frame and specifying its attributes or properties (see the section on selection below). The frame anchors the annotation object on the screen. This anchoring defines both the size and position of the object. The x-location, y-location, x-size and y-size are all defined independently as either a pixel value or percentage of the screen. <br />
<br />
Horizontally, the user can position the left edge, the right edge or the center of the object. If the user positions the left edge, the object position is defined relative to the left edge of the screen. If the user positions the right edge, the object position is defined relative to the right edge of the screen. If the user positions the center of the object, the object position is defined relative to the horizontal center of the screen.<br />
<br />
For example, the left side of the frame may be specified as 100 pixels from the left edge of the screen. Alternatively, the user may specify that the right edge of the frame should be 10% of screen width from the right edge. Finally, the user may specify that the center of the object is 100 pixels to the right of the center of the screen.<br />
<br />
The vertical position and sizes of the object are similarly specified in the anchoring attribute of the object.<br />
<br />
All annotation objects also have attributes. The specific attributes depend on the type of object. The attributes define color, line thickness, fill properties, associated images, etc.<br />
<br />
==Screen Space Images==<br />
A screen space image is simply a graphics icon mapped to the screen. A typical application would be to display a company, department, or municipality logo next to the numeric model being displayed in the graphics window.<br />
<br />
Attributes of the screen space images include:<br />
* General anchoring attributes<br />
* The image file being displayed as part of the project<br />
* Whether the image is being displayed as a scaled (distorted object), scaled based on its original aspect ratio, or locked at another aspect ratio.<br />
* Transparency &ndash; The image properties dialog have a transparency checkbox. When checked it will cause the image to be redrawn with the most used color in the image. When that it is checked, it also causes the color checkbox and the tolerance edit field to become available. If the color checkbox is checked, it will activate the color button and the color button will have the latest chosen image color painted on it or the most used color in the image, if it has not been activated before. Clicking on the down arrow part of the color button causes a color popup to be displayed with swaths of the 40 most used colors in the image or all the colors in the image, if the image has less than 40 colors. Clicking on one of those colors will cause the image to be redrawn with that color made transparent in the image. The tolerance edit field allows for variation in the matching of the red, green and blue components. The tolerance field ranges in allowable values from 0.0 to 1.0. 0.0 means the red, green and blue components must exactly match. Values higher than 0.0 indicate the degree of variation from the given color. Clicking the transparency checkbox to the off state causes the image to be redrawn with no transparency.<br />
<br />
==Scale Bars==<br />
A scale bar occupies a fixed size of the screen to display the relative size of the objects in the simulation. The user defines the minimum width of the scale bar section (in pixels), along with a minimum and maximum height of the scale (also in pixels). The XMS application adds a "Units" label (meters in the image shown below) and labels for the model distance related to the scale divisions.<br />
<br />
[[Image:Scale.jpg|border|150px]]<br />
<br />
The program will compute a well conditioned number to use as the scale increment that fits in the specified scale bar extents.<br />
<br />
Attributes of the scale bar include:<br />
* General anchoring attributes.<br />
* The minimum spacing between distance labels.<br />
* The minimum division width (in pixels). The XMS application determines the number of divisions based on the minimum divisiion width and the width of the frame.<br />
* The minimum and maximum height of the scale bar object.<br />
* The font (style, color, size) used to label the scale bar.<br />
* Whether or not the area behind the scale bar will be filled, and if so, with what color.<br />
<br />
==North Arrows==<br />
[[Image:North-arrow.jpg|left|50 px]]<br />
<br />
North arrow objects consist of automatically rotating screen space images. When an XMS application is installed, at least one default North Arrow image will be included in the application's home directory. Users may create or download as many north arrow icons as desired. These icons are displayed at the specified location (anchored with the standard options), but will rotate as the view direction changes so that the "up" direction of the icon always aligns with the "North" or positive "Y" direction.<br />
<br />
Attributes of north arrows include:<br />
* See screen space image attributes.<br />
<br />
==Text==<br />
Text can be created in world or screen space layers.<br />
<br />
A user can enter text by clicking in the graphics window with the '''Create Text''' tool active.<br />
<br />
A user can set the following attributes for text:<br />
* Font &ndash; including size<br />
* Color<br />
* Background &ndash; fill behind with the background color or another color<br />
* Border and border thickness<br />
<br />
==Lines/Arrows==<br />
A user can create Lines/Arrows using the '''Create Line''' Tool. Lines/Arrows can be created in screen or world space layers.<br />
<br />
The attributes available for Lines/Arrows include:<br />
* Type &ndash; Dashed or solid w/ thickness<br />
* Color<br />
* Arrowheads &ndash; location (beginning, end, both) and size<br />
<br />
==Ovals==<br />
A user can create ovals by dragging a box with '''Create Oval''' tool active. Ovals can be created in world or screen space layers.<br />
<br />
The attributes that can be specified for ovals include:<br />
* Line type &ndash; dashed/solid with width<br />
* Line color<br />
* Fill and color or No Fill<br />
<br />
==Rectangles==<br />
Rectangles can be created in screen or world space layers. Their attributes are the same as those available for ovals.<br />
<br />
== Selection ==<br />
The first toolbar button is used to select and set attributes for annotation objects. This requires that objects exist to be selected. In this case when the user presses this tool and then left-click in the annotation object, the object frame will be drawn around the annotation. In addition to the frame, the XMS application displays grab handles on the corners and edges of the frame. The user modifies the rectangular shape of the annotation by dragging one of the grab handles and changes the position of the object by dragging the annotation (click at any point in the object interior).<br />
<br />
When this tool is active the right mouse button will pop up a menu of all dialogs for that particular type of annotation. This will include at least "Attributes" which will display a dialog of the objects attributes for editing.<br />
<br />
== Viewing Annotations At Specific Time Intervals ==<br />
<br />
Available in SMS 11.1 and in development for GMS, annotations can be setup to be viewed at specific time intervals. To setup annotations so they only are displayed at specified time intervals do the following:<br />
<br />
* Right-click on the Annotation layer in the tree then select ''Properties...''. <br />
* This dialog will display the ''Annotation Layer Properties'' dialog.<br />
* Check the ''Apply time range'' checkbox<br />
* Modify the "begin" and "end" time controls to specify the range for when annotations are visible.<br />
* Click '''Ok'''.<br />
<br />
Now film loops and time steps will only display the annotation when its within the range specified.<br />
<br />
==See also==<br />
* [[GMS:GMS|GMS]]<br />
* [[SMS:SMS|SMS]]<br />
* [http://www.xmswiki.com/index.php?title=SMS:Layout Layout of the Graphical Interface]<br />
<br />
[[Category:GMS Models]]<br />
[[Category:SMS Models]]<br />
[[Category:WMS Models]]<br />
[[Category:Numerical Models|A]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=Annotations&diff=86845Annotations2015-05-21T15:23:31Z<p>Morelandtom: /* Screen vs World Space Layers */</p>
<hr />
<div>{{TOCright}}<br />
==Annotation Objects==<br />
The GMS and SMS applications contain tools to annotate the data in an application for presentations, animations and screen shots.<br />
<br />
These tools (annotation objects)are accessed through the Annotations Module and include:<br />
* Images<br />
* North Arrows<br />
* Scale Bars<br />
* Text<br />
* Lines<br />
* Ovals<br />
* Rectangles<br />
<br />
==Screen vs World Space Layers==<br />
All annotation layers either contain objects referenced to world or screen coordinates. Objects referenced to world coordinates will change size and position on the screen with the underlying data. This is useful to identify specific locations in the model such as peir locations. Objects associated with screen coordinates do not move on the screen with the underlying data. This is useful for titles, legends such as north arrows and scale bars, and logos. Some types of annotations can only be created in screen space layers. These include North Arrows, Images, and scale bars.<br />
<br />
When the first annotation object created, the program will ask which type of layer (screen or world space) the user wishes to create and add the object to. The user can create additional layers by right-clicking on the ''Annotation Data tree'' item and selecting '''Create Screen Space Layer''' or '''Create World Space Layer'''. Layers are differentiated by including an 'S' for screen space layers or 'W' for world space layers in their icons in the project explorer.<br />
<br />
If multiple layers exist, any newly created annotation object will be placed in the "current" layer.<br />
<br />
[[Image:AnnotationTree.jpg|border]]<br />
<br />
==Annotation Object Attributes==<br />
The extents of annotation objects defined by a frame. The user defines this frame initially when creating the annotation object by left-clicking at any point on the screen and dragging a rectangle with the mouse (left button still down). The display will show the frame while dragging with the mouse. (Points and lines defining degenerate frames are not allowed.) <br />
<br />
When the user creates a annotation, if the frame is too big for the window, it will be resized appropriately. Annotations can't be resized or moved even partially outside of the borders of the window. If the user resizes a annotation through a quick mouse drag and the cursor lands outside the window, the annotation will be redrawn to take up all the window space in that direction. <br />
<br />
This frame bounds the region of the screen where the object will appear with the modeling data. The user interacts with the object by interacting with its frame and specifying its attributes or properties (see the section on selection below). The frame anchors the annotation object on the screen. This anchoring defines both the size and position of the object. The x-location, y-location, x-size and y-size are all defined independently as either a pixel value or percentage of the screen. <br />
<br />
Horizontally, the user can position the left edge, the right edge or the center of the object. If the user positions the left edge, the object position is defined relative to the left edge of the screen. If the user positions the right edge, the object position is defined relative to the right edge of the screen. If the user positions the center of the object, the object position is defined relative to the horizontal center of the screen.<br />
<br />
For example, the left side of the frame may be specified as 100 pixels from the left edge of the screen. Alternatively, the user may specify that the right edge of the frame should be 10% of screen width from the right edge. Finally, the user may specify that the center of the object is 100 pixels to the right of the center of the screen.<br />
<br />
The vertical position and sizes of the object are similarly specified in the anchoring attribute of the object.<br />
<br />
All annotation objects also have attributes. The specific attributes depend on the type of object. The attributes define color, line thickness, fill properties, associated images, etc.<br />
<br />
==Screen Space Images==<br />
A screen space image is simply a graphics icon mapped to the screen. A typical application would be to display a company, department, or municipality logo next to the numeric model being displayed in the graphics window.<br />
<br />
Attributes of the screen space images include:<br />
* General anchoring attributes<br />
* The image file being displayed as part of the project<br />
* Whether the image is being displayed as a scaled (distorted object), scaled based on its original aspect ratio, or locked at another aspect ratio.<br />
* Transparency &ndash; The image properties dialog have a transparency checkbox. When checked it will cause the image to be redrawn with the most used color in the image. When that it is checked, it also causes the color checkbox and the tolerance edit field to become available. If the color checkbox is checked, it will activate the color button and the color button will have the latest chosen image color painted on it or the most used color in the image, if it has not been activated before. Clicking on the down arrow part of the color button causes a color popup to be displayed with swaths of the 40 most used colors in the image or all the colors in the image, if the image has less than 40 colors. Clicking on one of those colors will cause the image to be redrawn with that color made transparent in the image. The tolerance edit field allows for variation in the matching of the red, green and blue components. The tolerance field ranges in allowable values from 0.0 to 1.0. 0.0 means the red, green and blue components must exactly match. Values higher than 0.0 indicate the degree of variation from the given color. Clicking the transparency checkbox to the off state causes the image to be redrawn with no transparency.<br />
<br />
==Scale Bars==<br />
A scale bar occupies a fixed size of the screen to display the relative size of the objects in the simulation. The user defines the minimum width of the scale bar section (in pixels), along with a minimum and maximum height of the scale (also in pixels). The XMS application adds a "Units" label (meters in the image shown below) and labels for the model distance related to the scale divisions.<br />
<br />
[[Image:Scale.jpg|border|150px]]<br />
<br />
The XMS applications will compute a well conditioned number to use as the scale increment that fits in the specified scale bar extents.<br />
<br />
Attributes of the scale bar include:<br />
* General anchoring attributes.<br />
* The minimum spacing between distance labels.<br />
* The minimum division width (in pixels). The XMS application determines the number of divisions based on the minimum divisiion width and the width of the frame.<br />
* The minimum and maximum height of the scale bar object.<br />
* The font (style, color, size) used to label the scale bar.<br />
* Whether or not the area behind the scale bar will be filled, and if so, with what color.<br />
<br />
==North Arrows==<br />
[[Image:North-arrow.jpg|left|50 px]]<br />
<br />
North arrow objects consist of automatically rotating screen space images. When an XMS application is installed, at least one default North Arrow image will be included in the application's home directory. Users may create or download as many north arrow icons as desired. These icons are displayed at the specified location (anchored with the standard options), but will rotate as the view direction changes so that the "up" direction of the icon always aligns with the "North" or positive "Y" direction.<br />
<br />
Attributes of north arrows include:<br />
* See screen space image attributes.<br />
<br />
==Text==<br />
Text can be created in world or screen space layers.<br />
<br />
A user can enter text by clicking in the graphics window with the '''Create Text''' tool active.<br />
<br />
A user can set the following attributes for text:<br />
* Font &ndash; including size<br />
* Color<br />
* Background &ndash; fill behind with the background color or another color<br />
* Border and border thickness<br />
<br />
==Lines/Arrows==<br />
A user can create Lines/Arrows using the '''Create Line''' Tool. Lines/Arrows can be created in screen or world space layers.<br />
<br />
The attributes available for Lines/Arrows include:<br />
* Type &ndash; Dashed or solid w/ thickness<br />
* Color<br />
* Arrowheads &ndash; location (beginning, end, both) and size<br />
<br />
==Ovals==<br />
A user can create ovals by dragging a box with '''Create Oval''' tool active. Ovals can be created in world or screen space layers.<br />
<br />
The attributes that can be specified for ovals include:<br />
* Line type &ndash; dashed/solid with width<br />
* Line color<br />
* Fill and color or No Fill<br />
<br />
==Rectangles==<br />
Rectangles can be created in screen or world space layers. Their attributes are the same as those available for ovals.<br />
<br />
== Selection ==<br />
The first toolbar button is used to select and set attributes for annotation objects. This requires that objects exist to be selected. In this case when the user presses this tool and then left-click in the annotation object, the object frame will be drawn around the annotation. In addition to the frame, the XMS application displays grab handles on the corners and edges of the frame. The user modifies the rectangular shape of the annotation by dragging one of the grab handles and changes the position of the object by dragging the annotation (click at any point in the object interior).<br />
<br />
When this tool is active the right mouse button will pop up a menu of all dialogs for that particular type of annotation. This will include at least "Attributes" which will display a dialog of the objects attributes for editing.<br />
<br />
== Viewing Annotations At Specific Time Intervals ==<br />
<br />
Available in SMS 11.1 and in development for GMS, annotations can be setup to be viewed at specific time intervals. To setup annotations so they only are displayed at specified time intervals do the following:<br />
<br />
* Right-click on the Annotation layer in the tree then select ''Properties...''. <br />
* This dialog will display the ''Annotation Layer Properties'' dialog.<br />
* Check the ''Apply time range'' checkbox<br />
* Modify the "begin" and "end" time controls to specify the range for when annotations are visible.<br />
* Click '''Ok'''.<br />
<br />
Now film loops and time steps will only display the annotation when its within the range specified.<br />
<br />
==See also==<br />
* [[GMS:GMS|GMS]]<br />
* [[SMS:SMS|SMS]]<br />
* [http://www.xmswiki.com/index.php?title=SMS:Layout Layout of the Graphical Interface]<br />
<br />
[[Category:GMS Models]]<br />
[[Category:SMS Models]]<br />
[[Category:WMS Models]]<br />
[[Category:Numerical Models|A]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=Annotations&diff=86844Annotations2015-05-21T15:21:43Z<p>Morelandtom: /* Screen vs World Space Layers */</p>
<hr />
<div>{{TOCright}}<br />
==Annotation Objects==<br />
The GMS and SMS applications contain tools to annotate the data in an application for presentations, animations and screen shots.<br />
<br />
These tools (annotation objects)are accessed through the Annotations Module and include:<br />
* Images<br />
* North Arrows<br />
* Scale Bars<br />
* Text<br />
* Lines<br />
* Ovals<br />
* Rectangles<br />
<br />
==Screen vs World Space Layers==<br />
All annotation layers either contain objects referenced to world or screen coordinates. Objects referenced to world coordinates will change size and position on the screen with the underlying data. This is useful to identify specific locations in the model such as peir locations. Objects associated with screen coordinates do not move on the screen with the underlying data. This is useful for titles, legends such as north arrows and scale bars, and logos. Some types of annotations can only be created in screen space layers including North Arrows, Images, and scale bars.<br />
<br />
With the first annotation object created, could be part of a screen or world space layer, the program will ask which type of layer the user wishes to create and add the object to. The user can create additional layers by right-clicking on the ''Annotation Data tree'' item and selecting '''Create Screen Space Layer''' or '''Create World Space Layer'''. Layers are differentiated by including an 'S' for screen space layers or 'W' for world space layers in their icons in the project explorer.<br />
<br />
If multiple layers exist, any newly created annotation object will be placed in the "current" layer.<br />
<br />
[[Image:AnnotationTree.jpg|border]]<br />
<br />
==Annotation Object Attributes==<br />
The extents of annotation objects defined by a frame. The user defines this frame initially when creating the annotation object by left-clicking at any point on the screen and dragging a rectangle with the mouse (left button still down). The display will show the frame while dragging with the mouse. (Points and lines defining degenerate frames are not allowed.) <br />
<br />
When the user creates a annotation, if the frame is too big for the window, it will be resized appropriately. Annotations can't be resized or moved even partially outside of the borders of the window. If the user resizes a annotation through a quick mouse drag and the cursor lands outside the window, the annotation will be redrawn to take up all the window space in that direction. <br />
<br />
This frame bounds the region of the screen where the object will appear with the modeling data. The user interacts with the object by interacting with its frame and specifying its attributes or properties (see the section on selection below). The frame anchors the annotation object on the screen. This anchoring defines both the size and position of the object. The x-location, y-location, x-size and y-size are all defined independently as either a pixel value or percentage of the screen. <br />
<br />
Horizontally, the user can position the left edge, the right edge or the center of the object. If the user positions the left edge, the object position is defined relative to the left edge of the screen. If the user positions the right edge, the object position is defined relative to the right edge of the screen. If the user positions the center of the object, the object position is defined relative to the horizontal center of the screen.<br />
<br />
For example, the left side of the frame may be specified as 100 pixels from the left edge of the screen. Alternatively, the user may specify that the right edge of the frame should be 10% of screen width from the right edge. Finally, the user may specify that the center of the object is 100 pixels to the right of the center of the screen.<br />
<br />
The vertical position and sizes of the object are similarly specified in the anchoring attribute of the object.<br />
<br />
All annotation objects also have attributes. The specific attributes depend on the type of object. The attributes define color, line thickness, fill properties, associated images, etc.<br />
<br />
==Screen Space Images==<br />
A screen space image is simply a graphics icon mapped to the screen. A typical application would be to display a company, department, or municipality logo next to the numeric model being displayed in the graphics window.<br />
<br />
Attributes of the screen space images include:<br />
* General anchoring attributes<br />
* The image file being displayed as part of the project<br />
* Whether the image is being displayed as a scaled (distorted object), scaled based on its original aspect ratio, or locked at another aspect ratio.<br />
* Transparency &ndash; The image properties dialog have a transparency checkbox. When checked it will cause the image to be redrawn with the most used color in the image. When that it is checked, it also causes the color checkbox and the tolerance edit field to become available. If the color checkbox is checked, it will activate the color button and the color button will have the latest chosen image color painted on it or the most used color in the image, if it has not been activated before. Clicking on the down arrow part of the color button causes a color popup to be displayed with swaths of the 40 most used colors in the image or all the colors in the image, if the image has less than 40 colors. Clicking on one of those colors will cause the image to be redrawn with that color made transparent in the image. The tolerance edit field allows for variation in the matching of the red, green and blue components. The tolerance field ranges in allowable values from 0.0 to 1.0. 0.0 means the red, green and blue components must exactly match. Values higher than 0.0 indicate the degree of variation from the given color. Clicking the transparency checkbox to the off state causes the image to be redrawn with no transparency.<br />
<br />
==Scale Bars==<br />
A scale bar occupies a fixed size of the screen to display the relative size of the objects in the simulation. The user defines the minimum width of the scale bar section (in pixels), along with a minimum and maximum height of the scale (also in pixels). The XMS application adds a "Units" label (meters in the image shown below) and labels for the model distance related to the scale divisions.<br />
<br />
[[Image:Scale.jpg|border|150px]]<br />
<br />
The XMS applications will compute a well conditioned number to use as the scale increment that fits in the specified scale bar extents.<br />
<br />
Attributes of the scale bar include:<br />
* General anchoring attributes.<br />
* The minimum spacing between distance labels.<br />
* The minimum division width (in pixels). The XMS application determines the number of divisions based on the minimum divisiion width and the width of the frame.<br />
* The minimum and maximum height of the scale bar object.<br />
* The font (style, color, size) used to label the scale bar.<br />
* Whether or not the area behind the scale bar will be filled, and if so, with what color.<br />
<br />
==North Arrows==<br />
[[Image:North-arrow.jpg|left|50 px]]<br />
<br />
North arrow objects consist of automatically rotating screen space images. When an XMS application is installed, at least one default North Arrow image will be included in the application's home directory. Users may create or download as many north arrow icons as desired. These icons are displayed at the specified location (anchored with the standard options), but will rotate as the view direction changes so that the "up" direction of the icon always aligns with the "North" or positive "Y" direction.<br />
<br />
Attributes of north arrows include:<br />
* See screen space image attributes.<br />
<br />
==Text==<br />
Text can be created in world or screen space layers.<br />
<br />
A user can enter text by clicking in the graphics window with the '''Create Text''' tool active.<br />
<br />
A user can set the following attributes for text:<br />
* Font &ndash; including size<br />
* Color<br />
* Background &ndash; fill behind with the background color or another color<br />
* Border and border thickness<br />
<br />
==Lines/Arrows==<br />
A user can create Lines/Arrows using the '''Create Line''' Tool. Lines/Arrows can be created in screen or world space layers.<br />
<br />
The attributes available for Lines/Arrows include:<br />
* Type &ndash; Dashed or solid w/ thickness<br />
* Color<br />
* Arrowheads &ndash; location (beginning, end, both) and size<br />
<br />
==Ovals==<br />
A user can create ovals by dragging a box with '''Create Oval''' tool active. Ovals can be created in world or screen space layers.<br />
<br />
The attributes that can be specified for ovals include:<br />
* Line type &ndash; dashed/solid with width<br />
* Line color<br />
* Fill and color or No Fill<br />
<br />
==Rectangles==<br />
Rectangles can be created in screen or world space layers. Their attributes are the same as those available for ovals.<br />
<br />
== Selection ==<br />
The first toolbar button is used to select and set attributes for annotation objects. This requires that objects exist to be selected. In this case when the user presses this tool and then left-click in the annotation object, the object frame will be drawn around the annotation. In addition to the frame, the XMS application displays grab handles on the corners and edges of the frame. The user modifies the rectangular shape of the annotation by dragging one of the grab handles and changes the position of the object by dragging the annotation (click at any point in the object interior).<br />
<br />
When this tool is active the right mouse button will pop up a menu of all dialogs for that particular type of annotation. This will include at least "Attributes" which will display a dialog of the objects attributes for editing.<br />
<br />
== Viewing Annotations At Specific Time Intervals ==<br />
<br />
Available in SMS 11.1 and in development for GMS, annotations can be setup to be viewed at specific time intervals. To setup annotations so they only are displayed at specified time intervals do the following:<br />
<br />
* Right-click on the Annotation layer in the tree then select ''Properties...''. <br />
* This dialog will display the ''Annotation Layer Properties'' dialog.<br />
* Check the ''Apply time range'' checkbox<br />
* Modify the "begin" and "end" time controls to specify the range for when annotations are visible.<br />
* Click '''Ok'''.<br />
<br />
Now film loops and time steps will only display the annotation when its within the range specified.<br />
<br />
==See also==<br />
* [[GMS:GMS|GMS]]<br />
* [[SMS:SMS|SMS]]<br />
* [http://www.xmswiki.com/index.php?title=SMS:Layout Layout of the Graphical Interface]<br />
<br />
[[Category:GMS Models]]<br />
[[Category:SMS Models]]<br />
[[Category:WMS Models]]<br />
[[Category:Numerical Models|A]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=Annotations&diff=86843Annotations2015-05-21T15:21:09Z<p>Morelandtom: /* Annotation Objects */</p>
<hr />
<div>{{TOCright}}<br />
==Annotation Objects==<br />
The GMS and SMS applications contain tools to annotate the data in an application for presentations, animations and screen shots.<br />
<br />
These tools (annotation objects)are accessed through the Annotations Module and include:<br />
* Images<br />
* North Arrows<br />
* Scale Bars<br />
* Text<br />
* Lines<br />
* Ovals<br />
* Rectangles<br />
<br />
==Screen vs World Space Layers==<br />
All annotation layers either contain objects referenced to world or screen coordinates. Objects referenced to world coordinates will change size and position on the screen with the underlying data. This is useful to identify specific locations in the model such as peir locations. Objects associated with screen coordinates do not move on the screen with the underlying data. This is useful for titles, legends such as north arrows and scale bars, and logos. Some types of annotations can only be created in screen space layers including North Arrows, Images, and scale bars.<br />
<br />
With the first annotation object created, could be part of a screen or world space layer, SMS will ask which type of layer the user wishes to create and add the object to. The user can create additional layers by right-clicking on the ''Annotation Data tree'' item and selecting '''Create Screen Space Layer''' or '''Create World Space Layer'''. Layers are differentiated by including an 'S' for screen space layers or 'W' for world space layers in their icons in the project explorer.<br />
<br />
If multiple layers exist, any newly created annotation object will be placed in the "current" layer.<br />
<br />
[[Image:AnnotationTree.jpg|border]]<br />
<br />
==Annotation Object Attributes==<br />
The extents of annotation objects defined by a frame. The user defines this frame initially when creating the annotation object by left-clicking at any point on the screen and dragging a rectangle with the mouse (left button still down). The display will show the frame while dragging with the mouse. (Points and lines defining degenerate frames are not allowed.) <br />
<br />
When the user creates a annotation, if the frame is too big for the window, it will be resized appropriately. Annotations can't be resized or moved even partially outside of the borders of the window. If the user resizes a annotation through a quick mouse drag and the cursor lands outside the window, the annotation will be redrawn to take up all the window space in that direction. <br />
<br />
This frame bounds the region of the screen where the object will appear with the modeling data. The user interacts with the object by interacting with its frame and specifying its attributes or properties (see the section on selection below). The frame anchors the annotation object on the screen. This anchoring defines both the size and position of the object. The x-location, y-location, x-size and y-size are all defined independently as either a pixel value or percentage of the screen. <br />
<br />
Horizontally, the user can position the left edge, the right edge or the center of the object. If the user positions the left edge, the object position is defined relative to the left edge of the screen. If the user positions the right edge, the object position is defined relative to the right edge of the screen. If the user positions the center of the object, the object position is defined relative to the horizontal center of the screen.<br />
<br />
For example, the left side of the frame may be specified as 100 pixels from the left edge of the screen. Alternatively, the user may specify that the right edge of the frame should be 10% of screen width from the right edge. Finally, the user may specify that the center of the object is 100 pixels to the right of the center of the screen.<br />
<br />
The vertical position and sizes of the object are similarly specified in the anchoring attribute of the object.<br />
<br />
All annotation objects also have attributes. The specific attributes depend on the type of object. The attributes define color, line thickness, fill properties, associated images, etc.<br />
<br />
==Screen Space Images==<br />
A screen space image is simply a graphics icon mapped to the screen. A typical application would be to display a company, department, or municipality logo next to the numeric model being displayed in the graphics window.<br />
<br />
Attributes of the screen space images include:<br />
* General anchoring attributes<br />
* The image file being displayed as part of the project<br />
* Whether the image is being displayed as a scaled (distorted object), scaled based on its original aspect ratio, or locked at another aspect ratio.<br />
* Transparency &ndash; The image properties dialog have a transparency checkbox. When checked it will cause the image to be redrawn with the most used color in the image. When that it is checked, it also causes the color checkbox and the tolerance edit field to become available. If the color checkbox is checked, it will activate the color button and the color button will have the latest chosen image color painted on it or the most used color in the image, if it has not been activated before. Clicking on the down arrow part of the color button causes a color popup to be displayed with swaths of the 40 most used colors in the image or all the colors in the image, if the image has less than 40 colors. Clicking on one of those colors will cause the image to be redrawn with that color made transparent in the image. The tolerance edit field allows for variation in the matching of the red, green and blue components. The tolerance field ranges in allowable values from 0.0 to 1.0. 0.0 means the red, green and blue components must exactly match. Values higher than 0.0 indicate the degree of variation from the given color. Clicking the transparency checkbox to the off state causes the image to be redrawn with no transparency.<br />
<br />
==Scale Bars==<br />
A scale bar occupies a fixed size of the screen to display the relative size of the objects in the simulation. The user defines the minimum width of the scale bar section (in pixels), along with a minimum and maximum height of the scale (also in pixels). The XMS application adds a "Units" label (meters in the image shown below) and labels for the model distance related to the scale divisions.<br />
<br />
[[Image:Scale.jpg|border|150px]]<br />
<br />
The XMS applications will compute a well conditioned number to use as the scale increment that fits in the specified scale bar extents.<br />
<br />
Attributes of the scale bar include:<br />
* General anchoring attributes.<br />
* The minimum spacing between distance labels.<br />
* The minimum division width (in pixels). The XMS application determines the number of divisions based on the minimum divisiion width and the width of the frame.<br />
* The minimum and maximum height of the scale bar object.<br />
* The font (style, color, size) used to label the scale bar.<br />
* Whether or not the area behind the scale bar will be filled, and if so, with what color.<br />
<br />
==North Arrows==<br />
[[Image:North-arrow.jpg|left|50 px]]<br />
<br />
North arrow objects consist of automatically rotating screen space images. When an XMS application is installed, at least one default North Arrow image will be included in the application's home directory. Users may create or download as many north arrow icons as desired. These icons are displayed at the specified location (anchored with the standard options), but will rotate as the view direction changes so that the "up" direction of the icon always aligns with the "North" or positive "Y" direction.<br />
<br />
Attributes of north arrows include:<br />
* See screen space image attributes.<br />
<br />
==Text==<br />
Text can be created in world or screen space layers.<br />
<br />
A user can enter text by clicking in the graphics window with the '''Create Text''' tool active.<br />
<br />
A user can set the following attributes for text:<br />
* Font &ndash; including size<br />
* Color<br />
* Background &ndash; fill behind with the background color or another color<br />
* Border and border thickness<br />
<br />
==Lines/Arrows==<br />
A user can create Lines/Arrows using the '''Create Line''' Tool. Lines/Arrows can be created in screen or world space layers.<br />
<br />
The attributes available for Lines/Arrows include:<br />
* Type &ndash; Dashed or solid w/ thickness<br />
* Color<br />
* Arrowheads &ndash; location (beginning, end, both) and size<br />
<br />
==Ovals==<br />
A user can create ovals by dragging a box with '''Create Oval''' tool active. Ovals can be created in world or screen space layers.<br />
<br />
The attributes that can be specified for ovals include:<br />
* Line type &ndash; dashed/solid with width<br />
* Line color<br />
* Fill and color or No Fill<br />
<br />
==Rectangles==<br />
Rectangles can be created in screen or world space layers. Their attributes are the same as those available for ovals.<br />
<br />
== Selection ==<br />
The first toolbar button is used to select and set attributes for annotation objects. This requires that objects exist to be selected. In this case when the user presses this tool and then left-click in the annotation object, the object frame will be drawn around the annotation. In addition to the frame, the XMS application displays grab handles on the corners and edges of the frame. The user modifies the rectangular shape of the annotation by dragging one of the grab handles and changes the position of the object by dragging the annotation (click at any point in the object interior).<br />
<br />
When this tool is active the right mouse button will pop up a menu of all dialogs for that particular type of annotation. This will include at least "Attributes" which will display a dialog of the objects attributes for editing.<br />
<br />
== Viewing Annotations At Specific Time Intervals ==<br />
<br />
Available in SMS 11.1 and in development for GMS, annotations can be setup to be viewed at specific time intervals. To setup annotations so they only are displayed at specified time intervals do the following:<br />
<br />
* Right-click on the Annotation layer in the tree then select ''Properties...''. <br />
* This dialog will display the ''Annotation Layer Properties'' dialog.<br />
* Check the ''Apply time range'' checkbox<br />
* Modify the "begin" and "end" time controls to specify the range for when annotations are visible.<br />
* Click '''Ok'''.<br />
<br />
Now film loops and time steps will only display the annotation when its within the range specified.<br />
<br />
==See also==<br />
* [[GMS:GMS|GMS]]<br />
* [[SMS:SMS|SMS]]<br />
* [http://www.xmswiki.com/index.php?title=SMS:Layout Layout of the Graphical Interface]<br />
<br />
[[Category:GMS Models]]<br />
[[Category:SMS Models]]<br />
[[Category:WMS Models]]<br />
[[Category:Numerical Models|A]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:2D_Mesh_Files_*.2dm&diff=85181SMS:2D Mesh Files *.2dm2015-04-15T15:05:15Z<p>Morelandtom: /* Global Parameters */</p>
<hr />
<div>{{TOCright}}<br />
A finite element mesh can be saved in a generic format defined by SMS, called the 2dm format. In addition, the Generic Model interface in the Mesh module uses this format to save a template definition, in addition to model parameter, material property, and boundary condition assignments for a specific simulation. When a *.2dm file is opened, the Current Numerical Model changes to the Generic Mesh Interface. To save a numerical model definition as a template file, a user should first set up the template and save a *.2dm file before any nodes are created.<br />
<br />
= Mesh Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!MESH2D<br />
|-<br />
!Description<br />
|Identifies the file as a 2d mesh file. Must be the first line of the file.<br />
|-<br />
!Required<br />
|YES<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!colspan="3" | NUM_MATERIALS_PER_ELEM<br />
|-<br />
!Description<br />
|colspan="3" |Defines Number of Materials per Element<br />
|-<br />
!Required<br />
|colspan="3" |YES<br />
|-<br />
!Format <br />
|colspan="3" |MATERIALS Quantity<br />
|-<br />
!Sample<br />
|colspan="3" |NUM_MATERIALS_PER_ELEM 2 <br />
|-<br />
!width="100" | Field<br />
!width="100" | Variable<br />
!width="100" | Value<br />
!width="450" | Description<br />
|-<br />
|1||Quantity ||+ integer ||Number of Materials <br />
|}<br />
<br />
== Nodes ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|ND<br />
|-<br />
!Description<br />
|Colspan="3"|Defines the ID and location for each node of the mesh.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|ND id x y z<br />
|-<br />
!Sample<br />
|Colspan="3"|ND 1 7.75e+005 1.10e+005 5.00e-001<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the node.<br />
|-<br />
|2-4<br />
|x,y,z<br />
|&#177; real number<br />
|The x, y, and z coordinates of the point.<br />
|}<br />
<br />
== Linear Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E2L<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 2-noded linear element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E2L id n<sub>1</sub> n<sub>2</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E2L 1 1 2 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 3<br />
|n<sub>1</sub> - n<sub>2</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|4<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E3L<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 3-noded linear element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E3L id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E3L 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 4<br />
|n<sub>1</sub> - n<sub>3</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|5<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Triangular Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E3T<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 3-noded triangular element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E3T id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E3T 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 4<br />
|n<sub>1</sub> - n<sub>3</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|5<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E6T<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 6-noded triangular element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E6T id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E6T 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 7<br />
|n<sub>1</sub> - n<sub>6</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|8<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Quadrilateral Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E4Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 4-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E4Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E4Q 1 1 2 3 4 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 5<br />
|n<sub>1</sub> - n<sub>4</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|6<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E8Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies an 8-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E8Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> n<sub>7</sub> n<sub>8</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E8Q 1 1 2 3 4 5 6 7 8 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 9<br />
|n<sub>1</sub> - n<sub>8</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|10<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E9Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies an 9-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E9Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> n<sub>7</sub> n<sub>8</sub> n<sub>9</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E9Q 1 1 2 3 4 5 6 7 8 9 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 10<br />
|n<sub>1</sub> - n<sub>9</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|11<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Nodestrings ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|NS<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a nodestring.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|NS n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> ... - n<sub>n</sub> (number of nodes in nodestring)<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
{|border="0"<br />
|<pre><br />
NS 1 3 10 15 6 -2<br />
NS 126 127 128 129 173 -194<br />
NS 1006 988 987 989 968 948 931 930 929 906<br />
NS -904<br />
NS 720 701 699 686 680 664 649 648 647 640<br />
NS -621<br />
</pre><br />
|}<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|n<sub>1</sub> - n<sub>n</sub> (number of nodes in nodestring)<br />
|n<sub>x</sub><br />
| + integer<br />
|The ID's of the nodes in the nodestring. The last node id is written as a negative number, thus signaling the nodestring's end. Multiple NS cards can be used on consecutive lines for a single nodestring.<br />
|}<br />
<br />
= Model Parameter Definition Cards =<br />
The model control parameters, boundary conditions and material options available for a specific model are defined in the generic model parameter definition section of the 2D mesh file. The generic model parameter definition section is begun by specifying the '''BEGPARAMDEF''' card and ended with the '''ENDPARAMDEF''' card.<br />
<br />
Starting with SMS version 11.0, all of the parameter cards follow a similar pattern and the available options for several of the types of parameters were increased.<br />
The pattern is similar for Global Parameters, '''GP''', Bondary Conditions '''BC''', and Materials '''MAT'''. More information can be found in each individual card.<br />
<br />
{|class="wikitable"<br />
|-<br />
!width="130"|Global Parameters<br />
!width="130"|Boundary Conditions<br />
!width="130"|Materials<br />
!width="100"|Description<br />
|-<br />
|GP||BC||MAT||Name,Id<br />
|-<br />
|GP_DEF||BC_DEF||MAT_DEF||definitions<br />
|-<br />
|GP_OPTS||BC_OPTS||MAT_OPTS||options<br />
|-<br />
|GP_VAL||BC_VAL||MAT_VAL||values<br />
|-<br />
|(parent, so it has no dependencies)||BC_DEP||MAT_DEP||dependencies<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''BEGPARAMDEF'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the model parameter definition section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|Required if model parameters are to be defined.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''ENDPARAMDEF'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the model parameter definition section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|Required if model parameters are to be defined.<br />
|}<br />
<br />
= Global Parameters =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''GM'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model name.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GM name<br />
|-<br />
!Sample<br />
|Colspan="3"|GM "Gen2DM"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|name<br />
|string<br />
|Model name.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''SI'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model units.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|SI val<br />
|-<br />
!Sample<br />
|Colspan="3"|SI 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* Enter 0 for Meters<br />
* Enter 1 for U.S. Survey Feet<br />
* Enter 2 for Geographic (Lat/Lon)<br />
* Enter 3 for International Feet<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''DY'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies whether the model is dynamic or steady state.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|DY val<br />
|-<br />
!Sample<br />
|Colspan="3"|DY 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* Enter 0 for steady state.<br />
* Enter 1 for dynamic.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''TU'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model time units.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|TU val<br />
|-<br />
!Sample<br />
|Colspan="3"|TU seconds<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|string<br />
|A string value describing the model units (days, hours, minutes, seconds, etc.).<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''TD'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model time step and total simulation time.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|TD time_step total_time<br />
|-<br />
!Sample<br />
|Colspan="3"|TD 20 1000<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|time_step<br />
| + real number<br />
|Time step (for dynamic simulations).<br />
|-<br />
|1<br />
|total_time<br />
| + real number<br />
|Total simulation run time (for dynamic simulations).<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''KEY'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the key to unlock and edit the model definition inside of the SMS interface.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|KEY key<br />
|-<br />
!Sample<br />
|Colspan="3"|KEY "sms-gen2dm"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|key<br />
|string<br />
|Case sensitive key to unlock and edit the model definition.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|<br />
*'''DISP_OPTS entity'''<br />
*'''DISP_OPTS inactive'''<br />
*'''DISP_OPTS multiple'''<br />
|-<br />
!Description<br />
|Colspan="3"|How a specific display option to the user.. colors, line thickness, etc.<br />
*'''entity''' &ndash; the main attribute (will either be the node, element, or nodestring display option)<br />
*'''inactive''' &ndash; display option for inactive or unassigned <br />
*'''multiple''' &ndash; display option for multiple assigned<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|DISP_OPTS EntityId Red Green Blue Display Pattern Width Style<br />
|-<br />
!Sample<br />
|Colspan="3"|DISP_OPTS entity 1 0 0 0 1 0 1 0<br />
|-<br />
!Sample<br />
|Colspan="3"|DISP_OPTS multiple 1 0 0 0 1 0 1 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="130"|Value<br />
!width="420"|Description<br />
|-<br />
|1|||EnitityId||integer (0-2)<br />
*0 = node<br />
*1 = nodestring<br />
*2 = element<br />
|id of the group it belongs too.<br />
|-<br />
|2||Red||integer (0-255)||red pixels<br />
|-<br />
|3||Green||integer (0-255)||green pixels<br />
|-<br />
|4||Blue||integer (0-255)||blue pixels<br />
|-<br />
|5||Display||boolean (0,1)||turned on = 1, turned off = 0<br />
|-<br />
|6||Pattern||integer||display pattern<br />
|-<br />
|7||Width||integer||width<br />
|-<br />
|8||Style||integer||style pattern<br />
|}<br />
<br />
== Global Parameter Assignment Cards ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP<br />
|-<br />
!Description<br />
|Colspan="3"|Defines a Global Parameter Group<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP Id Name Active<br />
|-<br />
!Sample<br />
|Colspan="3"|GP 1 "Hydro" 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
|+ integer<br />
|id<br />
|-<br />
|2<br />
|name<br />
|string<br />
|name<br />
|-<br />
|3<br />
|active<br />
|boolean<br />
|<br />
*0 = inactive<br />
*1 = active<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameter Defaults<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : GP_DEF GroupId ParamId Name Type Default Min Max <br />
curve: GP_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: GP_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_titleGP param_name val<br />
|-<br />
!Sample<br />
|Colspan="3"|Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : GP_DEF 1 1 "manning n" 1 0 0 10 <br />
<br />
curve: GP_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: GP_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="120"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|param Id<br />
|string<br />
|its id<br />
|-<br />
|3<br />
|name<br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve<br />
|-<br />
|5<br />
|<br />
*default <br />
*or x_axis_title (curve)<br />
|<br />
*type specific ()<br />
*string<br />
|<br />
*default value <br />
*x-axis title when bringing up curve editor<br />
|-<br />
|6<br />
|<br />
*min or<br />
*y_axis_title (curve)<br />
|<br />
*type specific (min)<br />
*string<br />
|<br />
*minimum value <br />
*y-axis title when bringing up curve editor<br />
|-<br />
|7<br />
|max <br />
|type specific (max)<br />
|max value <br />
|-<br />
|8<br />
(only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9<br />
(only float/curve)<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10<br />
(only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_VAL<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameters values<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP_VAL GroupId ParamId (CURVE or FLOAT only if type is float/curve) Value<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_VAL 1 1 30.23<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_VAL 1 2 "Manning"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Value<br />
|varies depending on type<br />
|value<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameters dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Type<br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent<br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|Parent Active<br />
|boolean<br />
|<br />
*0 = inactive<br />
*1 = active<br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off<br />
|}<br />
<br />
= Boundary Condition Definition Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BCPGC<br />
|-<br />
!Description<br />
|Colspan="3"|Defines whether or not to allow boundary condition / parameter group correlation.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BCPGC val<br />
|-<br />
!Sample<br />
|Colspan="3"|BCPGC 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* 0 = Do not allow boundary condition / parameter group correlation.<br />
* 1 = Allow boundary condition / parameter group correlation.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEDISP<br />
|-<br />
!Description<br />
|Colspan="3"|Defines inactive boundary condition display options and boundary condition label options.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEDISP entity_ID font_red font_green font_blue label_on label_vals_on inactive_size inactive_style inactive_red inactive_green inactive_blue inactive_on<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
BEDISP 0 2 0 0 0 1 1 1 255 128 255 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|font_red<br />
|integer<br />
|0 - 255, Red component of RGB triplet defining boundary condition font color.<br />
|-<br />
|3<br />
|font_green<br />
|integer<br />
|0 - 255, Green component of RGB triplet defining boundary condition font color.<br />
|-<br />
|4<br />
|font_blue<br />
|integer<br />
|0 - 255, Blue component of RGB triplet defining boundary condition font color.<br />
|-<br />
|5<br />
|label_on<br />
| boolean<br />
|<br />
* 0 = Do not display boundary condition labels.<br />
* 1 = Display boundary condition labels.<br />
|-<br />
|6<br />
|label_vals_on<br />
|boolean<br />
|<br />
* 0 = Do not display boundary condition values in boundary condition labels.<br />
* 1 = Display boundary condition values in boundary condition labels.<br />
|-<br />
|7<br />
|inactive_size<br />
|integer<br />
|<br />
* 1 - 63, Default size for inactive boundary condition node symbols.<br />
* 1 - 50, Default size for inactive boundary condition element or nodestring symbols.<br />
|-<br />
|8<br />
|inactive_style<br />
|integer<br />
|<br />
* Default style for inactive boundary condition symbols.<br />
* For nodes<br />
<blockquote><br />
* 1 = Filled square<br />
* 2 = Hollow square<br />
* 3 = Filled circle<br />
* 4 = Hollow circle<br />
* 5 = Filled triangle<br />
* 6 = Hollow triangle<br />
* 7 = Filled diamond<br />
* 8 = Hollow diamond<br />
* 9 = Cross<br />
* 10 = X<br />
* 11 = Survey marker<br />
</blockquote><br />
* For elements or nodestrings:<br />
<blockquote><br />
* 0 = solid line<br />
* 1 = dashed line<br />
</blockquote><br />
|-<br />
|9<br />
|inactive_red<br />
|integer<br />
|0 - 255, Red component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|10<br />
|inactive_green<br />
|integer<br />
|0 - 255, Green component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|11<br />
|inactive_blue<br />
|integer<br />
|0 - 255, Blue component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|12<br />
|inactive_on<br />
|boolean<br />
|<br />
* 0 = Do not display inactive boundary conditions.<br />
* 1 = Display inactive boundary conditions.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!BEFONT<br />
|colspan="2"|Single integer method.<br />
|-<br />
!Description<br />
|Colspan="3"|Defines boundary condition label font attributes.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEFONT entity_id font_size<br />
|-<br />
!Sample<br />
|Colspan="3"|BEFONT 1 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|font_size<br />
|integer<br />
|<br />
* 1 = Large font size.<br />
* 2 = Small font size.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!BEFONT<br />
|colspan="2"|Multiple value method.<br />
|-<br />
!Description<br />
|Colspan="3"|Defines boundary condition label font attributes.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEFONT entity_id height width escapement orientation weight italic underline strikeout charSet precision clipPrecision quality pitchAndFamily faceName<br />
|-<br />
!Sample<br />
|Colspan="3"|BEFONT 1 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|height<br />
|integer<br />
|Font height.<br />
|-<br />
|3<br />
|width<br />
|integer<br />
|Font width.<br />
|-<br />
|4<br />
|escapement<br />
|integer<br />
|Font escapement.<br />
|-<br />
|5<br />
|orientation<br />
|integer<br />
|Font orientation.<br />
|-<br />
|6<br />
|weight<br />
|integer<br />
|Font weight.<br />
|-<br />
|7<br />
|italic<br />
|integer<br />
|Font italic.<br />
|-<br />
|8<br />
|underline<br />
|integer<br />
|Font underline.<br />
|-<br />
|9<br />
|strikeout<br />
|integer<br />
|Font strikeout.<br />
|-<br />
|10<br />
|charSet<br />
|integer<br />
|Font character set.<br />
|-<br />
|11<br />
|precision<br />
|integer<br />
|Font precision.<br />
|-<br />
|12<br />
|clipPrecision<br />
|integer<br />
|Font clip precision.<br />
|-<br />
|13<br />
|quality<br />
|integer<br />
|Font quality.<br />
|-<br />
|14<br />
|pitchAndFamily<br />
|integer<br />
|Font pitch and family.<br />
|-<br />
|15<br />
|faceName<br />
|string<br />
|Font face name.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DISP_OPTS <br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition display options (how the boundary conditions are going to be displayed to the user)<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_DISP_OPTS GroupId Red Green Blue Display Pattern Width Style<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_DISP_OPTS 1 0 0 0 0 0 0 0 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|Red<br />
|integer (0-255)<br />
|red pixels<br />
|-<br />
|3<br />
|Green<br />
|integer (0-255)<br />
|green pixels<br />
|-<br />
|4<br />
|Blue <br />
|integer (0-255)<br />
|blue pixels<br />
|-<br />
|5<br />
|Display <br />
|boolean (0,1)<br />
|turned on = 1, turned off = 0<br />
|-<br />
|6<br />
|Pattern<br />
|integer<br />
|displayed pattern<br />
|-<br />
|7<br />
|Width<br />
|integer<br />
|width<br />
|-<br />
|8<br />
|Style<br />
|integer<br />
|style pattern<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEG2DMBC <br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the boundary condition assignment section of the 2D Mesh File. <br />
|-<br />
!Required<br />
|Colspan="3"|Required if boundary conditions are assigned.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|END2DMBC <br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the boundary condition assignment section of the 2D Mesh File. <br />
|-<br />
!Required<br />
|Colspan="3"|Required if boundary conditions are assigned.<br />
|}<br />
<br />
== Boundary Condition Assignment Cards ==<br />
The following cards are used to assign values to the boundary conditions defined in using '''Boundary Condition Definition Cards''':<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC<br />
|-<br />
!Description<br />
|Colspan="3"|Defines input values required for a boundary condition. <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC EntityId Name Id 0 LegalOnInterior ParamGroupCorrelation<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
*BC 1 "Flow rate (cfs)" 1 0 1 "(none)"<br />
*BC 1 "Water temperature (F)" 2 0 "Hydrodynamic"<br />
*BC 1 "Flow rate(cfs)" 3 0 1 "(none)"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity id<br />
|integer<br />
|Entity id that the bc belongs to (NODE = 0, NDSTR =1, ELEM = 2<br />
|-<br />
|2<br />
|name <br />
|string<br />
|Name of value to be specified.<br />
|-<br />
|3<br />
|id <br />
|integer<br />
|The boundary conditions id.<br />
|-<br />
|4<br />
|filler<br />
|0<br />
|Always 0<br />
|-<br />
|5<br />
|legalOnInterior<br />
|boolean<br />
|<br />
*0 = boundary condition is not legal on the interior of the mesh.<br />
*1 = boundary condition is legal on the interior of the mesh.<br />
|-<br />
|6<br />
|paramGroupCorrelation<br />
|string<br />
|Name of the parameter group (defined using the GP card) with which the boundary condition is correlated. If the boundary condition is not correlated with a parameter group, "none" should be specified.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition Parameter Defaults <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : BC_DEF GroupId ParamId Name Type Default Min Max <br />
<br />
curve: BC_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: BC_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_title<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : BC_DEF 1 1 "manning n" 1 0 0 10 <br />
<br />
curve: BC_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: BC_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="120"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer<br />
|id of the boundary condition group that it belongs too<br />
|-<br />
|2<br />
|param Id <br />
|string<br />
|its id<br />
|-<br />
|3<br />
|name <br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve<br />
|-<br />
|5<br />
|default or<br />
<br />
<br />
x_axis_title (curve)<br />
|type specific <br />
<br />
<br />
string<br />
|default value <br />
<br />
<br />
x-axis title when bringing up curve editor<br />
|-<br />
|6<br />
|min or<br />
<br />
<br />
y_axis_title (curve)<br />
|type specific (min)<br />
<br />
<br />
string <br />
|minimum value<br />
<br />
<br />
y-axis title when bringing up curve editor<br />
|-<br />
|7<br />
|max<br />
|type specific (max)<br />
|max value<br />
|-<br />
|8 (only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9 (only float/curve<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10 (only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_OPTS<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition options <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_OPTS GroupId, ParamId, Values<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_OPTS 1 5 "a" "b" "c"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer<br />
|id of the boundary condition group that it belongs too<br />
|-<br />
|2<br />
|param Id <br />
|string<br />
|its id<br />
|-<br />
|3<br />
|values <br />
|string<br />
| <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_VAL<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition values <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_VAL N, E, S (Node, Elem or nodeString) Node or Elem Id, GroupId, ParamId, (CURVE or FLOAT only if type is float/curve) Value<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 2<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 CURVE 2<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 FLOAT 7.675<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|N, E or S <br />
| + integer<br />
|Node, Elem or Nodestring<br />
|-<br />
|2<br />
|Node, Elem, or Nodestring Id <br />
| + integer<br />
|id of the node/element<br />
|-<br />
|3<br />
|group Id <br />
| + integer<br />
|id of the group it belongs too<br />
|-<br />
|4<br />
|param Id<br />
| + integer<br />
|id of the parameter it belongs too<br />
|-<br />
|5<br />
|value<br />
|varies depending on type <br />
|value <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer<br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Type <br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent <br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|Parent Active<br />
|boolean <br />
|<br />
*0 = inactive<br />
*1 = active <br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off <br />
|}<br />
<br />
= Material Properties Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_MULTI<br />
|-<br />
!Description<br />
|Colspan="3"|Is Material Assignment Multiple<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_MULTI Assigned<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_MULTI 1<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_MULTI 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|assigned<br />
|boolean<br />
|0- Single, 1 - Multiple<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_PARAMS<br />
|-<br />
!Description<br />
|Colspan="3"|Material Parameters Assigned<br />
|-<br />
!Required<br />
|Colspan="3"|NOT NEEDED IF MAT_MULTI 0 <br />
|-<br />
!Format<br />
|Colspan="3"|MAT_PARAMS MaterialId, GroupId (1 or More)<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_PARAMS 1 2 3 5 <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_PARAMS 1 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Material Id <br />
| + integer<br />
|id of the material<br />
|-<br />
|2<br />
|Group id<br />
| + integer<br />
|id of the assigned group<br />
|}<br />
<br />
== Material Properties Assignment Cards ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT<br />
|-<br />
!Description<br />
|Colspan="3"|Defines the assigned material properties.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT ID "name"<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT 1 "Clay"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|mat_ID<br />
| + integer<br />
|Material id (sequentially numbered, starting at 1). The disabled material is always id 0 and does not need to be specified in the 2dm file.<br />
|-<br />
|2<br />
|name<br />
|string<br />
|The name of the material. Should be unique.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Material Parameters defaults<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : MAT_DEF GroupId ParamId Name Type Default Min Max <br />
<br />
curve: MAT_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: MAT_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_title<br />
|-<br />
!Sample<br />
|Colspan="3"|Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : MAT_DEF 1 1 "manning n" 1 0 0 10<br />
<br />
curve: MAT_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: MAT_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|group id<br />
| + integer<br />
| id of the Material Group that it belongs too. <br />
|-<br />
|2<br />
|param id<br />
|string<br />
|its id <br />
|-<br />
|3<br />
|name<br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve <br />
|-<br />
|5<br />
|default or<br />
<br />
<br />
x-axis_title (curve)<br />
|type specific <br />
<br />
<br />
string<br />
|default value<br />
<br />
<br />
x-axis title when bringing up curve editor <br />
|-<br />
|6<br />
|min or<br />
<br />
<br />
y-axis_title (curve)<br />
|type specific (min) <br />
<br />
<br />
string<br />
|minimum value<br />
<br />
<br />
y-axis title when bringing up curve editor <br />
|-<br />
|7<br />
|max<br />
|type specific (max) <br />
|max value <br />
|-<br />
|8 <br />
(only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9<br />
(only float/curve)<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10 <br />
(only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_OPTS<br />
|-<br />
!Description<br />
|Colspan="3"|Material options<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_OPTS GroupId, ParamId, Values <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_OPTS 1 5 "a" "b" "c" <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|group id<br />
| + integer<br />
|id of the Boundary Condition Group that it belongs too <br />
|-<br />
|2<br />
|param id<br />
| + integer<br />
|its id<br />
|- <br />
|3<br />
|values<br />
|string<br />
| <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_VALS<br />
|-<br />
!Description<br />
|Colspan="3"|Material values<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_VAL MaterialId, GroupId, ParamId, (CURVE or FLOAT only if type is float/curve) Value <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL S 1 1 2 2<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL 2 1 8 VALUE 8.8888 <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL 2 1 8 CURVE 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|material id <br />
| + integer<br />
|id of the material<br />
|-<br />
|2<br />
|group id<br />
| + integer<br />
|id of the group it belongs too<br />
|-<br />
|3<br />
|param id<br />
|string<br />
|id of the parameter it belongs too<br />
|-<br />
|4<br />
|VALUE or CURVE<br />
|string<br />
|Only if type is float/curve<br />
|-<br />
|5<br />
|value<br />
|varies depending on type<br />
|value<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Material dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|GroupId<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|ParamId <br />
| + integer <br />
|its id<br />
|-<br />
|3<br />
|Type<br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent <br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|ParentActive<br />
|boolean <br />
|<br />
*0 = inactive<br />
*1 = active<br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off<br />
|}<br />
<br />
= Time Series Data Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEGCURVE Version: version<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the time series data section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEGCURVE<br />
|-<br />
!Sample<br />
|Colspan="3"|BCE 2 2 300<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|version<br />
| + integer<br />
|Used to version file format for the curve portion of the file.<br />
|-<br />
!colspan="4"|Note: Version 1 writes the time series data using the [[SMS:XY Series Files|XY Series File, XYS Format]] within the 2D Mesh File. See [[SMS:XY Series Files|XY Series Files (*.xys)]] for a description of the cards used to define the time series data.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|ENDCURVE<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the time series data section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|NO<br />
|}<br />
<br />
= Obsolete Cards = <br />
The following cards are no longer used in SMS:<br />
<br />
PG, PD, PO, GG, GP, BD, BV, MD, MV, BCE, BCN, BCS, TIME, BEDISP<br />
<br />
= Changes from 10.1 to 11.0 =<br />
'''New Cards:'''<br />
*NUM_MATERIALS_PER_ELEM <br />
*GP replaces PG<br />
*GP_DEF replaces PD<br />
*GP_VAL <br />
*GP_DEP <br />
*BC replaces BD<br />
*BC_DEF replaces BV card<br />
*BC_OPTS replaces PO card<br />
*BC_VAL replaces BC card<br />
*BC_DEP <br />
*BC_DISP_OPTS replaces bedisp<br />
*MAT_MULTI <br />
*MAT_PARAMS <br />
*MAT_DEF replaces MV card<br />
*MAT_OPTS <br />
*MAT_VAL <br />
*MAT_DEP <br />
*DISP_OPTS entity <br />
*DISP_OPTS inactive <br />
*DISP_OPTS multiple<br />
<br />
= Sample File 1 = <br />
<pre><br />
BEGCURVE Version: 1<br />
XYS 1 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 3 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 5 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 7 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 9 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 11 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 13 8 "new_series"<br />
0.0 237.35<br />
24.0 137.9<br />
48.0 1347.4<br />
72.0 351.05<br />
96.0 1465.25<br />
120.0 1247.1<br />
144.0 847.35<br />
168.0 731.75<br />
XYS 14 8 "Curve"<br />
0.0 1600.7<br />
24.0 700.85<br />
48.0 1353.7<br />
72.0 712.25<br />
96.0 866.6<br />
120.0 1626.35<br />
144.0 567.6<br />
168.0 980.55<br />
XYS 15 8 "Curve"<br />
0.0 1240.7<br />
24.0 772.25<br />
48.0 741.3<br />
72.0 908.45<br />
96.0 599.45<br />
120.0 522.8<br />
144.0 946.8<br />
168.0 170.4<br />
XYS 16 8 "Curve"<br />
0.0 1252.55<br />
24.0 1467.95<br />
48.0 876.25<br />
72.0 250.2<br />
96.0 479.95<br />
120.0 981.65<br />
144.0 1432.4<br />
168.0 1382.8<br />
XYS 17 8 "Curve"<br />
0.0 1507.65<br />
24.0 202.6<br />
48.0 905.3<br />
72.0 1051.45<br />
96.0 434.95<br />
120.0 267.5<br />
144.0 547.95<br />
168.0 349.2<br />
ENDCURVE<br />
</pre><br />
<br />
= Sample File 2 =<br />
Sample files are available in the [[SMS:Tutorials|SMS tutorials]] in the Generic Mesh Model tutorial under the models section.<br />
<br />
<pre><br />
MESH2D<br />
E3T 1 4 1 3 2<br />
E3T 2 2 5 6 2<br />
E4Q 3 7 8 5 2 2<br />
.<br />
.<br />
.<br />
E4Q 1543 205 1226 1225 1221 2<br />
E4Q 1544 191 1222 1226 189 1<br />
E3T 1545 205 189 1226 2<br />
ND 1 -7.62907961e+001 4.00243909e+001 8.41808447e+001<br />
ND 2 -7.62907174e+001 4.00219296e+001 8.36614138e+001<br />
ND 3 -7.62907700e+001 4.00238340e+001 7.32122342e+001<br />
.<br />
.<br />
.<br />
ND 1222 -7.62811008e+001 4.00272795e+001 7.28898113e+001<br />
ND 1225 -7.62814608e+001 4.00273631e+001 7.29479847e+001<br />
ND 1226 -7.62812859e+001 4.00271526e+001 7.41231480e+001<br />
NS 1 3 10 15 6 -2<br />
NS 126 127 128 129 173 -194<br />
NS 1006 988 987 989 968 948 931 930 929 906<br />
NS -904<br />
NS 720 701 699 686 680 664 649 648 647 640<br />
NS -621<br />
BEGPARAMDEF<br />
GM "Gen2DM"<br />
SI 0<br />
DY 1<br />
TU "minutes"<br />
TD 20 1000<br />
KEY "sms-gen2dm"<br />
PG "Hydrodynamic" 1<br />
PD "Time interval" 1 20 0 2147483647<br />
PD "Velocity max (ft/sec)" 2 75 0 100<br />
PD "H min" 2 0.25 0 1.79769e+308<br />
PD "A min" 2 1 1e-015 1.79769e+308<br />
PD "Check for dry elements" 0 1<br />
PD "Element style" 3 "quadratic"<br />
PD "Critical scour velocity" 4 "2.0 ft/sec"<br />
PO "0.8 ft/sec" "2.0 ft/sec" "2.6 ft/sec"<br />
PG "Sediment transport" 0<br />
PD "Time interval" 1 10 0 2147483647<br />
PD "Source X postion" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Source Y position" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Source elevation" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Parcel mass (slug)" 2 0.5 0.0001 1.79769e+308<br />
PD "Particle mass (slug)" 2 0.003 0.0001 1.79769e+308<br />
PD "Particle size (in)" 2 0.05 0 1.79769e+308<br />
PD "Deviation" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Average density (slug/ft^3)" 2 3 1.5 6<br />
NUME 3<br />
BCPGC 1<br />
BEDISP 0 2 0 0 0 1 1 1 255 128 255 1<br />
BEFONT 0 1<br />
BD 0 "Water sink/source" 2 3 "Flow rate (cfs)" "Water temperature (F)" "Flow rate(cfs)" 1 "(none)"<br />
BV "Flow rate (cfs)" 0 -1.79769e+308 1.79769e+308<br />
BV "Water temperature (F)" 65 32.5 100<br />
BV "Flow rate(cfs)" 0 0 1.79769e+308<br />
BCDISP 0 2 10 1 0 255 255 1<br />
BD 0 "Ceiling (pressure flow)" 1 1 "Ceiling (ft above sea level)" 0 "(none)"<br />
BV "Ceiling (ft above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BCDISP 0 1 3 1 128 128 255 1<br />
BD 0 "Water surface observation gauge" 3 0 1 "(none)"<br />
BCDISP 0 3 3 1 255 128 128 1<br />
BEDISP 1 0 0 255 1 1 1 0 255 128 0 1<br />
BEFONT 1 1<br />
BD 1 "Water surface" 1 3 "Elevation" "Essential/Natural factor" "Vary along nodestring factor" 0 "(none)"<br />
BV "Elevation" 0 -1.79769e+308 1.79769e+308<br />
BV "Essential/Natural factor" 0 0 1<br />
BV "Vary along nodestring factor" 1 0 10<br />
BCDISP 1 1 5 0 255 0 0 1<br />
BD 1 "Flow" 2 1 "Flow rate (cfs)" 0 "(none)"<br />
BV "Flow rate (cfs)" 0 0 1.79769e+308<br />
BCDISP 1 2 5 0 128 255 0 1<br />
BD 1 "Supercritical" 3 0 0 "(none)"<br />
BCDISP 1 3 1 0 0 0 0 1<br />
BD 1 "1D weir segment" 4 4 "Discharge coefficient" "Weir width (ft)" "Crest level (m above sea level)" "Equation (0 = water level / 1 = energy head)" 1 "(none)"<br />
BV "Discharge coefficient" 1 0 1.79769e+308<br />
BV "Weir width (ft)" 1 0 1.79769e+308<br />
BV "Crest level (m above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BV "Equation (0 = water level / 1 = energy head)" 0 0 1<br />
BCDISP 1 4 1 0 0 0 0 0<br />
BD 1 "Sediment trap" 5 0 1 "Sediment transport"<br />
BCDISP 1 5 1 0 0 0 0 1<br />
BEDISP 2 2 0 0 0 1 1 0 0 0 0 1<br />
BEFONT 2 1<br />
BD 2 "2D weir" 1 3 "Discharge coefficient" "Crest level (ft above sea level)" "Equation (0 = water level / 1 = energy head)" 1 "(none)"<br />
BV "Discharge coefficient" 1 0 1.79769e+308<br />
BV "Crest level (ft above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BV "Equation (0 = water level / 1 = energy head)" 0 0 1<br />
BCDISP 2 1 1 0 0 0 0 1<br />
MD 2 "Manning" "Kinematic eddy viscosity"<br />
MV "Manning" 0.035 0.01 0.18<br />
MV "Kinematic eddy viscosity" 0 -1.79769e+308 1.79769e+308<br />
ENDPARAMDEF<br />
BEG2DMBC<br />
MAT 1 0.03 20<br />
MAT 2 0.045 20<br />
GG "Hydrodynamic"<br />
GP "Time interval" 20<br />
GP "Velocity max (ft/sec)" 75<br />
GP "H min" 0.25<br />
GP "A min" 1<br />
GP "Check for dry elements" 1<br />
GP "Element style" "quadratic"<br />
GP "Critical scour velocity" "2.0 ft/sec"<br />
GG "Sediment transport"<br />
GP "Time interval" 10<br />
GP "Source X postion" 0<br />
GP "Source Y position" 0<br />
GP "Source elevation" 0<br />
GP "Parcel mass (slug)" 0.5<br />
GP "Particle mass (slug)" 0.003<br />
GP "Particle size (in)" 0.05<br />
GP "Deviation" 0<br />
GP "Average density (slug/ft^3)" 3<br />
BCN 772 3<br />
BCN 774 3<br />
BCN 776 3<br />
.<br />
.<br />
.<br />
BCS 4 5<br />
BCS 1 1 80 0 1<br />
BCE 1293 1 1 0 0<br />
TIME 20<br />
BCS 2 2 380<br />
TIME 40<br />
BCS 2 2 400<br />
TIME 60<br />
BCS 2 2 380<br />
TIME 80<br />
BCS 2 2 300<br />
TIME 100<br />
BCS 2 2 300<br />
TIME 120<br />
BCS 2 2 300<br />
TIME 140<br />
BCS 2 2 300<br />
TIME 160<br />
BCS 2 2 300<br />
TIME 180<br />
BCS 2 2 300<br />
TIME 200<br />
BCS 2 2 300<br />
TIME 220<br />
BCS 2 2 300<br />
TIME 240<br />
BCS 2 2 300<br />
TIME 260<br />
BCS 2 2 300<br />
TIME 280<br />
BCS 2 2 300<br />
TIME 300<br />
BCS 2 2 300<br />
TIME 320<br />
BCS 2 2 300<br />
TIME 340<br />
BCS 2 2 300<br />
TIME 360<br />
BCS 2 2 300<br />
TIME 380<br />
BCS 2 2 300<br />
TIME 400<br />
BCS 2 2 300<br />
TIME 420<br />
BCS 2 2 300<br />
TIME 440<br />
BCS 2 2 300<br />
TIME 460<br />
BCS 2 2 300<br />
TIME 480<br />
BCS 2 2 300<br />
TIME 500<br />
BCS 2 2 300<br />
TIME 520<br />
BCS 2 2 300<br />
TIME 540<br />
BCS 2 2 300<br />
TIME 560<br />
BCS 2 2 300<br />
TIME 580<br />
BCS 2 2 300<br />
TIME 600<br />
BCS 2 2 300<br />
TIME 620<br />
BCS 2 2 300<br />
TIME 640<br />
BCS 2 2 300<br />
TIME 660<br />
BCS 2 2 300<br />
TIME 680<br />
BCS 2 2 300<br />
TIME 700<br />
BCS 2 2 300<br />
TIME 720<br />
BCS 2 2 300<br />
TIME 740<br />
BCS 2 2 300<br />
TIME 760<br />
BCS 2 2 300<br />
TIME 780<br />
BCS 2 2 300<br />
TIME 800<br />
BCS 2 2 300<br />
TIME 820<br />
BCS 2 2 300<br />
TIME 840<br />
BCS 2 2 300<br />
TIME 860<br />
BCS 2 2 300<br />
TIME 880<br />
BCS 2 2 300<br />
TIME 900<br />
BCS 2 2 300<br />
TIME 920<br />
BCS 2 2 300<br />
TIME 940<br />
BCS 2 2 300<br />
TIME 960<br />
BCS 2 2 300<br />
TIME 980<br />
BCS 2 2 300<br />
TIME 1000<br />
BCS 2 2 300<br />
END2DMBC<br />
</pre><br />
<br />
= Related Topics =<br />
* [[SMS:File Formats|File Formats]]<br />
* [[SMS:Generic_Model_Files|Generic Model Files]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]]<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|2]]<br />
[[Category:Generic Model|2]]<br />
[[Category:SMS File Formats|2]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:2D_Mesh_Files_*.2dm&diff=85180SMS:2D Mesh Files *.2dm2015-04-15T15:04:43Z<p>Morelandtom: /* Global Parameters */</p>
<hr />
<div>{{TOCright}}<br />
A finite element mesh can be saved in a generic format defined by SMS, called the 2dm format. In addition, the Generic Model interface in the Mesh module uses this format to save a template definition, in addition to model parameter, material property, and boundary condition assignments for a specific simulation. When a *.2dm file is opened, the Current Numerical Model changes to the Generic Mesh Interface. To save a numerical model definition as a template file, a user should first set up the template and save a *.2dm file before any nodes are created.<br />
<br />
= Mesh Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!MESH2D<br />
|-<br />
!Description<br />
|Identifies the file as a 2d mesh file. Must be the first line of the file.<br />
|-<br />
!Required<br />
|YES<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!colspan="3" | NUM_MATERIALS_PER_ELEM<br />
|-<br />
!Description<br />
|colspan="3" |Defines Number of Materials per Element<br />
|-<br />
!Required<br />
|colspan="3" |YES<br />
|-<br />
!Format <br />
|colspan="3" |MATERIALS Quantity<br />
|-<br />
!Sample<br />
|colspan="3" |NUM_MATERIALS_PER_ELEM 2 <br />
|-<br />
!width="100" | Field<br />
!width="100" | Variable<br />
!width="100" | Value<br />
!width="450" | Description<br />
|-<br />
|1||Quantity ||+ integer ||Number of Materials <br />
|}<br />
<br />
== Nodes ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|ND<br />
|-<br />
!Description<br />
|Colspan="3"|Defines the ID and location for each node of the mesh.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|ND id x y z<br />
|-<br />
!Sample<br />
|Colspan="3"|ND 1 7.75e+005 1.10e+005 5.00e-001<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the node.<br />
|-<br />
|2-4<br />
|x,y,z<br />
|&#177; real number<br />
|The x, y, and z coordinates of the point.<br />
|}<br />
<br />
== Linear Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E2L<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 2-noded linear element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E2L id n<sub>1</sub> n<sub>2</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E2L 1 1 2 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 3<br />
|n<sub>1</sub> - n<sub>2</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|4<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E3L<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 3-noded linear element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E3L id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E3L 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 4<br />
|n<sub>1</sub> - n<sub>3</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|5<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Triangular Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E3T<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 3-noded triangular element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E3T id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E3T 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 4<br />
|n<sub>1</sub> - n<sub>3</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|5<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E6T<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 6-noded triangular element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E6T id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E6T 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 7<br />
|n<sub>1</sub> - n<sub>6</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|8<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Quadrilateral Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E4Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 4-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E4Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E4Q 1 1 2 3 4 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 5<br />
|n<sub>1</sub> - n<sub>4</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|6<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E8Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies an 8-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E8Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> n<sub>7</sub> n<sub>8</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E8Q 1 1 2 3 4 5 6 7 8 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 9<br />
|n<sub>1</sub> - n<sub>8</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|10<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E9Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies an 9-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E9Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> n<sub>7</sub> n<sub>8</sub> n<sub>9</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E9Q 1 1 2 3 4 5 6 7 8 9 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 10<br />
|n<sub>1</sub> - n<sub>9</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|11<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Nodestrings ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|NS<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a nodestring.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|NS n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> ... - n<sub>n</sub> (number of nodes in nodestring)<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
{|border="0"<br />
|<pre><br />
NS 1 3 10 15 6 -2<br />
NS 126 127 128 129 173 -194<br />
NS 1006 988 987 989 968 948 931 930 929 906<br />
NS -904<br />
NS 720 701 699 686 680 664 649 648 647 640<br />
NS -621<br />
</pre><br />
|}<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|n<sub>1</sub> - n<sub>n</sub> (number of nodes in nodestring)<br />
|n<sub>x</sub><br />
| + integer<br />
|The ID's of the nodes in the nodestring. The last node id is written as a negative number, thus signaling the nodestring's end. Multiple NS cards can be used on consecutive lines for a single nodestring.<br />
|}<br />
<br />
= Model Parameter Definition Cards =<br />
The model control parameters, boundary conditions and material options available for a specific model are defined in the generic model parameter definition section of the 2D mesh file. The generic model parameter definition section is begun by specifying the '''BEGPARAMDEF''' card and ended with the '''ENDPARAMDEF''' card.<br />
<br />
Starting with SMS version 11.0, all of the parameter cards follow a similar pattern and the available options for several of the types of parameters were increased.<br />
The pattern is similar for Global Parameters, '''GP''', Bondary Conditions '''BC''', and Materials '''MAT'''. More information can be found in each individual card.<br />
<br />
{|class="wikitable"<br />
|-<br />
!width="130"|Global Parameters<br />
!width="130"|Boundary Conditions<br />
!width="130"|Materials<br />
!width="100"|Description<br />
|-<br />
|GP||BC||MAT||Name,Id<br />
|-<br />
|GP_DEF||BC_DEF||MAT_DEF||definitions<br />
|-<br />
|GP_OPTS||BC_OPTS||MAT_OPTS||options<br />
|-<br />
|GP_VAL||BC_VAL||MAT_VAL||values<br />
|-<br />
|(parent, so it has no dependencies)||BC_DEP||MAT_DEP||dependencies<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''BEGPARAMDEF'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the model parameter definition section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|Required if model parameters are to be defined.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''ENDPARAMDEF'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the model parameter definition section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|Required if model parameters are to be defined.<br />
|}<br />
<br />
= Global Parameters =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''GM'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model name.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GM name<br />
|-<br />
!Sample<br />
|Colspan="3"|GM "Gen2DM"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|name<br />
|string<br />
|Model name.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''SI'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model units.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|SI val<br />
|-<br />
!Sample<br />
|Colspan="3"|SI 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
* Enter 0 for Meters<br />
* Enter 1 for U.S. Survey Feet<br />
* Enter 2 for Geographic (Lat/Lon)<br />
* Enter 3 for International Feet<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''DY'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies whether the model is dynamic or steady state.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|DY val<br />
|-<br />
!Sample<br />
|Colspan="3"|DY 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* Enter 0 for steady state.<br />
* Enter 1 for dynamic.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''TU'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model time units.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|TU val<br />
|-<br />
!Sample<br />
|Colspan="3"|TU seconds<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|string<br />
|A string value describing the model units (days, hours, minutes, seconds, etc.).<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''TD'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model time step and total simulation time.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|TD time_step total_time<br />
|-<br />
!Sample<br />
|Colspan="3"|TD 20 1000<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|time_step<br />
| + real number<br />
|Time step (for dynamic simulations).<br />
|-<br />
|1<br />
|total_time<br />
| + real number<br />
|Total simulation run time (for dynamic simulations).<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''KEY'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the key to unlock and edit the model definition inside of the SMS interface.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|KEY key<br />
|-<br />
!Sample<br />
|Colspan="3"|KEY "sms-gen2dm"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|key<br />
|string<br />
|Case sensitive key to unlock and edit the model definition.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|<br />
*'''DISP_OPTS entity'''<br />
*'''DISP_OPTS inactive'''<br />
*'''DISP_OPTS multiple'''<br />
|-<br />
!Description<br />
|Colspan="3"|How a specific display option to the user.. colors, line thickness, etc.<br />
*'''entity''' &ndash; the main attribute (will either be the node, element, or nodestring display option)<br />
*'''inactive''' &ndash; display option for inactive or unassigned <br />
*'''multiple''' &ndash; display option for multiple assigned<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|DISP_OPTS EntityId Red Green Blue Display Pattern Width Style<br />
|-<br />
!Sample<br />
|Colspan="3"|DISP_OPTS entity 1 0 0 0 1 0 1 0<br />
|-<br />
!Sample<br />
|Colspan="3"|DISP_OPTS multiple 1 0 0 0 1 0 1 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="130"|Value<br />
!width="420"|Description<br />
|-<br />
|1|||EnitityId||integer (0-2)<br />
*0 = node<br />
*1 = nodestring<br />
*2 = element<br />
|id of the group it belongs too.<br />
|-<br />
|2||Red||integer (0-255)||red pixels<br />
|-<br />
|3||Green||integer (0-255)||green pixels<br />
|-<br />
|4||Blue||integer (0-255)||blue pixels<br />
|-<br />
|5||Display||boolean (0,1)||turned on = 1, turned off = 0<br />
|-<br />
|6||Pattern||integer||display pattern<br />
|-<br />
|7||Width||integer||width<br />
|-<br />
|8||Style||integer||style pattern<br />
|}<br />
<br />
== Global Parameter Assignment Cards ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP<br />
|-<br />
!Description<br />
|Colspan="3"|Defines a Global Parameter Group<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP Id Name Active<br />
|-<br />
!Sample<br />
|Colspan="3"|GP 1 "Hydro" 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
|+ integer<br />
|id<br />
|-<br />
|2<br />
|name<br />
|string<br />
|name<br />
|-<br />
|3<br />
|active<br />
|boolean<br />
|<br />
*0 = inactive<br />
*1 = active<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameter Defaults<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : GP_DEF GroupId ParamId Name Type Default Min Max <br />
curve: GP_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: GP_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_titleGP param_name val<br />
|-<br />
!Sample<br />
|Colspan="3"|Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : GP_DEF 1 1 "manning n" 1 0 0 10 <br />
<br />
curve: GP_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: GP_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="120"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|param Id<br />
|string<br />
|its id<br />
|-<br />
|3<br />
|name<br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve<br />
|-<br />
|5<br />
|<br />
*default <br />
*or x_axis_title (curve)<br />
|<br />
*type specific ()<br />
*string<br />
|<br />
*default value <br />
*x-axis title when bringing up curve editor<br />
|-<br />
|6<br />
|<br />
*min or<br />
*y_axis_title (curve)<br />
|<br />
*type specific (min)<br />
*string<br />
|<br />
*minimum value <br />
*y-axis title when bringing up curve editor<br />
|-<br />
|7<br />
|max <br />
|type specific (max)<br />
|max value <br />
|-<br />
|8<br />
(only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9<br />
(only float/curve)<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10<br />
(only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_VAL<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameters values<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP_VAL GroupId ParamId (CURVE or FLOAT only if type is float/curve) Value<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_VAL 1 1 30.23<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_VAL 1 2 "Manning"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Value<br />
|varies depending on type<br />
|value<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameters dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Type<br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent<br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|Parent Active<br />
|boolean<br />
|<br />
*0 = inactive<br />
*1 = active<br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off<br />
|}<br />
<br />
= Boundary Condition Definition Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BCPGC<br />
|-<br />
!Description<br />
|Colspan="3"|Defines whether or not to allow boundary condition / parameter group correlation.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BCPGC val<br />
|-<br />
!Sample<br />
|Colspan="3"|BCPGC 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* 0 = Do not allow boundary condition / parameter group correlation.<br />
* 1 = Allow boundary condition / parameter group correlation.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEDISP<br />
|-<br />
!Description<br />
|Colspan="3"|Defines inactive boundary condition display options and boundary condition label options.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEDISP entity_ID font_red font_green font_blue label_on label_vals_on inactive_size inactive_style inactive_red inactive_green inactive_blue inactive_on<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
BEDISP 0 2 0 0 0 1 1 1 255 128 255 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|font_red<br />
|integer<br />
|0 - 255, Red component of RGB triplet defining boundary condition font color.<br />
|-<br />
|3<br />
|font_green<br />
|integer<br />
|0 - 255, Green component of RGB triplet defining boundary condition font color.<br />
|-<br />
|4<br />
|font_blue<br />
|integer<br />
|0 - 255, Blue component of RGB triplet defining boundary condition font color.<br />
|-<br />
|5<br />
|label_on<br />
| boolean<br />
|<br />
* 0 = Do not display boundary condition labels.<br />
* 1 = Display boundary condition labels.<br />
|-<br />
|6<br />
|label_vals_on<br />
|boolean<br />
|<br />
* 0 = Do not display boundary condition values in boundary condition labels.<br />
* 1 = Display boundary condition values in boundary condition labels.<br />
|-<br />
|7<br />
|inactive_size<br />
|integer<br />
|<br />
* 1 - 63, Default size for inactive boundary condition node symbols.<br />
* 1 - 50, Default size for inactive boundary condition element or nodestring symbols.<br />
|-<br />
|8<br />
|inactive_style<br />
|integer<br />
|<br />
* Default style for inactive boundary condition symbols.<br />
* For nodes<br />
<blockquote><br />
* 1 = Filled square<br />
* 2 = Hollow square<br />
* 3 = Filled circle<br />
* 4 = Hollow circle<br />
* 5 = Filled triangle<br />
* 6 = Hollow triangle<br />
* 7 = Filled diamond<br />
* 8 = Hollow diamond<br />
* 9 = Cross<br />
* 10 = X<br />
* 11 = Survey marker<br />
</blockquote><br />
* For elements or nodestrings:<br />
<blockquote><br />
* 0 = solid line<br />
* 1 = dashed line<br />
</blockquote><br />
|-<br />
|9<br />
|inactive_red<br />
|integer<br />
|0 - 255, Red component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|10<br />
|inactive_green<br />
|integer<br />
|0 - 255, Green component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|11<br />
|inactive_blue<br />
|integer<br />
|0 - 255, Blue component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|12<br />
|inactive_on<br />
|boolean<br />
|<br />
* 0 = Do not display inactive boundary conditions.<br />
* 1 = Display inactive boundary conditions.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!BEFONT<br />
|colspan="2"|Single integer method.<br />
|-<br />
!Description<br />
|Colspan="3"|Defines boundary condition label font attributes.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEFONT entity_id font_size<br />
|-<br />
!Sample<br />
|Colspan="3"|BEFONT 1 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|font_size<br />
|integer<br />
|<br />
* 1 = Large font size.<br />
* 2 = Small font size.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!BEFONT<br />
|colspan="2"|Multiple value method.<br />
|-<br />
!Description<br />
|Colspan="3"|Defines boundary condition label font attributes.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEFONT entity_id height width escapement orientation weight italic underline strikeout charSet precision clipPrecision quality pitchAndFamily faceName<br />
|-<br />
!Sample<br />
|Colspan="3"|BEFONT 1 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|height<br />
|integer<br />
|Font height.<br />
|-<br />
|3<br />
|width<br />
|integer<br />
|Font width.<br />
|-<br />
|4<br />
|escapement<br />
|integer<br />
|Font escapement.<br />
|-<br />
|5<br />
|orientation<br />
|integer<br />
|Font orientation.<br />
|-<br />
|6<br />
|weight<br />
|integer<br />
|Font weight.<br />
|-<br />
|7<br />
|italic<br />
|integer<br />
|Font italic.<br />
|-<br />
|8<br />
|underline<br />
|integer<br />
|Font underline.<br />
|-<br />
|9<br />
|strikeout<br />
|integer<br />
|Font strikeout.<br />
|-<br />
|10<br />
|charSet<br />
|integer<br />
|Font character set.<br />
|-<br />
|11<br />
|precision<br />
|integer<br />
|Font precision.<br />
|-<br />
|12<br />
|clipPrecision<br />
|integer<br />
|Font clip precision.<br />
|-<br />
|13<br />
|quality<br />
|integer<br />
|Font quality.<br />
|-<br />
|14<br />
|pitchAndFamily<br />
|integer<br />
|Font pitch and family.<br />
|-<br />
|15<br />
|faceName<br />
|string<br />
|Font face name.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DISP_OPTS <br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition display options (how the boundary conditions are going to be displayed to the user)<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_DISP_OPTS GroupId Red Green Blue Display Pattern Width Style<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_DISP_OPTS 1 0 0 0 0 0 0 0 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|Red<br />
|integer (0-255)<br />
|red pixels<br />
|-<br />
|3<br />
|Green<br />
|integer (0-255)<br />
|green pixels<br />
|-<br />
|4<br />
|Blue <br />
|integer (0-255)<br />
|blue pixels<br />
|-<br />
|5<br />
|Display <br />
|boolean (0,1)<br />
|turned on = 1, turned off = 0<br />
|-<br />
|6<br />
|Pattern<br />
|integer<br />
|displayed pattern<br />
|-<br />
|7<br />
|Width<br />
|integer<br />
|width<br />
|-<br />
|8<br />
|Style<br />
|integer<br />
|style pattern<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEG2DMBC <br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the boundary condition assignment section of the 2D Mesh File. <br />
|-<br />
!Required<br />
|Colspan="3"|Required if boundary conditions are assigned.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|END2DMBC <br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the boundary condition assignment section of the 2D Mesh File. <br />
|-<br />
!Required<br />
|Colspan="3"|Required if boundary conditions are assigned.<br />
|}<br />
<br />
== Boundary Condition Assignment Cards ==<br />
The following cards are used to assign values to the boundary conditions defined in using '''Boundary Condition Definition Cards''':<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC<br />
|-<br />
!Description<br />
|Colspan="3"|Defines input values required for a boundary condition. <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC EntityId Name Id 0 LegalOnInterior ParamGroupCorrelation<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
*BC 1 "Flow rate (cfs)" 1 0 1 "(none)"<br />
*BC 1 "Water temperature (F)" 2 0 "Hydrodynamic"<br />
*BC 1 "Flow rate(cfs)" 3 0 1 "(none)"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity id<br />
|integer<br />
|Entity id that the bc belongs to (NODE = 0, NDSTR =1, ELEM = 2<br />
|-<br />
|2<br />
|name <br />
|string<br />
|Name of value to be specified.<br />
|-<br />
|3<br />
|id <br />
|integer<br />
|The boundary conditions id.<br />
|-<br />
|4<br />
|filler<br />
|0<br />
|Always 0<br />
|-<br />
|5<br />
|legalOnInterior<br />
|boolean<br />
|<br />
*0 = boundary condition is not legal on the interior of the mesh.<br />
*1 = boundary condition is legal on the interior of the mesh.<br />
|-<br />
|6<br />
|paramGroupCorrelation<br />
|string<br />
|Name of the parameter group (defined using the GP card) with which the boundary condition is correlated. If the boundary condition is not correlated with a parameter group, "none" should be specified.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition Parameter Defaults <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : BC_DEF GroupId ParamId Name Type Default Min Max <br />
<br />
curve: BC_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: BC_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_title<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : BC_DEF 1 1 "manning n" 1 0 0 10 <br />
<br />
curve: BC_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: BC_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="120"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer<br />
|id of the boundary condition group that it belongs too<br />
|-<br />
|2<br />
|param Id <br />
|string<br />
|its id<br />
|-<br />
|3<br />
|name <br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve<br />
|-<br />
|5<br />
|default or<br />
<br />
<br />
x_axis_title (curve)<br />
|type specific <br />
<br />
<br />
string<br />
|default value <br />
<br />
<br />
x-axis title when bringing up curve editor<br />
|-<br />
|6<br />
|min or<br />
<br />
<br />
y_axis_title (curve)<br />
|type specific (min)<br />
<br />
<br />
string <br />
|minimum value<br />
<br />
<br />
y-axis title when bringing up curve editor<br />
|-<br />
|7<br />
|max<br />
|type specific (max)<br />
|max value<br />
|-<br />
|8 (only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9 (only float/curve<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10 (only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_OPTS<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition options <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_OPTS GroupId, ParamId, Values<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_OPTS 1 5 "a" "b" "c"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer<br />
|id of the boundary condition group that it belongs too<br />
|-<br />
|2<br />
|param Id <br />
|string<br />
|its id<br />
|-<br />
|3<br />
|values <br />
|string<br />
| <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_VAL<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition values <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_VAL N, E, S (Node, Elem or nodeString) Node or Elem Id, GroupId, ParamId, (CURVE or FLOAT only if type is float/curve) Value<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 2<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 CURVE 2<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 FLOAT 7.675<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|N, E or S <br />
| + integer<br />
|Node, Elem or Nodestring<br />
|-<br />
|2<br />
|Node, Elem, or Nodestring Id <br />
| + integer<br />
|id of the node/element<br />
|-<br />
|3<br />
|group Id <br />
| + integer<br />
|id of the group it belongs too<br />
|-<br />
|4<br />
|param Id<br />
| + integer<br />
|id of the parameter it belongs too<br />
|-<br />
|5<br />
|value<br />
|varies depending on type <br />
|value <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer<br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Type <br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent <br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|Parent Active<br />
|boolean <br />
|<br />
*0 = inactive<br />
*1 = active <br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off <br />
|}<br />
<br />
= Material Properties Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_MULTI<br />
|-<br />
!Description<br />
|Colspan="3"|Is Material Assignment Multiple<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_MULTI Assigned<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_MULTI 1<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_MULTI 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|assigned<br />
|boolean<br />
|0- Single, 1 - Multiple<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_PARAMS<br />
|-<br />
!Description<br />
|Colspan="3"|Material Parameters Assigned<br />
|-<br />
!Required<br />
|Colspan="3"|NOT NEEDED IF MAT_MULTI 0 <br />
|-<br />
!Format<br />
|Colspan="3"|MAT_PARAMS MaterialId, GroupId (1 or More)<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_PARAMS 1 2 3 5 <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_PARAMS 1 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Material Id <br />
| + integer<br />
|id of the material<br />
|-<br />
|2<br />
|Group id<br />
| + integer<br />
|id of the assigned group<br />
|}<br />
<br />
== Material Properties Assignment Cards ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT<br />
|-<br />
!Description<br />
|Colspan="3"|Defines the assigned material properties.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT ID "name"<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT 1 "Clay"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|mat_ID<br />
| + integer<br />
|Material id (sequentially numbered, starting at 1). The disabled material is always id 0 and does not need to be specified in the 2dm file.<br />
|-<br />
|2<br />
|name<br />
|string<br />
|The name of the material. Should be unique.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Material Parameters defaults<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : MAT_DEF GroupId ParamId Name Type Default Min Max <br />
<br />
curve: MAT_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: MAT_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_title<br />
|-<br />
!Sample<br />
|Colspan="3"|Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : MAT_DEF 1 1 "manning n" 1 0 0 10<br />
<br />
curve: MAT_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: MAT_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|group id<br />
| + integer<br />
| id of the Material Group that it belongs too. <br />
|-<br />
|2<br />
|param id<br />
|string<br />
|its id <br />
|-<br />
|3<br />
|name<br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve <br />
|-<br />
|5<br />
|default or<br />
<br />
<br />
x-axis_title (curve)<br />
|type specific <br />
<br />
<br />
string<br />
|default value<br />
<br />
<br />
x-axis title when bringing up curve editor <br />
|-<br />
|6<br />
|min or<br />
<br />
<br />
y-axis_title (curve)<br />
|type specific (min) <br />
<br />
<br />
string<br />
|minimum value<br />
<br />
<br />
y-axis title when bringing up curve editor <br />
|-<br />
|7<br />
|max<br />
|type specific (max) <br />
|max value <br />
|-<br />
|8 <br />
(only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9<br />
(only float/curve)<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10 <br />
(only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_OPTS<br />
|-<br />
!Description<br />
|Colspan="3"|Material options<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_OPTS GroupId, ParamId, Values <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_OPTS 1 5 "a" "b" "c" <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|group id<br />
| + integer<br />
|id of the Boundary Condition Group that it belongs too <br />
|-<br />
|2<br />
|param id<br />
| + integer<br />
|its id<br />
|- <br />
|3<br />
|values<br />
|string<br />
| <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_VALS<br />
|-<br />
!Description<br />
|Colspan="3"|Material values<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_VAL MaterialId, GroupId, ParamId, (CURVE or FLOAT only if type is float/curve) Value <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL S 1 1 2 2<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL 2 1 8 VALUE 8.8888 <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL 2 1 8 CURVE 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|material id <br />
| + integer<br />
|id of the material<br />
|-<br />
|2<br />
|group id<br />
| + integer<br />
|id of the group it belongs too<br />
|-<br />
|3<br />
|param id<br />
|string<br />
|id of the parameter it belongs too<br />
|-<br />
|4<br />
|VALUE or CURVE<br />
|string<br />
|Only if type is float/curve<br />
|-<br />
|5<br />
|value<br />
|varies depending on type<br />
|value<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Material dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|GroupId<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|ParamId <br />
| + integer <br />
|its id<br />
|-<br />
|3<br />
|Type<br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent <br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|ParentActive<br />
|boolean <br />
|<br />
*0 = inactive<br />
*1 = active<br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off<br />
|}<br />
<br />
= Time Series Data Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEGCURVE Version: version<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the time series data section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEGCURVE<br />
|-<br />
!Sample<br />
|Colspan="3"|BCE 2 2 300<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|version<br />
| + integer<br />
|Used to version file format for the curve portion of the file.<br />
|-<br />
!colspan="4"|Note: Version 1 writes the time series data using the [[SMS:XY Series Files|XY Series File, XYS Format]] within the 2D Mesh File. See [[SMS:XY Series Files|XY Series Files (*.xys)]] for a description of the cards used to define the time series data.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|ENDCURVE<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the time series data section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|NO<br />
|}<br />
<br />
= Obsolete Cards = <br />
The following cards are no longer used in SMS:<br />
<br />
PG, PD, PO, GG, GP, BD, BV, MD, MV, BCE, BCN, BCS, TIME, BEDISP<br />
<br />
= Changes from 10.1 to 11.0 =<br />
'''New Cards:'''<br />
*NUM_MATERIALS_PER_ELEM <br />
*GP replaces PG<br />
*GP_DEF replaces PD<br />
*GP_VAL <br />
*GP_DEP <br />
*BC replaces BD<br />
*BC_DEF replaces BV card<br />
*BC_OPTS replaces PO card<br />
*BC_VAL replaces BC card<br />
*BC_DEP <br />
*BC_DISP_OPTS replaces bedisp<br />
*MAT_MULTI <br />
*MAT_PARAMS <br />
*MAT_DEF replaces MV card<br />
*MAT_OPTS <br />
*MAT_VAL <br />
*MAT_DEP <br />
*DISP_OPTS entity <br />
*DISP_OPTS inactive <br />
*DISP_OPTS multiple<br />
<br />
= Sample File 1 = <br />
<pre><br />
BEGCURVE Version: 1<br />
XYS 1 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 3 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 5 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 7 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 9 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 11 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 13 8 "new_series"<br />
0.0 237.35<br />
24.0 137.9<br />
48.0 1347.4<br />
72.0 351.05<br />
96.0 1465.25<br />
120.0 1247.1<br />
144.0 847.35<br />
168.0 731.75<br />
XYS 14 8 "Curve"<br />
0.0 1600.7<br />
24.0 700.85<br />
48.0 1353.7<br />
72.0 712.25<br />
96.0 866.6<br />
120.0 1626.35<br />
144.0 567.6<br />
168.0 980.55<br />
XYS 15 8 "Curve"<br />
0.0 1240.7<br />
24.0 772.25<br />
48.0 741.3<br />
72.0 908.45<br />
96.0 599.45<br />
120.0 522.8<br />
144.0 946.8<br />
168.0 170.4<br />
XYS 16 8 "Curve"<br />
0.0 1252.55<br />
24.0 1467.95<br />
48.0 876.25<br />
72.0 250.2<br />
96.0 479.95<br />
120.0 981.65<br />
144.0 1432.4<br />
168.0 1382.8<br />
XYS 17 8 "Curve"<br />
0.0 1507.65<br />
24.0 202.6<br />
48.0 905.3<br />
72.0 1051.45<br />
96.0 434.95<br />
120.0 267.5<br />
144.0 547.95<br />
168.0 349.2<br />
ENDCURVE<br />
</pre><br />
<br />
= Sample File 2 =<br />
Sample files are available in the [[SMS:Tutorials|SMS tutorials]] in the Generic Mesh Model tutorial under the models section.<br />
<br />
<pre><br />
MESH2D<br />
E3T 1 4 1 3 2<br />
E3T 2 2 5 6 2<br />
E4Q 3 7 8 5 2 2<br />
.<br />
.<br />
.<br />
E4Q 1543 205 1226 1225 1221 2<br />
E4Q 1544 191 1222 1226 189 1<br />
E3T 1545 205 189 1226 2<br />
ND 1 -7.62907961e+001 4.00243909e+001 8.41808447e+001<br />
ND 2 -7.62907174e+001 4.00219296e+001 8.36614138e+001<br />
ND 3 -7.62907700e+001 4.00238340e+001 7.32122342e+001<br />
.<br />
.<br />
.<br />
ND 1222 -7.62811008e+001 4.00272795e+001 7.28898113e+001<br />
ND 1225 -7.62814608e+001 4.00273631e+001 7.29479847e+001<br />
ND 1226 -7.62812859e+001 4.00271526e+001 7.41231480e+001<br />
NS 1 3 10 15 6 -2<br />
NS 126 127 128 129 173 -194<br />
NS 1006 988 987 989 968 948 931 930 929 906<br />
NS -904<br />
NS 720 701 699 686 680 664 649 648 647 640<br />
NS -621<br />
BEGPARAMDEF<br />
GM "Gen2DM"<br />
SI 0<br />
DY 1<br />
TU "minutes"<br />
TD 20 1000<br />
KEY "sms-gen2dm"<br />
PG "Hydrodynamic" 1<br />
PD "Time interval" 1 20 0 2147483647<br />
PD "Velocity max (ft/sec)" 2 75 0 100<br />
PD "H min" 2 0.25 0 1.79769e+308<br />
PD "A min" 2 1 1e-015 1.79769e+308<br />
PD "Check for dry elements" 0 1<br />
PD "Element style" 3 "quadratic"<br />
PD "Critical scour velocity" 4 "2.0 ft/sec"<br />
PO "0.8 ft/sec" "2.0 ft/sec" "2.6 ft/sec"<br />
PG "Sediment transport" 0<br />
PD "Time interval" 1 10 0 2147483647<br />
PD "Source X postion" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Source Y position" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Source elevation" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Parcel mass (slug)" 2 0.5 0.0001 1.79769e+308<br />
PD "Particle mass (slug)" 2 0.003 0.0001 1.79769e+308<br />
PD "Particle size (in)" 2 0.05 0 1.79769e+308<br />
PD "Deviation" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Average density (slug/ft^3)" 2 3 1.5 6<br />
NUME 3<br />
BCPGC 1<br />
BEDISP 0 2 0 0 0 1 1 1 255 128 255 1<br />
BEFONT 0 1<br />
BD 0 "Water sink/source" 2 3 "Flow rate (cfs)" "Water temperature (F)" "Flow rate(cfs)" 1 "(none)"<br />
BV "Flow rate (cfs)" 0 -1.79769e+308 1.79769e+308<br />
BV "Water temperature (F)" 65 32.5 100<br />
BV "Flow rate(cfs)" 0 0 1.79769e+308<br />
BCDISP 0 2 10 1 0 255 255 1<br />
BD 0 "Ceiling (pressure flow)" 1 1 "Ceiling (ft above sea level)" 0 "(none)"<br />
BV "Ceiling (ft above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BCDISP 0 1 3 1 128 128 255 1<br />
BD 0 "Water surface observation gauge" 3 0 1 "(none)"<br />
BCDISP 0 3 3 1 255 128 128 1<br />
BEDISP 1 0 0 255 1 1 1 0 255 128 0 1<br />
BEFONT 1 1<br />
BD 1 "Water surface" 1 3 "Elevation" "Essential/Natural factor" "Vary along nodestring factor" 0 "(none)"<br />
BV "Elevation" 0 -1.79769e+308 1.79769e+308<br />
BV "Essential/Natural factor" 0 0 1<br />
BV "Vary along nodestring factor" 1 0 10<br />
BCDISP 1 1 5 0 255 0 0 1<br />
BD 1 "Flow" 2 1 "Flow rate (cfs)" 0 "(none)"<br />
BV "Flow rate (cfs)" 0 0 1.79769e+308<br />
BCDISP 1 2 5 0 128 255 0 1<br />
BD 1 "Supercritical" 3 0 0 "(none)"<br />
BCDISP 1 3 1 0 0 0 0 1<br />
BD 1 "1D weir segment" 4 4 "Discharge coefficient" "Weir width (ft)" "Crest level (m above sea level)" "Equation (0 = water level / 1 = energy head)" 1 "(none)"<br />
BV "Discharge coefficient" 1 0 1.79769e+308<br />
BV "Weir width (ft)" 1 0 1.79769e+308<br />
BV "Crest level (m above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BV "Equation (0 = water level / 1 = energy head)" 0 0 1<br />
BCDISP 1 4 1 0 0 0 0 0<br />
BD 1 "Sediment trap" 5 0 1 "Sediment transport"<br />
BCDISP 1 5 1 0 0 0 0 1<br />
BEDISP 2 2 0 0 0 1 1 0 0 0 0 1<br />
BEFONT 2 1<br />
BD 2 "2D weir" 1 3 "Discharge coefficient" "Crest level (ft above sea level)" "Equation (0 = water level / 1 = energy head)" 1 "(none)"<br />
BV "Discharge coefficient" 1 0 1.79769e+308<br />
BV "Crest level (ft above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BV "Equation (0 = water level / 1 = energy head)" 0 0 1<br />
BCDISP 2 1 1 0 0 0 0 1<br />
MD 2 "Manning" "Kinematic eddy viscosity"<br />
MV "Manning" 0.035 0.01 0.18<br />
MV "Kinematic eddy viscosity" 0 -1.79769e+308 1.79769e+308<br />
ENDPARAMDEF<br />
BEG2DMBC<br />
MAT 1 0.03 20<br />
MAT 2 0.045 20<br />
GG "Hydrodynamic"<br />
GP "Time interval" 20<br />
GP "Velocity max (ft/sec)" 75<br />
GP "H min" 0.25<br />
GP "A min" 1<br />
GP "Check for dry elements" 1<br />
GP "Element style" "quadratic"<br />
GP "Critical scour velocity" "2.0 ft/sec"<br />
GG "Sediment transport"<br />
GP "Time interval" 10<br />
GP "Source X postion" 0<br />
GP "Source Y position" 0<br />
GP "Source elevation" 0<br />
GP "Parcel mass (slug)" 0.5<br />
GP "Particle mass (slug)" 0.003<br />
GP "Particle size (in)" 0.05<br />
GP "Deviation" 0<br />
GP "Average density (slug/ft^3)" 3<br />
BCN 772 3<br />
BCN 774 3<br />
BCN 776 3<br />
.<br />
.<br />
.<br />
BCS 4 5<br />
BCS 1 1 80 0 1<br />
BCE 1293 1 1 0 0<br />
TIME 20<br />
BCS 2 2 380<br />
TIME 40<br />
BCS 2 2 400<br />
TIME 60<br />
BCS 2 2 380<br />
TIME 80<br />
BCS 2 2 300<br />
TIME 100<br />
BCS 2 2 300<br />
TIME 120<br />
BCS 2 2 300<br />
TIME 140<br />
BCS 2 2 300<br />
TIME 160<br />
BCS 2 2 300<br />
TIME 180<br />
BCS 2 2 300<br />
TIME 200<br />
BCS 2 2 300<br />
TIME 220<br />
BCS 2 2 300<br />
TIME 240<br />
BCS 2 2 300<br />
TIME 260<br />
BCS 2 2 300<br />
TIME 280<br />
BCS 2 2 300<br />
TIME 300<br />
BCS 2 2 300<br />
TIME 320<br />
BCS 2 2 300<br />
TIME 340<br />
BCS 2 2 300<br />
TIME 360<br />
BCS 2 2 300<br />
TIME 380<br />
BCS 2 2 300<br />
TIME 400<br />
BCS 2 2 300<br />
TIME 420<br />
BCS 2 2 300<br />
TIME 440<br />
BCS 2 2 300<br />
TIME 460<br />
BCS 2 2 300<br />
TIME 480<br />
BCS 2 2 300<br />
TIME 500<br />
BCS 2 2 300<br />
TIME 520<br />
BCS 2 2 300<br />
TIME 540<br />
BCS 2 2 300<br />
TIME 560<br />
BCS 2 2 300<br />
TIME 580<br />
BCS 2 2 300<br />
TIME 600<br />
BCS 2 2 300<br />
TIME 620<br />
BCS 2 2 300<br />
TIME 640<br />
BCS 2 2 300<br />
TIME 660<br />
BCS 2 2 300<br />
TIME 680<br />
BCS 2 2 300<br />
TIME 700<br />
BCS 2 2 300<br />
TIME 720<br />
BCS 2 2 300<br />
TIME 740<br />
BCS 2 2 300<br />
TIME 760<br />
BCS 2 2 300<br />
TIME 780<br />
BCS 2 2 300<br />
TIME 800<br />
BCS 2 2 300<br />
TIME 820<br />
BCS 2 2 300<br />
TIME 840<br />
BCS 2 2 300<br />
TIME 860<br />
BCS 2 2 300<br />
TIME 880<br />
BCS 2 2 300<br />
TIME 900<br />
BCS 2 2 300<br />
TIME 920<br />
BCS 2 2 300<br />
TIME 940<br />
BCS 2 2 300<br />
TIME 960<br />
BCS 2 2 300<br />
TIME 980<br />
BCS 2 2 300<br />
TIME 1000<br />
BCS 2 2 300<br />
END2DMBC<br />
</pre><br />
<br />
= Related Topics =<br />
* [[SMS:File Formats|File Formats]]<br />
* [[SMS:Generic_Model_Files|Generic Model Files]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]]<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|2]]<br />
[[Category:Generic Model|2]]<br />
[[Category:SMS File Formats|2]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:2D_Mesh_Files_*.2dm&diff=85179SMS:2D Mesh Files *.2dm2015-04-15T15:02:44Z<p>Morelandtom: /* Global Parameters */</p>
<hr />
<div>{{TOCright}}<br />
A finite element mesh can be saved in a generic format defined by SMS, called the 2dm format. In addition, the Generic Model interface in the Mesh module uses this format to save a template definition, in addition to model parameter, material property, and boundary condition assignments for a specific simulation. When a *.2dm file is opened, the Current Numerical Model changes to the Generic Mesh Interface. To save a numerical model definition as a template file, a user should first set up the template and save a *.2dm file before any nodes are created.<br />
<br />
= Mesh Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!MESH2D<br />
|-<br />
!Description<br />
|Identifies the file as a 2d mesh file. Must be the first line of the file.<br />
|-<br />
!Required<br />
|YES<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!colspan="3" | NUM_MATERIALS_PER_ELEM<br />
|-<br />
!Description<br />
|colspan="3" |Defines Number of Materials per Element<br />
|-<br />
!Required<br />
|colspan="3" |YES<br />
|-<br />
!Format <br />
|colspan="3" |MATERIALS Quantity<br />
|-<br />
!Sample<br />
|colspan="3" |NUM_MATERIALS_PER_ELEM 2 <br />
|-<br />
!width="100" | Field<br />
!width="100" | Variable<br />
!width="100" | Value<br />
!width="450" | Description<br />
|-<br />
|1||Quantity ||+ integer ||Number of Materials <br />
|}<br />
<br />
== Nodes ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|ND<br />
|-<br />
!Description<br />
|Colspan="3"|Defines the ID and location for each node of the mesh.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|ND id x y z<br />
|-<br />
!Sample<br />
|Colspan="3"|ND 1 7.75e+005 1.10e+005 5.00e-001<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the node.<br />
|-<br />
|2-4<br />
|x,y,z<br />
|&#177; real number<br />
|The x, y, and z coordinates of the point.<br />
|}<br />
<br />
== Linear Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E2L<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 2-noded linear element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E2L id n<sub>1</sub> n<sub>2</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E2L 1 1 2 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 3<br />
|n<sub>1</sub> - n<sub>2</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|4<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E3L<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 3-noded linear element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E3L id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E3L 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 4<br />
|n<sub>1</sub> - n<sub>3</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|5<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Triangular Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E3T<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 3-noded triangular element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E3T id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E3T 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 4<br />
|n<sub>1</sub> - n<sub>3</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|5<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E6T<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 6-noded triangular element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E6T id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E6T 1 1 2 3 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 7<br />
|n<sub>1</sub> - n<sub>6</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|8<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Quadrilateral Elements ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E4Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a 4-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E4Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E4Q 1 1 2 3 4 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 5<br />
|n<sub>1</sub> - n<sub>4</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|6<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E8Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies an 8-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E8Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> n<sub>7</sub> n<sub>8</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E8Q 1 1 2 3 4 5 6 7 8 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 9<br />
|n<sub>1</sub> - n<sub>8</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|10<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|E9Q<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies an 9-noded quadrilateral element.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|E9Q id n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> n<sub>4</sub> n<sub>5</sub> n<sub>6</sub> n<sub>7</sub> n<sub>8</sub> n<sub>9</sub> matid<br />
|-<br />
!Sample<br />
|Colspan="3"|E9Q 1 1 2 3 4 5 6 7 8 9 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
| + integer<br />
|The ID of the element.<br />
|-<br />
|2 - 10<br />
|n<sub>1</sub> - n<sub>9</sub><br />
| + integer<br />
|The ID's of nodes in the element.<br />
|-<br />
|11<br />
|matid<br />
| + integer<br />
|The ID of the material assigned to the element.<br />
|}<br />
<br />
== Nodestrings ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|NS<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies a nodestring.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|NS n<sub>1</sub> n<sub>2</sub> n<sub>3</sub> ... - n<sub>n</sub> (number of nodes in nodestring)<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
{|border="0"<br />
|<pre><br />
NS 1 3 10 15 6 -2<br />
NS 126 127 128 129 173 -194<br />
NS 1006 988 987 989 968 948 931 930 929 906<br />
NS -904<br />
NS 720 701 699 686 680 664 649 648 647 640<br />
NS -621<br />
</pre><br />
|}<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|n<sub>1</sub> - n<sub>n</sub> (number of nodes in nodestring)<br />
|n<sub>x</sub><br />
| + integer<br />
|The ID's of the nodes in the nodestring. The last node id is written as a negative number, thus signaling the nodestring's end. Multiple NS cards can be used on consecutive lines for a single nodestring.<br />
|}<br />
<br />
= Model Parameter Definition Cards =<br />
The model control parameters, boundary conditions and material options available for a specific model are defined in the generic model parameter definition section of the 2D mesh file. The generic model parameter definition section is begun by specifying the '''BEGPARAMDEF''' card and ended with the '''ENDPARAMDEF''' card.<br />
<br />
Starting with SMS version 11.0, all of the parameter cards follow a similar pattern and the available options for several of the types of parameters were increased.<br />
The pattern is similar for Global Parameters, '''GP''', Bondary Conditions '''BC''', and Materials '''MAT'''. More information can be found in each individual card.<br />
<br />
{|class="wikitable"<br />
|-<br />
!width="130"|Global Parameters<br />
!width="130"|Boundary Conditions<br />
!width="130"|Materials<br />
!width="100"|Description<br />
|-<br />
|GP||BC||MAT||Name,Id<br />
|-<br />
|GP_DEF||BC_DEF||MAT_DEF||definitions<br />
|-<br />
|GP_OPTS||BC_OPTS||MAT_OPTS||options<br />
|-<br />
|GP_VAL||BC_VAL||MAT_VAL||values<br />
|-<br />
|(parent, so it has no dependencies)||BC_DEP||MAT_DEP||dependencies<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''BEGPARAMDEF'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the model parameter definition section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|Required if model parameters are to be defined.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''ENDPARAMDEF'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the model parameter definition section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|Required if model parameters are to be defined.<br />
|}<br />
<br />
= Global Parameters =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''GM'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model name.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GM name<br />
|-<br />
!Sample<br />
|Colspan="3"|GM "Gen2DM"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|name<br />
|string<br />
|Model name.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''SI'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model units.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|SI val<br />
|-<br />
!Sample<br />
|Colspan="3"|SI 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|0=Meters, 1=U.S. Survey Feet, 2=Geographic (Lat/Lon), 3=International Feet.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''DY'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies whether the model is dynamic or steady state.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|DY val<br />
|-<br />
!Sample<br />
|Colspan="3"|DY 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* Enter 0 for steady state.<br />
* Enter 1 for dynamic.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''TU'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model time units.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|TU val<br />
|-<br />
!Sample<br />
|Colspan="3"|TU seconds<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|string<br />
|A string value describing the model units (days, hours, minutes, seconds, etc.).<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''TD'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the model time step and total simulation time.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|TD time_step total_time<br />
|-<br />
!Sample<br />
|Colspan="3"|TD 20 1000<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|time_step<br />
| + real number<br />
|Time step (for dynamic simulations).<br />
|-<br />
|1<br />
|total_time<br />
| + real number<br />
|Total simulation run time (for dynamic simulations).<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|'''KEY'''<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the key to unlock and edit the model definition inside of the SMS interface.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|KEY key<br />
|-<br />
!Sample<br />
|Colspan="3"|KEY "sms-gen2dm"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|key<br />
|string<br />
|Case sensitive key to unlock and edit the model definition.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
|Colspan="3"|<br />
*'''DISP_OPTS entity'''<br />
*'''DISP_OPTS inactive'''<br />
*'''DISP_OPTS multiple'''<br />
|-<br />
!Description<br />
|Colspan="3"|How a specific display option to the user.. colors, line thickness, etc.<br />
*'''entity''' &ndash; the main attribute (will either be the node, element, or nodestring display option)<br />
*'''inactive''' &ndash; display option for inactive or unassigned <br />
*'''multiple''' &ndash; display option for multiple assigned<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|DISP_OPTS EntityId Red Green Blue Display Pattern Width Style<br />
|-<br />
!Sample<br />
|Colspan="3"|DISP_OPTS entity 1 0 0 0 1 0 1 0<br />
|-<br />
!Sample<br />
|Colspan="3"|DISP_OPTS multiple 1 0 0 0 1 0 1 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="130"|Value<br />
!width="420"|Description<br />
|-<br />
|1|||EnitityId||integer (0-2)<br />
*0 = node<br />
*1 = nodestring<br />
*2 = element<br />
|id of the group it belongs too.<br />
|-<br />
|2||Red||integer (0-255)||red pixels<br />
|-<br />
|3||Green||integer (0-255)||green pixels<br />
|-<br />
|4||Blue||integer (0-255)||blue pixels<br />
|-<br />
|5||Display||boolean (0,1)||turned on = 1, turned off = 0<br />
|-<br />
|6||Pattern||integer||display pattern<br />
|-<br />
|7||Width||integer||width<br />
|-<br />
|8||Style||integer||style pattern<br />
|}<br />
<br />
== Global Parameter Assignment Cards ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP<br />
|-<br />
!Description<br />
|Colspan="3"|Defines a Global Parameter Group<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP Id Name Active<br />
|-<br />
!Sample<br />
|Colspan="3"|GP 1 "Hydro" 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|id<br />
|+ integer<br />
|id<br />
|-<br />
|2<br />
|name<br />
|string<br />
|name<br />
|-<br />
|3<br />
|active<br />
|boolean<br />
|<br />
*0 = inactive<br />
*1 = active<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameter Defaults<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : GP_DEF GroupId ParamId Name Type Default Min Max <br />
curve: GP_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: GP_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_titleGP param_name val<br />
|-<br />
!Sample<br />
|Colspan="3"|Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : GP_DEF 1 1 "manning n" 1 0 0 10 <br />
<br />
curve: GP_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: GP_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="120"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|param Id<br />
|string<br />
|its id<br />
|-<br />
|3<br />
|name<br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve<br />
|-<br />
|5<br />
|<br />
*default <br />
*or x_axis_title (curve)<br />
|<br />
*type specific ()<br />
*string<br />
|<br />
*default value <br />
*x-axis title when bringing up curve editor<br />
|-<br />
|6<br />
|<br />
*min or<br />
*y_axis_title (curve)<br />
|<br />
*type specific (min)<br />
*string<br />
|<br />
*minimum value <br />
*y-axis title when bringing up curve editor<br />
|-<br />
|7<br />
|max <br />
|type specific (max)<br />
|max value <br />
|-<br />
|8<br />
(only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9<br />
(only float/curve)<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10<br />
(only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_VAL<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameters values<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP_VAL GroupId ParamId (CURVE or FLOAT only if type is float/curve) Value<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_VAL 1 1 30.23<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_VAL 1 2 "Manning"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Value<br />
|varies depending on type<br />
|value<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|GP_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Global Parameters dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|GP_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|GP_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Type<br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent<br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|Parent Active<br />
|boolean<br />
|<br />
*0 = inactive<br />
*1 = active<br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off<br />
|}<br />
<br />
= Boundary Condition Definition Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BCPGC<br />
|-<br />
!Description<br />
|Colspan="3"|Defines whether or not to allow boundary condition / parameter group correlation.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BCPGC val<br />
|-<br />
!Sample<br />
|Colspan="3"|BCPGC 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|val<br />
|boolean<br />
|<br />
* 0 = Do not allow boundary condition / parameter group correlation.<br />
* 1 = Allow boundary condition / parameter group correlation.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEDISP<br />
|-<br />
!Description<br />
|Colspan="3"|Defines inactive boundary condition display options and boundary condition label options.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEDISP entity_ID font_red font_green font_blue label_on label_vals_on inactive_size inactive_style inactive_red inactive_green inactive_blue inactive_on<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
BEDISP 0 2 0 0 0 1 1 1 255 128 255 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|font_red<br />
|integer<br />
|0 - 255, Red component of RGB triplet defining boundary condition font color.<br />
|-<br />
|3<br />
|font_green<br />
|integer<br />
|0 - 255, Green component of RGB triplet defining boundary condition font color.<br />
|-<br />
|4<br />
|font_blue<br />
|integer<br />
|0 - 255, Blue component of RGB triplet defining boundary condition font color.<br />
|-<br />
|5<br />
|label_on<br />
| boolean<br />
|<br />
* 0 = Do not display boundary condition labels.<br />
* 1 = Display boundary condition labels.<br />
|-<br />
|6<br />
|label_vals_on<br />
|boolean<br />
|<br />
* 0 = Do not display boundary condition values in boundary condition labels.<br />
* 1 = Display boundary condition values in boundary condition labels.<br />
|-<br />
|7<br />
|inactive_size<br />
|integer<br />
|<br />
* 1 - 63, Default size for inactive boundary condition node symbols.<br />
* 1 - 50, Default size for inactive boundary condition element or nodestring symbols.<br />
|-<br />
|8<br />
|inactive_style<br />
|integer<br />
|<br />
* Default style for inactive boundary condition symbols.<br />
* For nodes<br />
<blockquote><br />
* 1 = Filled square<br />
* 2 = Hollow square<br />
* 3 = Filled circle<br />
* 4 = Hollow circle<br />
* 5 = Filled triangle<br />
* 6 = Hollow triangle<br />
* 7 = Filled diamond<br />
* 8 = Hollow diamond<br />
* 9 = Cross<br />
* 10 = X<br />
* 11 = Survey marker<br />
</blockquote><br />
* For elements or nodestrings:<br />
<blockquote><br />
* 0 = solid line<br />
* 1 = dashed line<br />
</blockquote><br />
|-<br />
|9<br />
|inactive_red<br />
|integer<br />
|0 - 255, Red component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|10<br />
|inactive_green<br />
|integer<br />
|0 - 255, Green component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|11<br />
|inactive_blue<br />
|integer<br />
|0 - 255, Blue component of RGB triplet defining inactive boundary condition font color.<br />
|-<br />
|12<br />
|inactive_on<br />
|boolean<br />
|<br />
* 0 = Do not display inactive boundary conditions.<br />
* 1 = Display inactive boundary conditions.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!BEFONT<br />
|colspan="2"|Single integer method.<br />
|-<br />
!Description<br />
|Colspan="3"|Defines boundary condition label font attributes.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEFONT entity_id font_size<br />
|-<br />
!Sample<br />
|Colspan="3"|BEFONT 1 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|font_size<br />
|integer<br />
|<br />
* 1 = Large font size.<br />
* 2 = Small font size.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!BEFONT<br />
|colspan="2"|Multiple value method.<br />
|-<br />
!Description<br />
|Colspan="3"|Defines boundary condition label font attributes.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEFONT entity_id height width escapement orientation weight italic underline strikeout charSet precision clipPrecision quality pitchAndFamily faceName<br />
|-<br />
!Sample<br />
|Colspan="3"|BEFONT 1 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity_ID<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|height<br />
|integer<br />
|Font height.<br />
|-<br />
|3<br />
|width<br />
|integer<br />
|Font width.<br />
|-<br />
|4<br />
|escapement<br />
|integer<br />
|Font escapement.<br />
|-<br />
|5<br />
|orientation<br />
|integer<br />
|Font orientation.<br />
|-<br />
|6<br />
|weight<br />
|integer<br />
|Font weight.<br />
|-<br />
|7<br />
|italic<br />
|integer<br />
|Font italic.<br />
|-<br />
|8<br />
|underline<br />
|integer<br />
|Font underline.<br />
|-<br />
|9<br />
|strikeout<br />
|integer<br />
|Font strikeout.<br />
|-<br />
|10<br />
|charSet<br />
|integer<br />
|Font character set.<br />
|-<br />
|11<br />
|precision<br />
|integer<br />
|Font precision.<br />
|-<br />
|12<br />
|clipPrecision<br />
|integer<br />
|Font clip precision.<br />
|-<br />
|13<br />
|quality<br />
|integer<br />
|Font quality.<br />
|-<br />
|14<br />
|pitchAndFamily<br />
|integer<br />
|Font pitch and family.<br />
|-<br />
|15<br />
|faceName<br />
|string<br />
|Font face name.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DISP_OPTS <br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition display options (how the boundary conditions are going to be displayed to the user)<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_DISP_OPTS GroupId Red Green Blue Display Pattern Width Style<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_DISP_OPTS 1 0 0 0 0 0 0 0 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
|integer<br />
|<br />
* 0 = node<br />
* 1 = nodestring<br />
* 2 = element<br />
|-<br />
|2<br />
|Red<br />
|integer (0-255)<br />
|red pixels<br />
|-<br />
|3<br />
|Green<br />
|integer (0-255)<br />
|green pixels<br />
|-<br />
|4<br />
|Blue <br />
|integer (0-255)<br />
|blue pixels<br />
|-<br />
|5<br />
|Display <br />
|boolean (0,1)<br />
|turned on = 1, turned off = 0<br />
|-<br />
|6<br />
|Pattern<br />
|integer<br />
|displayed pattern<br />
|-<br />
|7<br />
|Width<br />
|integer<br />
|width<br />
|-<br />
|8<br />
|Style<br />
|integer<br />
|style pattern<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEG2DMBC <br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the boundary condition assignment section of the 2D Mesh File. <br />
|-<br />
!Required<br />
|Colspan="3"|Required if boundary conditions are assigned.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|END2DMBC <br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the boundary condition assignment section of the 2D Mesh File. <br />
|-<br />
!Required<br />
|Colspan="3"|Required if boundary conditions are assigned.<br />
|}<br />
<br />
== Boundary Condition Assignment Cards ==<br />
The following cards are used to assign values to the boundary conditions defined in using '''Boundary Condition Definition Cards''':<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC<br />
|-<br />
!Description<br />
|Colspan="3"|Defines input values required for a boundary condition. <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC EntityId Name Id 0 LegalOnInterior ParamGroupCorrelation<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
*BC 1 "Flow rate (cfs)" 1 0 1 "(none)"<br />
*BC 1 "Water temperature (F)" 2 0 "Hydrodynamic"<br />
*BC 1 "Flow rate(cfs)" 3 0 1 "(none)"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|entity id<br />
|integer<br />
|Entity id that the bc belongs to (NODE = 0, NDSTR =1, ELEM = 2<br />
|-<br />
|2<br />
|name <br />
|string<br />
|Name of value to be specified.<br />
|-<br />
|3<br />
|id <br />
|integer<br />
|The boundary conditions id.<br />
|-<br />
|4<br />
|filler<br />
|0<br />
|Always 0<br />
|-<br />
|5<br />
|legalOnInterior<br />
|boolean<br />
|<br />
*0 = boundary condition is not legal on the interior of the mesh.<br />
*1 = boundary condition is legal on the interior of the mesh.<br />
|-<br />
|6<br />
|paramGroupCorrelation<br />
|string<br />
|Name of the parameter group (defined using the GP card) with which the boundary condition is correlated. If the boundary condition is not correlated with a parameter group, "none" should be specified.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition Parameter Defaults <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : BC_DEF GroupId ParamId Name Type Default Min Max <br />
<br />
curve: BC_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: BC_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_title<br />
|-<br />
!Sample<br />
|Colspan="3"|<br />
Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : BC_DEF 1 1 "manning n" 1 0 0 10 <br />
<br />
curve: BC_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: BC_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="120"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer<br />
|id of the boundary condition group that it belongs too<br />
|-<br />
|2<br />
|param Id <br />
|string<br />
|its id<br />
|-<br />
|3<br />
|name <br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve<br />
|-<br />
|5<br />
|default or<br />
<br />
<br />
x_axis_title (curve)<br />
|type specific <br />
<br />
<br />
string<br />
|default value <br />
<br />
<br />
x-axis title when bringing up curve editor<br />
|-<br />
|6<br />
|min or<br />
<br />
<br />
y_axis_title (curve)<br />
|type specific (min)<br />
<br />
<br />
string <br />
|minimum value<br />
<br />
<br />
y-axis title when bringing up curve editor<br />
|-<br />
|7<br />
|max<br />
|type specific (max)<br />
|max value<br />
|-<br />
|8 (only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9 (only float/curve<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10 (only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_OPTS<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition options <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_OPTS GroupId, ParamId, Values<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_OPTS 1 5 "a" "b" "c"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|group Id<br />
| + integer<br />
|id of the boundary condition group that it belongs too<br />
|-<br />
|2<br />
|param Id <br />
|string<br />
|its id<br />
|-<br />
|3<br />
|values <br />
|string<br />
| <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_VAL<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition values <br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_VAL N, E, S (Node, Elem or nodeString) Node or Elem Id, GroupId, ParamId, (CURVE or FLOAT only if type is float/curve) Value<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 2<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 CURVE 2<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_VAL S 1 1 2 FLOAT 7.675<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|N, E or S <br />
| + integer<br />
|Node, Elem or Nodestring<br />
|-<br />
|2<br />
|Node, Elem, or Nodestring Id <br />
| + integer<br />
|id of the node/element<br />
|-<br />
|3<br />
|group Id <br />
| + integer<br />
|id of the group it belongs too<br />
|-<br />
|4<br />
|param Id<br />
| + integer<br />
|id of the parameter it belongs too<br />
|-<br />
|5<br />
|value<br />
|varies depending on type <br />
|value <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BC_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Boundary Condition dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BC_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|BC_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Group Id<br />
| + integer<br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|Param Id<br />
| + integer<br />
|its id<br />
|-<br />
|3<br />
|Type <br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent <br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|Parent Active<br />
|boolean <br />
|<br />
*0 = inactive<br />
*1 = active <br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off <br />
|}<br />
<br />
= Material Properties Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_MULTI<br />
|-<br />
!Description<br />
|Colspan="3"|Is Material Assignment Multiple<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_MULTI Assigned<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_MULTI 1<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_MULTI 0<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|assigned<br />
|boolean<br />
|0- Single, 1 - Multiple<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_PARAMS<br />
|-<br />
!Description<br />
|Colspan="3"|Material Parameters Assigned<br />
|-<br />
!Required<br />
|Colspan="3"|NOT NEEDED IF MAT_MULTI 0 <br />
|-<br />
!Format<br />
|Colspan="3"|MAT_PARAMS MaterialId, GroupId (1 or More)<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_PARAMS 1 2 3 5 <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_PARAMS 1 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|Material Id <br />
| + integer<br />
|id of the material<br />
|-<br />
|2<br />
|Group id<br />
| + integer<br />
|id of the assigned group<br />
|}<br />
<br />
== Material Properties Assignment Cards ==<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT<br />
|-<br />
!Description<br />
|Colspan="3"|Defines the assigned material properties.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT ID "name"<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT 1 "Clay"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|mat_ID<br />
| + integer<br />
|Material id (sequentially numbered, starting at 1). The disabled material is always id 0 and does not need to be specified in the 2dm file.<br />
|-<br />
|2<br />
|name<br />
|string<br />
|The name of the material. Should be unique.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_DEF<br />
|-<br />
!Description<br />
|Colspan="3"|Material Parameters defaults<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|The format will depend up the type (field 4). Fields 5, 6, and 7 will be impacted by the choice of field 4. Note that the min and max information is only applicable to integer and double types.<br />
<br />
bool, integer, double, text, or options : MAT_DEF GroupId ParamId Name Type Default Min Max <br />
<br />
curve: MAT_DEF GroupId ParamId Name Type x_axis_title y_axis_title<br />
<br />
Float/Curve: MAT_DEF GroupId ParamId Name Type Float_Default Float_Min Float_Max DefaultFloatOrCurve x_axis_title y_axis_title<br />
|-<br />
!Sample<br />
|Colspan="3"|Values depend upon type (see format).<br />
<br />
bool, integer, double, text or options : MAT_DEF 1 1 "manning n" 1 0 0 10<br />
<br />
curve: MAT_DEF 1 1 "manning n" 5 "x-axis" "y-axis" <br />
<br />
Float/Curve: MAT_DEF 1 1 "manning n" 6 0.2 0.0 1.0 CURVE "x-axis" "y-axis"<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|group id<br />
| + integer<br />
| id of the Material Group that it belongs too. <br />
|-<br />
|2<br />
|param id<br />
|string<br />
|its id <br />
|-<br />
|3<br />
|name<br />
|string<br />
|its name<br />
|-<br />
|4<br />
|type<br />
|int<br />
|0-Bool, 1-Integer, 2-Double, 3-Text, 4-Options, 5-Curve, 6-Float/Curve <br />
|-<br />
|5<br />
|default or<br />
<br />
<br />
x-axis_title (curve)<br />
|type specific <br />
<br />
<br />
string<br />
|default value<br />
<br />
<br />
x-axis title when bringing up curve editor <br />
|-<br />
|6<br />
|min or<br />
<br />
<br />
y-axis_title (curve)<br />
|type specific (min) <br />
<br />
<br />
string<br />
|minimum value<br />
<br />
<br />
y-axis title when bringing up curve editor <br />
|-<br />
|7<br />
|max<br />
|type specific (max) <br />
|max value <br />
|-<br />
|8 <br />
(only float/curve)<br />
|DefaultFloatOrCurve<br />
|string either<br />
*"FLOAT"<br />
*"CURVE"<br />
|The default version float or integer that is seen by the user<br />
|-<br />
|9<br />
(only float/curve)<br />
|x_axis_title<br />
|string<br />
|x-axis title when bringing up curve editor<br />
|-<br />
|10 <br />
(only float/curve)<br />
|y_axis_title<br />
|string<br />
|y-axis title when bringing up curve editor<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_OPTS<br />
|-<br />
!Description<br />
|Colspan="3"|Material options<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_OPTS GroupId, ParamId, Values <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_OPTS 1 5 "a" "b" "c" <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|group id<br />
| + integer<br />
|id of the Boundary Condition Group that it belongs too <br />
|-<br />
|2<br />
|param id<br />
| + integer<br />
|its id<br />
|- <br />
|3<br />
|values<br />
|string<br />
| <br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_VALS<br />
|-<br />
!Description<br />
|Colspan="3"|Material values<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_VAL MaterialId, GroupId, ParamId, (CURVE or FLOAT only if type is float/curve) Value <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL S 1 1 2 2<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL 2 1 8 VALUE 8.8888 <br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_VAL 2 1 8 CURVE 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|material id <br />
| + integer<br />
|id of the material<br />
|-<br />
|2<br />
|group id<br />
| + integer<br />
|id of the group it belongs too<br />
|-<br />
|3<br />
|param id<br />
|string<br />
|id of the parameter it belongs too<br />
|-<br />
|4<br />
|VALUE or CURVE<br />
|string<br />
|Only if type is float/curve<br />
|-<br />
|5<br />
|value<br />
|varies depending on type<br />
|value<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|MAT_DEP<br />
|-<br />
!Description<br />
|Colspan="3"|Material dependencies<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|MAT_DEP GroupId ParamId Type Parent ParentActive Opts OptsValue<br />
|-<br />
!Sample<br />
|Colspan="3"|MAT_DEP 1 7 "PARENT_SELF" "Friction type" 0 "Manning" 0 "Chezy" 1 <br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1 <br />
|GroupId<br />
| + integer <br />
|id of the Global Parameter Group that it belongs too<br />
|-<br />
|2<br />
|ParamId <br />
| + integer <br />
|its id<br />
|-<br />
|3<br />
|Type<br />
|string valid values are:<br />
*PARENT_UNASSGINED<br />
*PARENT_NONE<br />
*PARENT_LOCAL<br />
*PARENT_GLOBAL<br />
*PARENT_SELF<br />
| <br />
*parent not assigned<br />
*no parent<br />
*parent is in the same group id<br />
*parent is from global group or GP<br />
*parent <br />
|-<br />
|4<br />
|Parent<br />
| + integer<br />
|parent name<br />
|-<br />
|5<br />
|ParentActive<br />
|boolean <br />
|<br />
*0 = inactive<br />
*1 = active<br />
|-<br />
|6<br />
|Opts<br />
|string<br />
|name of the option<br />
|-<br />
|7<br />
|OptsValue<br />
|boolean<br />
|whether this option is turned on/off<br />
|}<br />
<br />
= Time Series Data Cards =<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!COLSPAN="3"|BEGCURVE Version: version<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the beginning of the time series data section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3"|NO<br />
|-<br />
!Format<br />
|Colspan="3"|BEGCURVE<br />
|-<br />
!Sample<br />
|Colspan="3"|BCE 2 2 300<br />
|-<br />
!width="100"|Field<br />
!width="100"|Variable<br />
!width="100"|Value<br />
!width="450"|Description<br />
|-<br />
|1<br />
|version<br />
| + integer<br />
|Used to version file format for the curve portion of the file.<br />
|-<br />
!colspan="4"|Note: Version 1 writes the time series data using the [[SMS:XY Series Files|XY Series File, XYS Format]] within the 2D Mesh File. See [[SMS:XY Series Files|XY Series Files (*.xys)]] for a description of the cards used to define the time series data.<br />
|}<br />
<br />
<br />
{|class="wikitable"<br />
|-<br />
!Card Type<br />
!Colspan="3"|ENDCURVE<br />
|-<br />
!Description<br />
|Colspan="3"|Identifies the end of the time series data section of the 2D Mesh File.<br />
|-<br />
!Required<br />
|Colspan="3" style="text-align:left"|NO<br />
|}<br />
<br />
= Obsolete Cards = <br />
The following cards are no longer used in SMS:<br />
<br />
PG, PD, PO, GG, GP, BD, BV, MD, MV, BCE, BCN, BCS, TIME, BEDISP<br />
<br />
= Changes from 10.1 to 11.0 =<br />
'''New Cards:'''<br />
*NUM_MATERIALS_PER_ELEM <br />
*GP replaces PG<br />
*GP_DEF replaces PD<br />
*GP_VAL <br />
*GP_DEP <br />
*BC replaces BD<br />
*BC_DEF replaces BV card<br />
*BC_OPTS replaces PO card<br />
*BC_VAL replaces BC card<br />
*BC_DEP <br />
*BC_DISP_OPTS replaces bedisp<br />
*MAT_MULTI <br />
*MAT_PARAMS <br />
*MAT_DEF replaces MV card<br />
*MAT_OPTS <br />
*MAT_VAL <br />
*MAT_DEP <br />
*DISP_OPTS entity <br />
*DISP_OPTS inactive <br />
*DISP_OPTS multiple<br />
<br />
= Sample File 1 = <br />
<pre><br />
BEGCURVE Version: 1<br />
XYS 1 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 3 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 5 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 7 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 9 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 11 29 "new_series"<br />
0.0 3000.0<br />
1.5 3000.0<br />
2.5 3050.0<br />
3.0 3150.0<br />
3.5 3300.0<br />
4.0 3500.0<br />
4.5 3700.0<br />
5.0 3950.0<br />
5.5 4150.0<br />
6.0 4350.0<br />
6.5 4550.0<br />
7.0 4700.0<br />
7.45 4825.0<br />
8.0 4925.0<br />
8.5 4975.0<br />
9.0 5000.0<br />
9.5 4975.0<br />
10.0 4800.0<br />
10.5 4500.0<br />
11.0 4250.0<br />
11.5 4000.0<br />
12.0 3750.0<br />
13.0 3500.0<br />
14.0 3350.0<br />
15.5 3200.0<br />
17.5 3100.0<br />
19.5 3050.0<br />
22.0 3000.0<br />
25.0 3000.0<br />
XYS 13 8 "new_series"<br />
0.0 237.35<br />
24.0 137.9<br />
48.0 1347.4<br />
72.0 351.05<br />
96.0 1465.25<br />
120.0 1247.1<br />
144.0 847.35<br />
168.0 731.75<br />
XYS 14 8 "Curve"<br />
0.0 1600.7<br />
24.0 700.85<br />
48.0 1353.7<br />
72.0 712.25<br />
96.0 866.6<br />
120.0 1626.35<br />
144.0 567.6<br />
168.0 980.55<br />
XYS 15 8 "Curve"<br />
0.0 1240.7<br />
24.0 772.25<br />
48.0 741.3<br />
72.0 908.45<br />
96.0 599.45<br />
120.0 522.8<br />
144.0 946.8<br />
168.0 170.4<br />
XYS 16 8 "Curve"<br />
0.0 1252.55<br />
24.0 1467.95<br />
48.0 876.25<br />
72.0 250.2<br />
96.0 479.95<br />
120.0 981.65<br />
144.0 1432.4<br />
168.0 1382.8<br />
XYS 17 8 "Curve"<br />
0.0 1507.65<br />
24.0 202.6<br />
48.0 905.3<br />
72.0 1051.45<br />
96.0 434.95<br />
120.0 267.5<br />
144.0 547.95<br />
168.0 349.2<br />
ENDCURVE<br />
</pre><br />
<br />
= Sample File 2 =<br />
Sample files are available in the [[SMS:Tutorials|SMS tutorials]] in the Generic Mesh Model tutorial under the models section.<br />
<br />
<pre><br />
MESH2D<br />
E3T 1 4 1 3 2<br />
E3T 2 2 5 6 2<br />
E4Q 3 7 8 5 2 2<br />
.<br />
.<br />
.<br />
E4Q 1543 205 1226 1225 1221 2<br />
E4Q 1544 191 1222 1226 189 1<br />
E3T 1545 205 189 1226 2<br />
ND 1 -7.62907961e+001 4.00243909e+001 8.41808447e+001<br />
ND 2 -7.62907174e+001 4.00219296e+001 8.36614138e+001<br />
ND 3 -7.62907700e+001 4.00238340e+001 7.32122342e+001<br />
.<br />
.<br />
.<br />
ND 1222 -7.62811008e+001 4.00272795e+001 7.28898113e+001<br />
ND 1225 -7.62814608e+001 4.00273631e+001 7.29479847e+001<br />
ND 1226 -7.62812859e+001 4.00271526e+001 7.41231480e+001<br />
NS 1 3 10 15 6 -2<br />
NS 126 127 128 129 173 -194<br />
NS 1006 988 987 989 968 948 931 930 929 906<br />
NS -904<br />
NS 720 701 699 686 680 664 649 648 647 640<br />
NS -621<br />
BEGPARAMDEF<br />
GM "Gen2DM"<br />
SI 0<br />
DY 1<br />
TU "minutes"<br />
TD 20 1000<br />
KEY "sms-gen2dm"<br />
PG "Hydrodynamic" 1<br />
PD "Time interval" 1 20 0 2147483647<br />
PD "Velocity max (ft/sec)" 2 75 0 100<br />
PD "H min" 2 0.25 0 1.79769e+308<br />
PD "A min" 2 1 1e-015 1.79769e+308<br />
PD "Check for dry elements" 0 1<br />
PD "Element style" 3 "quadratic"<br />
PD "Critical scour velocity" 4 "2.0 ft/sec"<br />
PO "0.8 ft/sec" "2.0 ft/sec" "2.6 ft/sec"<br />
PG "Sediment transport" 0<br />
PD "Time interval" 1 10 0 2147483647<br />
PD "Source X postion" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Source Y position" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Source elevation" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Parcel mass (slug)" 2 0.5 0.0001 1.79769e+308<br />
PD "Particle mass (slug)" 2 0.003 0.0001 1.79769e+308<br />
PD "Particle size (in)" 2 0.05 0 1.79769e+308<br />
PD "Deviation" 2 0 -1.79769e+308 1.79769e+308<br />
PD "Average density (slug/ft^3)" 2 3 1.5 6<br />
NUME 3<br />
BCPGC 1<br />
BEDISP 0 2 0 0 0 1 1 1 255 128 255 1<br />
BEFONT 0 1<br />
BD 0 "Water sink/source" 2 3 "Flow rate (cfs)" "Water temperature (F)" "Flow rate(cfs)" 1 "(none)"<br />
BV "Flow rate (cfs)" 0 -1.79769e+308 1.79769e+308<br />
BV "Water temperature (F)" 65 32.5 100<br />
BV "Flow rate(cfs)" 0 0 1.79769e+308<br />
BCDISP 0 2 10 1 0 255 255 1<br />
BD 0 "Ceiling (pressure flow)" 1 1 "Ceiling (ft above sea level)" 0 "(none)"<br />
BV "Ceiling (ft above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BCDISP 0 1 3 1 128 128 255 1<br />
BD 0 "Water surface observation gauge" 3 0 1 "(none)"<br />
BCDISP 0 3 3 1 255 128 128 1<br />
BEDISP 1 0 0 255 1 1 1 0 255 128 0 1<br />
BEFONT 1 1<br />
BD 1 "Water surface" 1 3 "Elevation" "Essential/Natural factor" "Vary along nodestring factor" 0 "(none)"<br />
BV "Elevation" 0 -1.79769e+308 1.79769e+308<br />
BV "Essential/Natural factor" 0 0 1<br />
BV "Vary along nodestring factor" 1 0 10<br />
BCDISP 1 1 5 0 255 0 0 1<br />
BD 1 "Flow" 2 1 "Flow rate (cfs)" 0 "(none)"<br />
BV "Flow rate (cfs)" 0 0 1.79769e+308<br />
BCDISP 1 2 5 0 128 255 0 1<br />
BD 1 "Supercritical" 3 0 0 "(none)"<br />
BCDISP 1 3 1 0 0 0 0 1<br />
BD 1 "1D weir segment" 4 4 "Discharge coefficient" "Weir width (ft)" "Crest level (m above sea level)" "Equation (0 = water level / 1 = energy head)" 1 "(none)"<br />
BV "Discharge coefficient" 1 0 1.79769e+308<br />
BV "Weir width (ft)" 1 0 1.79769e+308<br />
BV "Crest level (m above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BV "Equation (0 = water level / 1 = energy head)" 0 0 1<br />
BCDISP 1 4 1 0 0 0 0 0<br />
BD 1 "Sediment trap" 5 0 1 "Sediment transport"<br />
BCDISP 1 5 1 0 0 0 0 1<br />
BEDISP 2 2 0 0 0 1 1 0 0 0 0 1<br />
BEFONT 2 1<br />
BD 2 "2D weir" 1 3 "Discharge coefficient" "Crest level (ft above sea level)" "Equation (0 = water level / 1 = energy head)" 1 "(none)"<br />
BV "Discharge coefficient" 1 0 1.79769e+308<br />
BV "Crest level (ft above sea level)" 0 -1.79769e+308 1.79769e+308<br />
BV "Equation (0 = water level / 1 = energy head)" 0 0 1<br />
BCDISP 2 1 1 0 0 0 0 1<br />
MD 2 "Manning" "Kinematic eddy viscosity"<br />
MV "Manning" 0.035 0.01 0.18<br />
MV "Kinematic eddy viscosity" 0 -1.79769e+308 1.79769e+308<br />
ENDPARAMDEF<br />
BEG2DMBC<br />
MAT 1 0.03 20<br />
MAT 2 0.045 20<br />
GG "Hydrodynamic"<br />
GP "Time interval" 20<br />
GP "Velocity max (ft/sec)" 75<br />
GP "H min" 0.25<br />
GP "A min" 1<br />
GP "Check for dry elements" 1<br />
GP "Element style" "quadratic"<br />
GP "Critical scour velocity" "2.0 ft/sec"<br />
GG "Sediment transport"<br />
GP "Time interval" 10<br />
GP "Source X postion" 0<br />
GP "Source Y position" 0<br />
GP "Source elevation" 0<br />
GP "Parcel mass (slug)" 0.5<br />
GP "Particle mass (slug)" 0.003<br />
GP "Particle size (in)" 0.05<br />
GP "Deviation" 0<br />
GP "Average density (slug/ft^3)" 3<br />
BCN 772 3<br />
BCN 774 3<br />
BCN 776 3<br />
.<br />
.<br />
.<br />
BCS 4 5<br />
BCS 1 1 80 0 1<br />
BCE 1293 1 1 0 0<br />
TIME 20<br />
BCS 2 2 380<br />
TIME 40<br />
BCS 2 2 400<br />
TIME 60<br />
BCS 2 2 380<br />
TIME 80<br />
BCS 2 2 300<br />
TIME 100<br />
BCS 2 2 300<br />
TIME 120<br />
BCS 2 2 300<br />
TIME 140<br />
BCS 2 2 300<br />
TIME 160<br />
BCS 2 2 300<br />
TIME 180<br />
BCS 2 2 300<br />
TIME 200<br />
BCS 2 2 300<br />
TIME 220<br />
BCS 2 2 300<br />
TIME 240<br />
BCS 2 2 300<br />
TIME 260<br />
BCS 2 2 300<br />
TIME 280<br />
BCS 2 2 300<br />
TIME 300<br />
BCS 2 2 300<br />
TIME 320<br />
BCS 2 2 300<br />
TIME 340<br />
BCS 2 2 300<br />
TIME 360<br />
BCS 2 2 300<br />
TIME 380<br />
BCS 2 2 300<br />
TIME 400<br />
BCS 2 2 300<br />
TIME 420<br />
BCS 2 2 300<br />
TIME 440<br />
BCS 2 2 300<br />
TIME 460<br />
BCS 2 2 300<br />
TIME 480<br />
BCS 2 2 300<br />
TIME 500<br />
BCS 2 2 300<br />
TIME 520<br />
BCS 2 2 300<br />
TIME 540<br />
BCS 2 2 300<br />
TIME 560<br />
BCS 2 2 300<br />
TIME 580<br />
BCS 2 2 300<br />
TIME 600<br />
BCS 2 2 300<br />
TIME 620<br />
BCS 2 2 300<br />
TIME 640<br />
BCS 2 2 300<br />
TIME 660<br />
BCS 2 2 300<br />
TIME 680<br />
BCS 2 2 300<br />
TIME 700<br />
BCS 2 2 300<br />
TIME 720<br />
BCS 2 2 300<br />
TIME 740<br />
BCS 2 2 300<br />
TIME 760<br />
BCS 2 2 300<br />
TIME 780<br />
BCS 2 2 300<br />
TIME 800<br />
BCS 2 2 300<br />
TIME 820<br />
BCS 2 2 300<br />
TIME 840<br />
BCS 2 2 300<br />
TIME 860<br />
BCS 2 2 300<br />
TIME 880<br />
BCS 2 2 300<br />
TIME 900<br />
BCS 2 2 300<br />
TIME 920<br />
BCS 2 2 300<br />
TIME 940<br />
BCS 2 2 300<br />
TIME 960<br />
BCS 2 2 300<br />
TIME 980<br />
BCS 2 2 300<br />
TIME 1000<br />
BCS 2 2 300<br />
END2DMBC<br />
</pre><br />
<br />
= Related Topics =<br />
* [[SMS:File Formats|File Formats]]<br />
* [[SMS:Generic_Model_Files|Generic Model Files]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]]<br />
* [[SMS:SRH-2D|SRH-2D]]<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|2]]<br />
[[Category:Generic Model|2]]<br />
[[Category:SMS File Formats|2]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:Export_Map_Data_in_Shape_Format&diff=84946SMS:Export Map Data in Shape Format2015-04-10T14:29:28Z<p>Morelandtom: /* Export */</p>
<hr />
<div>====Export====<br />
To export feature objects in a map coverage to a shape file (*.shp):<br />
#Load or create feature objects in a map module coverage.<br />
#Select ''File'' | '''Save As'''<br />
#Select ''Save as type:'' and choose "Shape Files (*.shp)"<br />
#In the ''Export Shapefile'' dialog, select the feature object types to be saved. <br />
#Click '''Ok'''<br />
<br />
Shape files are created for the selected feature object types.<br />
<br />
====Import====<br />
Open the saved XML file to import the data from the shape file.<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
{{stub}}<br />
<br />
[[Category:SMS File Formats]]<br />
[[Category:SMS Map]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=GMS:Creating_a_TIN&diff=84735GMS:Creating a TIN2015-04-02T22:07:16Z<p>Morelandtom: /* Copying a Current TIN */</p>
<hr />
<div>{{TIN links}}<br />
In order to create a TIN in GMS, there must be a set of TIN vertices. Then the TIN is created by triangulating the vertices (connecting the vertices with lines to form triangles). The [[GMS:Triangulation|triangulation]] algorithm assumes that each of the vertices being triangulated is unique in the xy plane, i.e., no two points have the same xy location. Duplicate points can be removed by selecting '''Find Duplicates''' from the ''TINs'' menu.<br />
<br />
TINs can be created 3 different ways in GMS: manually entering the vertex locations and triangulating, converting a different GMS data type to a TIN, and copying a currently existing TIN.<br />
<br />
=== Manually Creating a TIN ===<br />
<br />
A TIN can be created manually from the following steps:<br />
<br />
#Right-click in the empty space of the [[GMS:Project Explorer|Project Explorer]] and select the '''New &rarr; TIN''' command.<br />
#Select the '''Create Vertices''' tool from the [[GMS:TIN Tool Palette|TIN Tool Palette]].<br />
#Create the vertices by clicking inside the Graphics Window at the xy coordinates where the vertex is to be located. (To change the vertex location see: [[GMS:Editing a TIN|Editing a TIN]])<br />
#Select the [[GMS:Triangulation|'''Triangulate''']] command from the ''TINs'' menu.<br />
<br />
=== Creating a TIN from GMS Data ===<br />
<br />
[[GMS:2D Mesh Module|2D meshes]], [[GMS:2D Grid Module|2D grids]], and [[GMS:2D Scatter Point Module|2D scatter points]] can all be converted to a TIN. This is accomplished by using the following commands:<br />
<br />
*[[GMS:2D Mesh Module#Converting a 2D Mesh to other types of Data|Mesh to TIN]]<br />
*[[GMS:2D Grid Module#Converting 2D Grids|Grid to TIN]]<br />
*[[GMS:2D Scatter Point Module#Converting 2D Scatter Points to Other Types of Data|Scatter Points to TIN]] <br />
*[[GMS:Converting Borehole Data|Contacts to TIN]]<br />
*[[GMS:Converting Borehole Data|Watertable to TIN]]<br />
*'''Add Contacts to TIN''' &ndash; This command is used to enter a point from a contact into the active TIN . The contact(s) are first selected and the command is then chosen from the ''Borehole'' menu. Typically all contacts which should be part of a TIN are selected before generating the TIN, but sometimes one is inadvertently left out, or more boreholes are added later.<br />
<br />
=== Copying a Current TIN ===<br />
To make a copy of a TIN that currently exists in GMS follow these steps:<br />
<br />
#Select the TIN to be copied using the '''Select TINs''' tool.<br />
#Select the '''Duplicate TIN''' command from the right-click menu. A dialog appears prompting for the Z-offset of the new TIN. The Z offset is used to displace the TIN above or below the TIN being duplicated.<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:TINs]]<br />
{{stub}}<br />
<!-- The commands need to be given a basic definition so as to avoid giving the reader the run around.--></div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=73300SMS:SMS Models2014-07-08T17:22:57Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of [[SMS:SMS|SMS]].<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW-FV|TUFLOW-FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. We are aware of partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:TABS&diff=72318SMS:TABS2014-06-17T16:56:03Z<p>Morelandtom: /* Using the Model / Practical Notes */</p>
<hr />
<div>The TABS-MD (Multi-Dimensional) Numerical Modeling System was one of the first widely used collection of programs designed for studying multi-dimensional hydrodynamics in rivers, reservoirs, bays and estuaries. The hydrodynamic engine for the system is the RMA2 engine. RMA2 and RMA4 were written by Resource Management Associates, Lafayette, California, and modified by WES. SED2D was written jointly by Resource Management Associates and WES.<br />
<br />
== Models ==<br />
===GFGEN===<br />
The pre-processor for the TABS software programs. This utility converts ASCII geometry into binary format and does data checking along the way. SMS will launch this utility as needed before running other components of the system. See [[SMS:GFGEN|GFGEN]] for more information.<br />
<br />
===RMA2===<br />
A one-dimensional/two-dimensional numerical model for depth-averaged flow and water levels.<br />
RMA2 is a two dimensional depth averaged finite element hydrodynamic numerical model. It computes water surface elevations and horizontal velocity components for subcritical, free-surface flow in two dimensional flow fields. [[SMS:RMA2 | RMA2]] computes a finite element solution of the Reynolds form of the Navier-Stokes equations for turbulent flows. Friction is calculated with the Manning’s or Chezy equation, and eddy viscosity coefficients are used to define turbulence characteristics. Both steady and unsteady state (dynamic) problems can be analyzed.<br />
<br />
It should be noted that the commercially available version of the model does not include all functionality included in the ERDC documentation.<br />
<br />
See [[SMS:RMA2|RMA2]] for more information.<br />
<br />
===RMA4===<br />
A one-dimensional/two-dimensional numerical model for depth-averaged transport. This program uses a provided hydrodynamic solution (either node by node or in RMA2 format) to compute transport of a constituent in solution. It is assumed that the depth concentration distribution is uniform. While model documentation claims up to six constituents can be considered simultaneously, practical application has shown the only application of multiple constituents to be DO/BOD. Either conservative or non-conservative diffusion is computed. See [[SMS:RMA4 | RMA4]] for more information.<br />
<br />
===SED2D===<br />
Formerly STUDH, a two-dimensional numerical model for depth-averaged transport of cohesive or a representative grain size of noncohesive sediments and their deposition, erosion, and formation of bed deposits.<br />
The interface for this model has been removed from version SMS 10.0. Boundary condition files can still be constructed/edited in text editors and SMS can still read solution data.<br />
<br />
===RMA10===<br />
A one-dimensional/two-dimensional/three-dimensional hydrodynamic numerical model. Not available for public use at this time.<br />
<br />
== Using the Model / Practical Notes ==<br />
* The TABS models are built to expire after a set date. You can download the latest version from the [http://www.aquaveo.com/ Downloads section of the Aquaveo website].<br />
<br />
== Related Links ==<br />
* [[SMS:SMS Models|SMS Models page]]<br />
<br />
== External Links ==<br />
* CHL TABS Numerical Modeling website [http://chl.erdc.usace.army.mil/chl.aspx?p=s&a=Software;10]<br />
* CHL RMA2 Frequently Asked Questions [http://chl.erdc.usace.army.mil/chl.aspx?p=s&a=ARTICLES;365]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TABS]]<br />
[[Category:TABS|TABS]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=71726SMS:SMS Models2014-06-05T16:50:15Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of [[SMS:SMS|SMS]].<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW-FV|TUFLOW-FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. We are aware of partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2005 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=71725SMS:SMS Models2014-06-05T16:45:55Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of [[SMS:SMS|SMS]].<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW-FV|TUFLOW-FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. We are aware of partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.5 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtomhttps://www.xmswiki.com/index.php?title=SMS:SMS_Models&diff=71724SMS:SMS Models2014-06-05T16:41:48Z<p>Morelandtom: /* Model versions */</p>
<hr />
<div>[[SMS:SMS|SMS]] provides pre- and post- processing for several numeric models. These models are developed and maintained by government or commercial entities rather than the developers of [[SMS:SMS|SMS]].<br />
<br />
==Hydraulic Models==<br />
*[[SMS:ADCIRC|ADCIRC (ADvanced CIRCulation Model)]] &ndash; Widely applied coastal circulation and coastal flooding model. Developed commercially.<br />
*[[SMS:CMS|Coastal Modeling System CMS-FLOW]] &ndash; Suite of models that simulates a wide variety of coastal processes. Developed and maintained by the USACE.<br />
*[[SMS:FESWMS|FESWMS]] &ndash; Developed in cooperation with the Federal Highway Administration (FHWA).<br />
* Accessed through the [[SMS:Generic|generic model interface]] in cooperation with Aquaveo<br />
<blockquote><br />
*[[SMS:SRH-2D|SRH-2D]] &ndash; Developed at the United States Bureau of Reclamation.<br />
*[[SMS:RIVERFLO-2D|RIVERFLO-2D]] &ndash; Commercially developed finite element model to route floods. Provides high resolution flood hydraulics.<br />
*[[SMS:HYDRO_AS-2D|HYDRO AS-2D]] &ndash; Developed commercially in Germany.<br />
*[[SMS:TUFLOW-FV|TUFLOW-FV]] &ndash; Finite volume model developed by the makers of TUFLOW (WBM).<br />
</blockquote><br />
*[[SMS:TABS|TABS]] &ndash; Suite of models for solving hydrodynamics and transport problems maintained by the USACE.<br />
*[[SMS:TUFLOW|TUFLOW]] &ndash; Finite difference model featuring combined 1D/2D models, very stable wetting drying, and advanced simulation management for Coastal, Riverine or Urban applications.<br />
<br />
==Wave Models==<br />
===Harbor Design===<br />
*[[SMS:BOUSS-2D|BOUSS-2D]] &ndash; Wave climate, circulation from waves, and sea state using the Boussinesque equations<br />
*[[SMS:CGWAVE|CGWAVE]] &ndash; Phase resolving wave reflection and refraction analysis<br />
<br />
===Wave Generation and Transformation===<br />
*[[SMS:STWAVE|STWAVE]] &ndash; Finite difference spectral wave energy model<br />
*[[SMS:CMS-Wave|CMS-Wave (WABED)]]<br />
<br />
==Other Models==<br />
*[[SMS:Generic|Generic]] &ndash; Rather than a specific model interface, the "Generic" model interface in the mesh module is a collection of interface objects that can be configured by the user to generate specific types of data. The developers at Aquaveo work with some engine developers to utilize this tool. These engines are included in the list above. Other model developers are encouraged to contact Aquaveo for assistance in using these tools. The tools of the generic model interface can be utilized without coordination with Aquaveo. We are aware of partial interfaces with the following:<br />
<blockquote><br />
* [[SMS:FVCOM|FVCOM]]<br />
* [[SMS:HYDRO AS-2D|HYDRO AS-2D]] <br />
* [[SMS:SRH-2D|SRH-W ]]<br />
</blockquote><br />
*[[SMS:PTM|PTM]] &ndash; Lagrangian Particle Tracking Model which tracks sediment particles based upon input hydrodynamics and wave effects.<br />
<br />
==Hydraulic Models (Feature Comparison)==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| Riverine<br />
!style="background: #cccccc;" width="100"| Tidal Forcing<br />
!style="background: #cccccc;" width="100"| Wave Forcing<br />
!style="background: #cccccc;" width="100"| 1D<br />
!style="background: #cccccc;" width="100"| 2D<br />
!style="background: #cccccc;" width="100"| Hydraulic Structures<br />
!style="background: #cccccc;" width="100"| Sediment Transport<br />
!style="background: #cccccc;" width="100"| Advection / Dispersion<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: red;"| no <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: lime;"| yes <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: red;"| no <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: red;"| no <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: red;"| no <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: lime;"| yes <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: lime;"| yes <!-- Advection/Dispersion--><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: lime;"| yes <!-- Riverine --><br />
|style="background: lime;"| yes <!-- Tidal Forcing --><br />
|style="background: red;"| no <!-- Wave Forcing --><br />
|style="background: lime;"| yes <!-- 1D --><br />
|style="background: lime;"| yes <!-- 2D --><br />
|style="background: lime;"| yes <!-- Hydraulic Structures --><br />
|style="background: red;"| no <!-- Sediment Transport --><br />
|style="background: red;"| no <!-- Advection/Dispersion--><br />
|}<br />
<br />
<br />
==Model Linkages / Steering==<br />
<br />
* [[SMS:Steering|General Steering]]<br />
* [[SMS:RMA2 Spindown|RMA2 Spindown]]<br />
* [[SMS:FESWMS Spindown|FESWMS Spindown]]<br />
* [[SMS:CMS-Flow/CMS-Wave Steering|CMS-Flow / CMS-Wave Steering]]<br />
<br />
==Model versions==<br />
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 800px"<br />
<br />
|- <br />
!style="background: #cccccc;" width="100"| Model<br />
!style="background: #cccccc;" width="100"| SMS v11.2<br />
!style="background: #cccccc;" width="100"| SMS v11.1<br />
!style="background: #cccccc;" width="100"| SMS v11.0<br />
!style="background: #cccccc;" width="100"| SMS v10.1<br />
|-<br />
!style="background: #ececec;"| [[SMS:ADCIRC|ADCIRC]]<br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 50.99 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 49.82 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 48.46 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:ADH|ADH]]<br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:BOUSS-2D|BOUSS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CGWAVE|CGWAVE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Flow|CMS-Flow]]<br />
|style="background: #ececec;"| 4.02.00 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.75.07 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.75.05 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.75.02 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:CMS-Wave|CMS-Wave]]<br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:FESWMS|FESWMS]]<br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 3.3.2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:GenCade|GenCADE]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| N/A <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:HYDRO_AS-2D|Hydro AS-2D]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| V3 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| V2 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:PTM|PTM]]<br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2.1.027 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0.064 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0.053 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:SRH|SRH]]<br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 3.0 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2.0 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:STWAVE|STWAVE]]<br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 6.1 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 6.0 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 5.6 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA2]]<br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.58 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TABS|TABS-RMA4]]<br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 4.56 <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:TUFLOW|TUFLOW]]<br />
|style="background: #ececec;"| 2013-12-AC <!-- SMS v11.2 --><br />
|style="background: #ececec;"| 2012-05-AE <!-- SMS v11.1 --><br />
|style="background: #ececec;"| 2011-09-AF <!-- SMS v11.0 --><br />
|style="background: #ececec;"| 2009-07-AC <!-- SMS v10.1 --><br />
|-<br />
!style="background: #ececec;"| [[SMS:WAM|WAM]]<br />
|style="background: #ececec;"| <!-- SMS v11.2 --><br />
|style="background: #ececec;"| <!-- SMS v11.1 --><br />
|style="background: #ececec;"| <!-- SMS v11.0 --><br />
|style="background: #ececec;"| N/A <!-- SMS v10.1 --><br />
|}<br />
<br />
== Related Topics ==<br />
* [[SMS:SMS|SMS Main page]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
<br />
[[Category:SMS Models]]<br />
[[Category:Numerical Models|S]]</div>Morelandtom