SMS:ADH Boundary Condition File Cards: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{SMS_Dev}}
{{TOCright}}
 
The following lists ADH *.bc cards that are (or will be) recognized by SMS and their capability (reading, editing values and writing) currently available within the interface. For a description of card specifics, please use the [https://chl.erdc.dren.mil/adh/documentation/AdH_Manual_Hydrodynamic-Version4.6.pdf ADH Manual]. SMS will ignore any card that is not listed below when reading a *.bc file.
The following lists ADH *.bc cards that are (or will be) recognized by SMS and their capability (reading, editing values and writing) currently available within the interface. For a description of card specifics, please use the [https://adh.usace.army.mil/ADH_Quickref/ ADH Quick Reference]. SMS will ignore any card that is not listed below when reading a *.bc file.


=== Constituent Properties ===
=== Constituent Properties ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Model Control Transport Constituents|Model Control Transport Constituents]] for interface information.
| colspan=7 | See [[SMS:ADH Transport Constituents|ADH Transport Constituents]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 26: Line 25:
=== Friction Controls ===
=== Friction Controls ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Boundary Condition Assignment|Boundary Condition Assignment]] for interface information.
| colspan=7 | See [[SMS:AdH Boundary Conditions|Boundary Conditions]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 41: Line 40:
=== Iteration Parameters ===
=== Iteration Parameters ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Model Control Model Parameters|Model Control Model Parameters]] for interface information.
| colspan=7 | See [[SMS:AdH Model Control|Model Control]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 65: Line 64:
=== Material Properties ===
=== Material Properties ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Model Control Global Material Properties|Model Control Global Material Parameters]] and [[SMS:ADH Material Properties|Material  Properties]] for interface information.
| colspan=7 | See [[SMS:AdH Model Control|Model Control]] and [[SMS:AdH Materials|Materials]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 106: Line 105:
=== Operation Parameters ===
=== Operation Parameters ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Model Control Model Parameters|Model Control Model Parameters]] for interface information.
| colspan=7 | See [[SMS:AdH Model Control|Model Control ]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 131: Line 130:
=== Output Controls ===
=== Output Controls ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Model Control Output|Model Control Output]] for interface information.
| colspan=7 | See [[SMS:AdH Model Control|Model Control]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 140: Line 139:
|-
|-
| valign="top" style="color:green" | OC || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
| valign="top" style="color:green" | OC || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
|-
| colspan="5" height="50" | [[#top | Top of page]] ||
|-
|}
|}
=== Solution Controls ===
=== Solution Controls ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Boundary Condition Assignment|Boundary Condition Assignment]] for nodal and nodestring boundary condition interface information.
| colspan=7 | See [[SMS:AdH Boundary Conditions|Boundary Conditions]] for nodal and nodestring boundary condition interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 160: Line 157:
| valign="top" style="color:green" | DB || valign="top" style="color:green" | OVL || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
| valign="top" style="color:green" | DB || valign="top" style="color:green" | OVL || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
|-
|-
| valign="top" style="color:green" | DB || valign="top" style="color:green" | TRN ||
| valign="top" style="color:green" | DB || valign="top" style="color:green" | TRN || || || || ||  
|-
|-
| valign="top" style="color:green" | EQ || valign="top" style="color:green" | TRN ||
| valign="top" style="color:green" | EQ || valign="top" style="color:green" | TRN || || || || ||  
|-
|-
| valign="top" style="color:green" | NB || valign="top" style="color:green" | DIS || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
| valign="top" style="color:green" | NB || valign="top" style="color:green" | DIS || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
Line 170: Line 167:
| valign="top" style="color:green" | NB || valign="top" style="color:green" | OVL || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | See the [[SMS:ADH Material Properties#Boundary Condition Assignment|Boundary Condition Assignment section of Material Properties]] for additional interface information.
| valign="top" style="color:green" | NB || valign="top" style="color:green" | OVL || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | See the [[SMS:ADH Material Properties#Boundary Condition Assignment|Boundary Condition Assignment section of Material Properties]] for additional interface information.
|-
|-
| valign="top" style="color:green" | NB || valign="top" style="color:green" | TRN ||
| valign="top" style="color:green" | NB || valign="top" style="color:green" | TRN || || || || ||
|-
|-
| valign="top" style="color:green" | OB || valign="top" style="color:green" | OF || align="center" valign="top" | X || align="center" valign="top" | --- || align="center" valign="top" | --- || || valign="top" | This card is obsolete as the functionality is now handled internally in ADH.
| valign="top" style="color:green" | OB || valign="top" style="color:green" | OF || align="center" valign="top" | X || align="center" valign="top" | --- || align="center" valign="top" | --- || || valign="top" | This card is obsolete as the functionality is now handled internally in ADH.
|-
|-
| valign="top" style="color:green" | OFF || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | This card can only be applied to a material string (<font color="green">MTS</font>). See the [[SMS:ADH Material Properties#Properties|Properties section of Material Properties]] for interface information.
| valign="top" style="color:green" | OFF || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | This card can only be applied to a material string (<font color="green">MTS</font>). See the [[SMS:ADH Material Properties#Properties|Properties section of Material Properties]] for interface information.
|-
| colspan="5" height="50" | [[#top | Top of page]] ||
|-
|}
|}


=== String Structures ===
=== String Structures ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH 2D Shallow Water Flow#Using the Model / Practical Notes|Practical Notes]] for string structure information.
| colspan=7 | See [[SMS:AdH#Using the Model / Practical Notes|Practical Notes]] for string structure information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 188: Line 182:
| valign="top" style="color:green" | EGS || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Use the [[SMS:2D Mesh Module Tools#Select_Nodestrings|Select Nodestring]] tool, and [[SMS:ADH Boundary Condition Assignment|assign boundary conditions]].
| valign="top" style="color:green" | EGS || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Use the [[SMS:2D Mesh Module Tools#Select_Nodestrings|Select Nodestring]] tool, and [[SMS:ADH Boundary Condition Assignment|assign boundary conditions]].
|-
|-
| valign="top" style="color:green" | FCS || ||
| valign="top" style="color:green" | FCS || || || || || ||
|-
|-
| valign="top" style="color:green" | MDS || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Use the [[SMS:2D Mesh Module Tools#Select_Nodestrings|Select Nodestring]] tool, and [[SMS:ADH Boundary Condition Assignment|assign boundary conditions]] for flow output.
| valign="top" style="color:green" | MDS || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Use the [[SMS:2D Mesh Module Tools#Select_Nodestrings|Select Nodestring]] tool, and [[SMS:ADH Boundary Condition Assignment|assign boundary conditions]] for flow output.
Line 195: Line 189:
|-
|-
| valign="top" style="color:green" | NDS || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Use the [[SMS:2D Mesh Module Tools#Select_Mesh Nodes|Select Node]] or [[SMS:2D Mesh Module Tools#Mesh Select Nodestrings|Select Nodestring]] tool, and [[SMS:ADH Boundary Condition Assignment|assign boundary conditions]].
| valign="top" style="color:green" | NDS || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Use the [[SMS:2D Mesh Module Tools#Select_Mesh Nodes|Select Node]] or [[SMS:2D Mesh Module Tools#Mesh Select Nodestrings|Select Nodestring]] tool, and [[SMS:ADH Boundary Condition Assignment|assign boundary conditions]].
|-
| colspan="5" height="50" | [[#top | Top of page]] ||
|-
|}
|}


=== Time Controls ===
=== Time Controls ===
{|class="wikitable"
{|class="wikitable"
| colspan=7 | See [[SMS:ADH Model Control Time|Model Control Time]] for interface information.
| colspan=7 | See [[SMS:ADH Model Control|Model Control]] for interface information.
|-
|-
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
| || || align="center" width="40px" | <u>Read</u> || align="center" width="40px" |  <u>Edit</u> || align="center" width="40px" |  <u>Write</u> || width="5px" | || <u>Notes</u>
Line 216: Line 207:
| valign="top" style="color:green" | TC || valign="top" style="color:green" | STD || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
| valign="top" style="color:green" | TC || valign="top" style="color:green" | STD || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
|-
|-
| valign="top" style="color:green" | TC || valign="top"  style="color:green" | STH
| valign="top" style="color:green" | TC || valign="top"  style="color:green" | STH || || || || ||
|-
|-
| valign="top" style="color:green" | TC || valign="top" style="color:green" | TF  || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
| valign="top" style="color:green" | TC || valign="top" style="color:green" | TF  || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || ||
|-
|-
| valign="top" style="color:green" | TC || valign="top" style="color:green" | T0  || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | SMS writes a "global time" character string in quotes preceding the regular card fields. The date/time information is used to relate the simulation with other data loaded in SMS concurrently.
| valign="top" style="color:green" | TC || valign="top" style="color:green" | T0  || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | SMS writes a "global time" character string in quotes preceding the regular card fields. The date/time information is used to relate the simulation with other data loaded in SMS concurrently.
|-
| colspan="5" height="50" | [[#top | Top of page]] ||
|-
|}
|}


Line 233: Line 221:
| valign="top" style="color:green" | XY1 || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Define series (curves) in various places. An output times series using the auto-build specifier can be read in and created, however, the auto-build format is not currently used when writing out.  SMS writes a series name character string in quotes preceding the regular card fields.
| valign="top" style="color:green" | XY1 || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Define series (curves) in various places. An output times series using the auto-build specifier can be read in and created, however, the auto-build format is not currently used when writing out.  SMS writes a series name character string in quotes preceding the regular card fields.
|-
|-
| valign="top" style="color:green" | XYC || ||
| valign="top" style="color:green" | XYC || || || || || ||
|-
|-
| valign="top" style="color:green" | XYT || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Available where series (curves) are defined as "curve fit tolerance".
| valign="top" style="color:green" | XYT || || align="center" valign="top" | X || align="center" valign="top" | X || align="center" valign="top" | X || || valign="top" | Available where series (curves) are defined as "curve fit tolerance".
|-
| colspan="5" height="50" | [[#top | Top of page]] ||
|-
|}
|}


==Related Topics==
==Related Topics==
[[SMS:ADH | ADH ]]
[[SMS:AdH | AdH ]]
 
[[Category:SMS_Dev]]




{{Template:Navbox SMS}}
{{Template:Navbox SMS}}
[[Category:ADH|B]]
[[Category:SMS File Formats|A]]
[[Category:SMS Boundary Conditions|A]]
[[Category:External Links]]

Latest revision as of 20:29, 11 September 2023


The following lists ADH *.bc cards that are (or will be) recognized by SMS and their capability (reading, editing values and writing) currently available within the interface. For a description of card specifics, please use the ADH Manual. SMS will ignore any card that is not listed below when reading a *.bc file.

Constituent Properties

See ADH Transport Constituents for interface information.
Read Edit Write Notes
CN CLA X X X SMS writes a constituent name character string in quotes preceding the regular card fields.
CN CON X X X SMS writes a constituent name character string in quotes preceding the regular card fields.
CN SAL
CN SLT X X X SMS writes a constituent name character string in quotes preceding the regular card fields.
CN SND X X X SMS writes a constituent name character string in quotes preceding the regular card fields.
CN TMP
CN VOR X X X

Friction Controls

See Boundary Conditions for interface information.
Read Edit Write Notes
FR ERH
FR MNG X X X A natural boundary condition without a specified friction card will have a roughness value of zero.
FR SAV
FR URV

Iteration Parameters

See Model Control for interface information.
Read Edit Write Notes
IP FLI X X X This card and the IP MIT card are mutually exclusive.
IP FNI X X X This card and the IP NIT card are mutually exclusive.
IP ITL X X X
IP MIT X X X This card and the IP FLI card are mutually exclusive.
IP NIT X X X This card and the IP FNI card are mutually exclusive.
IP NTL X X X
IP RTL
IP SST

Material Properties

See Model Control and Materials for interface information.
Read Edit Write Notes
MP CBA
MP COR X X X Material specific.
MP DF Material and transport constituent specific.
MP DTL X X X Global property.
MP EEV X X X Material specific.
MP EVS X X X Material specific.
MP G X X X Global property.
MP ML X X X Material specific.
MP MU X X X Global property.
MP MUC X X X The ADH units system flag currently keys off of the current horizontal coordinate system.
MP NBL
MP RHO X X X Global property.
MP SBA
MP SBM
MP SBN
MP SRT X X X Material specific.
MP TRT Material and transport constituent specific.

Operation Parameters

See Model Control for interface information.
Read Edit Write Notes
OP BLK X X X
OP BT X X X
OP BTS
OP INC X X X
OP PRE X X X
OP SW2 X --- X Always written by SMS (not editable), denotes a 2D Shallow Water ADH model
OP TPG
OP TRN
OP TEM

Output Controls

See Model Control for interface information.
Read Edit Write Notes
END X --- X Always written by SMS (not editable), denotes the end of the file.
FLX X X X See Boundary Condition Assignment for additional interface information.
OC X X X

Solution Controls

See Boundary Conditions for nodal and nodestring boundary condition interface information.
Read Edit Write Notes
DB LDE X X X
DB LDH X X X
DB LID X X X
DB OVH X X X
DB OVL X X X
DB TRN
EQ TRN
NB DIS X X X
NB OTW X X X
NB OVL X X X See the Boundary Condition Assignment section of Material Properties for additional interface information.
NB TRN
OB OF X --- --- This card is obsolete as the functionality is now handled internally in ADH.
OFF X X X This card can only be applied to a material string (MTS). See the Properties section of Material Properties for interface information.

String Structures

See Practical Notes for string structure information.
Read Edit Write Notes
EGS X X X Use the Select Nodestring tool, and assign boundary conditions.
FCS
MDS X X X Use the Select Nodestring tool, and assign boundary conditions for flow output.
MTS X X X Add and delete materials in the Materials Data window. Specify material properties, and using the Select Element tool, assign material type from the Elements | Assign Material Type... menu command.
NDS X X X Use the Select Node or Select Nodestring tool, and assign boundary conditions.

Time Controls

See Model Control for interface information.
Read Edit Write Notes
TC IAC X X X
TC IDT X X X
TC NDP X X X
TC SDI X X X
TC STD X X X
TC STH
TC TF X X X
TC T0 X X X SMS writes a "global time" character string in quotes preceding the regular card fields. The date/time information is used to relate the simulation with other data loaded in SMS concurrently.

Time Series

Read Edit Write Notes
XY1 X X X Define series (curves) in various places. An output times series using the auto-build specifier can be read in and created, however, the auto-build format is not currently used when writing out. SMS writes a series name character string in quotes preceding the regular card fields.
XYC
XYT X X X Available where series (curves) are defined as "curve fit tolerance".

Related Topics

AdH