User:Jcreer/Gen2DM File Format: Difference between revisions
| (14 intermediate revisions by the same user not shown) | |||
| Line 13: | Line 13: | ||
A quadratic quadrilateral element (4 vertices, 4 mid points, an element centered node) – element ID (integer), 1st vertex node ID (integer), 1st mid point node ID (integer), 2nd vertex node ID (integer), 2nd midpoint node ID (integer), 3rd vertex node ID (integer), 3rd mid point node ID (integer), 4th vertex node ID (integer), 4th mid point node ID (integer), the element centered node ID (integer), element material type ID (integer) | A quadratic quadrilateral element (4 vertices, 4 mid points, an element centered node) – element ID (integer), 1st vertex node ID (integer), 1st mid point node ID (integer), 2nd vertex node ID (integer), 2nd midpoint node ID (integer), 3rd vertex node ID (integer), 3rd mid point node ID (integer), 4th vertex node ID (integer), 4th mid point node ID (integer), the element centered node ID (integer), element material type ID (integer) | ||
Note: The E3T, E4Q, E6T, E8Q and E9Q cards may be intermixed in the written order. The mesh is written by starting with one element and listing neighboring elements. The node IDs for these cards are in counterclockwise order around the element (ending with the centroid node for EQ9s). Each card will be written only if an element of the type is present in the mesh. | *'''''Note:''''' The E3T, E4Q, E6T, E8Q and E9Q cards may be intermixed in the written order. The mesh is written by starting with one element and listing neighboring elements. The node IDs for these cards are in counterclockwise order around the element (ending with the centroid node for EQ9s). Each card will be written only if an element of the type is present in the mesh. | ||
===ND 3260 -7.62822790e+001 4.00306200e+001 7.40765873e+001=== | ===ND 3260 -7.62822790e+001 4.00306200e+001 7.40765873e+001=== | ||
A node – node ID (integer), x position (real number), y position (real number), z position (real number) | A node – node ID (integer), x position (real number), y position (real number), z position (real number) | ||
Note: The xyz positions are positive/negative one digit with eight decimal places followed by “e” (times ten to the…) positive/negative power real numbers. | *'''''Note:''''' The xyz positions are positive/negative one digit with eight decimal places followed by “e” (times ten to the…) positive/negative power real numbers. | ||
===NS 567 2489 568 2545 594 2626 630 2702 -663=== | ===NS 567 2489 568 2545 594 2626 630 2702 -663=== | ||
A nodestring – nodestring head node ID, 1st vertex node ID (if any),… last vertex node ID (if any), nodestring tail node ID | A nodestring – nodestring head node ID, 1st vertex node ID (if any),… last vertex node ID (if any), nodestring tail node ID | ||
Note: The nodestring tail is denoted by a negative sign in front of the tail node ID. A nodestring may consist of more than ten nodes which constitute a file line, consequently a nodestring may extend multiple NS cards. Each sequential line should be read until the negative tail node ID is found, ending the nodestring definition. If no nodestrings are present in the mesh, this card will not be written. | *'''''Note:''''' The nodestring tail is denoted by a negative sign in front of the tail node ID. A nodestring may consist of more than ten nodes which constitute a file line, consequently a nodestring may extend multiple NS cards. Each sequential line should be read until the negative tail node ID is found, ending the nodestring definition. If no nodestrings are present in the mesh, this card will not be written. | ||
*'''''Note:''''' Node IDs for all cards above are limited to six digits (i.e. 999999 maximum). | |||
===BEGPARAMDEF=== | ===BEGPARAMDEF=== | ||
Denotes the end of the mesh data (begun by MESH2D) and the beginning of the Gen2DM model definition – no data | Denotes the end of the mesh data (begun by MESH2D) and the beginning of the Gen2DM model definition – no data | ||
| Line 28: | Line 31: | ||
Gen2DM model name – model name (text) | Gen2DM model name – model name (text) | ||
Note: Text is always delimited by quotation marks. | *'''''Note:''''' Text is always delimited by quotation marks. | ||
===SI 0=== | ===SI 0=== | ||
Using International System of Units – 0 (false) or 1 (true) | Using International System of Units – 0 (false) or 1 (true) | ||
===DY 1=== | ===DY 1=== | ||
Dynamic model – 0 (false) or 1 (true) | Dynamic model – 0 (false) or 1 (true) | ||
===TU "minutes" | ===TU "minutes"=== | ||
Time units –time unit name (text) | Time units –time unit name (text) | ||
===TD 20 1000=== | ===TD 20 1000=== | ||
Dynamic time data – time step length (integer/real number), maximum model time (integer/real number) | Dynamic time data – time step length (integer/real number), maximum model time (integer/real number) | ||
Note: TD data is written as an integer when possible or written as a real number if decimal places are not all zeroes. | *'''''Note:''''' TD data is written as an integer when possible or written as a real number if decimal places are not all zeroes. | ||
===KEY "sms-gen2dm"=== | ===KEY "sms-gen2dm"=== | ||
Gen2DM model definition informal security password – key (text) | Gen2DM model definition informal security password – key (text) | ||
Note: This card is only written when the model definition is locked at time of saving. | *'''''Note:''''' This card is only written when the model definition is locked at time of saving. | ||
===GP 1 "Hydrodynamic" 1=== | ===GP 1 "Hydrodynamic" 1=== | ||
Global parameter group – id, group name (text), activity state: 0 (false) or 1 (true) | Global parameter group – id, group name (text), activity state: 0 (false) or 1 (true) | ||
| Line 58: | Line 65: | ||
Type is four (option type): …default selection (text) | Type is four (option type): …default selection (text) | ||
Note: The GP_OPTS card is only written when the previous GP_DEF card has a parameter type of four. The default value of the option parameter should be one of the options list in the GP_OPTS card line. | *'''''Note:''''' The GP_OPTS card is only written when the previous GP_DEF card has a parameter type of four. The default value of the option parameter should be one of the options list in the GP_OPTS card line. | ||
Note: Maximum/minimum integer values of 2147483648 and -2147483647 are understood as no bounds. The integer limits are characterized by four bytes. Maximum/minimum real number values of 1.79769e+308 and -1.79769e+308 are understood as no bounds. The real number limits are characterized by eight bytes. | *'''''Note:''''' Maximum/minimum integer values of 2147483648 and -2147483647 are understood as no bounds. The integer limits are characterized by four bytes. Maximum/minimum real number values of 1.79769e+308 and -1.79769e+308 are understood as no bounds. The real number limits are characterized by eight bytes. | ||
===GP_OPTS 1 7 "0.8 ft/sec" "2.0 ft/sec" "2.6 ft/sec"=== | ===GP_OPTS 1 7 "0.8 ft/sec" "2.0 ft/sec" "2.6 ft/sec"=== | ||
| Line 78: | Line 85: | ||
Boundary entity label font – entity type ID (integer), font information (integers and text) (if necessary) | Boundary entity label font – entity type ID (integer), font information (integers and text) (if necessary) | ||
Note: The font information may be represented by a single integer or represented by multiple integers and a font name. | *'''''Note:''''' The font information may be represented by a single integer or represented by multiple integers and a font name. | ||
Note: The BEDISP and BEFONT cards are written before the entity’s boundary condition and values (if any) are written. The next instance of these cards will begin the next entity. The entity type ID equals zero for node, one for nodestring and two for element. | *'''''Note:''''' The BEDISP and BEFONT cards are written before the entity’s boundary condition and values (if any) are written. The next instance of these cards will begin the next entity. The entity type ID equals zero for node, one for nodestring and two for element. | ||
===BC 0 "Water sink/source” 1 0 1 -1 “(none)”=== | ===BC 0 "Water sink/source” 1 0 1 -1 “(none)”=== | ||
| Line 115: | Line 122: | ||
===BC_VAL N 3226 2 1 7.7=== | ===BC_VAL N 3226 2 1 7.7=== | ||
Boundary condition assignment – entity type (N = node, E = element, S = nodestring), entity id (node id, element id or nodestring id), group parameter id, parameter id, value (float, int, text, etc) | Boundary condition assignment – entity type (N = node, E = element, S = nodestring), entity id (node id, element id or nodestring id), group parameter id, parameter id, value (float, int, text, etc) | ||
Note: These cards are only written if the data that exists is different than the default data. | |||
*'''''Note:''''' These cards are only written if the data that exists is different than the default data. | |||
===END2DMBC=== | ===END2DMBC=== | ||
Denotes the ending of the Gen2DM model assignment (begun by BEG2DMBC) – no data | Denotes the ending of the Gen2DM model assignment (begun by BEG2DMBC) – no data | ||
This concludes the “*.2dm” file format. | This concludes the “*.2dm” file format. | ||
[[Category:Jcreer|Gen2dm]] | |||
Latest revision as of 14:47, 21 July 2017
MESH2D
Denotes the beginning of the mesh data – no data
E3T 94 1103 1101 1102 2
A linear triangular element (3 vertices) – element ID (integer), 1st vertex node ID (integer), 2nd vertex node ID (integer), 3rd vertex node ID (integer), element material type ID (integer)
E4Q 95 103 388 387 104 2
A linear quadratic element (4 vertices) – element ID (integer), 1st vertex node ID (integer), 2nd vertex node ID (integer), 3rd vertex node ID (integer), 4th vertex node ID (integer), element material type ID (integer)
E6T 17 7 1254 25 1255 8 1256 2
A quadratic triangular element (3 vertices, 3 mid points) – element ID (integer), 1st vertex node ID (integer), 1st mid point node ID (integer), 2nd vertex node ID (integer), 2nd midpoint node ID (integer), 3rd vertex node ID (integer), 3rd mid point node ID (integer), element material type ID (integer)
E8Q 18 21 1248 7 1256 8 1257 26 1258 2
A quadratic quadrilateral element (4 vertices, 4 mid points) – element ID (integer), 1st vertex node ID (integer), 1st mid point node ID (integer), 2nd vertex node ID (integer), 2nd midpoint node ID (integer), 3rd vertex node ID (integer), 3rd mid point node ID (integer), 4th vertex node ID (integer), 4th mid point node ID (integer), element material type ID (integer)
E9Q 50 28 1315 53 1316 52 1317 27 1260 4630 2
A quadratic quadrilateral element (4 vertices, 4 mid points, an element centered node) – element ID (integer), 1st vertex node ID (integer), 1st mid point node ID (integer), 2nd vertex node ID (integer), 2nd midpoint node ID (integer), 3rd vertex node ID (integer), 3rd mid point node ID (integer), 4th vertex node ID (integer), 4th mid point node ID (integer), the element centered node ID (integer), element material type ID (integer)
- Note: The E3T, E4Q, E6T, E8Q and E9Q cards may be intermixed in the written order. The mesh is written by starting with one element and listing neighboring elements. The node IDs for these cards are in counterclockwise order around the element (ending with the centroid node for EQ9s). Each card will be written only if an element of the type is present in the mesh.
ND 3260 -7.62822790e+001 4.00306200e+001 7.40765873e+001
A node – node ID (integer), x position (real number), y position (real number), z position (real number)
- Note: The xyz positions are positive/negative one digit with eight decimal places followed by “e” (times ten to the…) positive/negative power real numbers.
NS 567 2489 568 2545 594 2626 630 2702 -663
A nodestring – nodestring head node ID, 1st vertex node ID (if any),… last vertex node ID (if any), nodestring tail node ID
- Note: The nodestring tail is denoted by a negative sign in front of the tail node ID. A nodestring may consist of more than ten nodes which constitute a file line, consequently a nodestring may extend multiple NS cards. Each sequential line should be read until the negative tail node ID is found, ending the nodestring definition. If no nodestrings are present in the mesh, this card will not be written.
- Note: Node IDs for all cards above are limited to six digits (i.e. 999999 maximum).
BEGPARAMDEF
Denotes the end of the mesh data (begun by MESH2D) and the beginning of the Gen2DM model definition – no data
GM "Gen2DM"
Gen2DM model name – model name (text)
- Note: Text is always delimited by quotation marks.
SI 0
Using International System of Units – 0 (false) or 1 (true)
DY 1
Dynamic model – 0 (false) or 1 (true)
TU "minutes"
Time units –time unit name (text)
TD 20 1000
Dynamic time data – time step length (integer/real number), maximum model time (integer/real number)
- Note: TD data is written as an integer when possible or written as a real number if decimal places are not all zeroes.
KEY "sms-gen2dm"
Gen2DM model definition informal security password – key (text)
- Note: This card is only written when the model definition is locked at time of saving.
GP 1 "Hydrodynamic" 1
Global parameter group – id, group name (text), activity state: 0 (false) or 1 (true)
GP_DEF 1 1 "Time interval" 1 20 0 2147483657
Global parameter definition – global group id, parameter id, parameter name (text), parameter type (integer), …
If the parameter type is zero (boolean type): …default value: 0 (false) or 1 (true)
Type is one (integer type): …default value (integer), minimum value (integer), maximum value (integer)
Type is two (real number type): …default value (real number), minimum value (real number), maximum value (real number)
Type is three (text type): …default value (text)
Type is four (option type): …default selection (text)
- Note: The GP_OPTS card is only written when the previous GP_DEF card has a parameter type of four. The default value of the option parameter should be one of the options list in the GP_OPTS card line.
- Note: Maximum/minimum integer values of 2147483648 and -2147483647 are understood as no bounds. The integer limits are characterized by four bytes. Maximum/minimum real number values of 1.79769e+308 and -1.79769e+308 are understood as no bounds. The real number limits are characterized by eight bytes.
GP_OPTS 1 7 "0.8 ft/sec" "2.0 ft/sec" "2.6 ft/sec"
Parameter option definitions for the global group id 1, parameter id 7 followed by the options. 1st option (text), 2nd option (text) (if any), …last option (text). These particular options are for “Critical scour velocity”.
NUME 3
Number of entities – number of entities available: nodes, nodestrings and elements (integer)
BCPGC 1
Boundary condition parameter group correlation – whether allowing boundary conditions to be correlated to parameter groups: 0 (false) or 1 (true)
DISP_OPTS entity 0 0 0 0 0 0 0 0
Display option for active nodes/elements or nodestrings
DISP_OPTS inactive 0 0 0 0 1 0 0 0
Display options for the inactive nodes/elements or nodestrings
DISP_OPTS multiple 0 0 0 0 1 0 0 0
Display options for multiple assigned boundary conditions for nodes/elements or nodestrings Boundary entity display options – entity type ID (integer), entity label color: red value (integer), entity label color: green value (integer), entity label color: blue value (integer), whether entity label is active: 0 (false) or 1 (true), pattern attributes (integer), size of the symbol (integer), and symbol attributes (integer)
BEFONT 1 -19 0 0 0 700 255 0 0 0 3 2 1 49 "Courier New"
Boundary entity label font – entity type ID (integer), font information (integers and text) (if necessary)
- Note: The font information may be represented by a single integer or represented by multiple integers and a font name.
- Note: The BEDISP and BEFONT cards are written before the entity’s boundary condition and values (if any) are written. The next instance of these cards will begin the next entity. The entity type ID equals zero for node, one for nodestring and two for element.
BC 0 "Water sink/source” 1 0 1 -1 “(none)”
Boundary condition definition – entity type id (integer), condition name (text), condition id (integer), 0 – (not used for backwards compatibility of older versions), legal on the interior of the mesh: 0 (false) or 1 (true), -1 (always constant), name of parameter group this condition is correlated with (text) Note: A group correlation name of (none) means the condition is a global condition and not parameter group specific.
BC_DEF 1 1 “Flow rate (cfs)” 2 0 0 1.79769e+308
(This card is similar to GP_DEF, expect we are defining definitions for boundary conditions) Boundary condition definition – condition id, parameter id, name (text), parameter type (integer), and the values associated with the type: default value, minimum value, maximum value (see GP_DEF)
BC_DEF_OPTS 1 1 “Flow rate (cfs)” 2 0 0 1.79769e+308
This card defines boundary condition options. See GP_DEF_OPTS for an explanation of this card.
BC_DISP_OPTS 3 0 0 0 0 1 0 1 1
Same as DISP_OPTS expect the first parameter is the boundary condition parameter id(3). All remaining fields are the same as DISP_OPTS.
MAT 1 “Channel”
Material definition. Id, name (text).
MAT_MULTI 0
MAT_MULTI 1 1
Multiple material assignments on/off. If on (1), then the selected parameter group id
MAT_DEF 1 1 "Manning" 2 0.035 0.01 0.18
Similar to GP_DEF and BC_DEF. See GP_DEF for more information.
MAT_DEP 2 1 3 "PARENT_LOCAL" "Manning" 0 "constant" 0 "vary by depth" 1
MAT_DEP 2 1 4 "PARENT_GLOBAL" "Friction type" 1 "Manning" 0 "Chezy" 1
Dependency card. Material id (integer), group id (integer), parameter id (integer), dependency type (parent_global, parent_local, parent_self, parent_none), parent name (string), active (Boolean), 1st option name (string), 1st option active (boolean), 2nd option name, 2nd option active…for each option.
ENDPARAMDEF
Denotes the end of the Gen2DM model definition (begun by BEGPARAMDEF) – no data
BEG2DMBC
Denotes the beginning of the Gen2DM model assignment – no data
GP_VAL 1 1 40
GP_VAL 1 6 “Chezy”
Global parameter assignment – global group id (integer), parameter id (integer), assigned value (float, int, text, etc)
MAT_VAL 1 1 2 0.05
Material assignment – material id (integer), group parameter id (integer), parameter id (integer), and value
BC_VAL E 1013 1 1 1
BC_VAL S 5 4 1 6.7
BC_VAL N 3226 2 1 7.7
Boundary condition assignment – entity type (N = node, E = element, S = nodestring), entity id (node id, element id or nodestring id), group parameter id, parameter id, value (float, int, text, etc)
- Note: These cards are only written if the data that exists is different than the default data.
END2DMBC
Denotes the ending of the Gen2DM model assignment (begun by BEG2DMBC) – no data This concludes the “*.2dm” file format.
