CMS Input files/ASCII: Difference between revisions
m (→Dataset values) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
__notitle__ | __notitle__ | ||
<h1>ASCII Input File</h1> | |||
__toc__ | __toc__ | ||
If ASCII input files are required for whatever reason, the user can enter a Card into the parameter file, *.cmcards, that will instruct the CMS to write out ASCII representations of the input specified in various XMDF files. The CMS will then go through each input type and take the information and write it back out into separate ASCII files. | If ASCII input files are required for whatever reason, the user can enter a Card into the parameter file, *.cmcards, that will instruct the CMS to write out ASCII representations of the input specified in various XMDF files. The CMS will then go through each input type and take the information and write it back out into separate ASCII files. | ||
| Line 8: | Line 8: | ||
To ensure that the ASCII file CMS writes out can potentially be read back into the SMS, file formats that are already supported in the SMS were chosen to hold the information for various types of information. | To ensure that the ASCII file CMS writes out can potentially be read back into the SMS, file formats that are already supported in the SMS were chosen to hold the information for various types of information. | ||
=Boundary Conditions= | |||
Boundary conditions are specified along an external or internal a string of cells. For each boundary, a folder containing information is written to the file. | Boundary conditions are specified along an external or internal a string of cells. For each boundary, a folder containing information is written to the file. | ||
| Line 15: | Line 15: | ||
For each boundary condition, there will be one Boundary ID file and one or more Boundary Condition forcing data files. | For each boundary condition, there will be one Boundary ID file and one or more Boundary Condition forcing data files. | ||
==Boundary ID file== | |||
There may be multiple instances of River Flux and WSE boundary conditions for a single project. The cell IDs for all boundaries are written to one Boundary ID file. Each type of boundary condition is denoted by <BC_type> below. <BC_type> will consist of the following string: | There may be multiple instances of River Flux and WSE boundary conditions for a single project. The cell IDs for all boundaries are written to one Boundary ID file. Each type of boundary condition is denoted by <BC_type> below. <BC_type> will consist of the following string: | ||
:'h' - WSE boundary condition | :'h' - WSE boundary condition | ||
| Line 38: | Line 38: | ||
:<ID(nc)> | :<ID(nc)> | ||
==Boundary Condition forcing data files== | |||
There will be one forcing data file for each Boundary Condition of each type. Each file is designated by a number that corresponds to the boundary number, <BC_#>, given by SMS and is written within the .cmcards parameter file. Each of these files give the specific curve information for each boundary of each type. | There will be one forcing data file for each Boundary Condition of each type. Each file is designated by a number that corresponds to the boundary number, <BC_#>, given by SMS and is written within the .cmcards parameter file. Each of these files give the specific curve information for each boundary of each type. | ||
| Line 51: | Line 51: | ||
<time(n-1)> <value(n-1)> ! Time and forcing value for Time n-1<br> | <time(n-1)> <value(n-1)> ! Time and forcing value for Time n-1<br> | ||
==Sample files== | |||
A link to a zip file containing the appropriate files for 4 river flow boundary conditions is given below.<br> | A link to a zip file containing the appropriate files for 4 river flow boundary conditions is given below.<br> | ||
* [[Media:ASCII_BC_files.zip|ASCII_BC_files.zip]] | * [[Media:ASCII_BC_files.zip|ASCII_BC_files.zip]] | ||
=Dataset values= | |||
These dataset values can be any type of data and are specified for every cell in the grid. Certain types of data are common to most project numerical grids, such as: Bottom Friction, Grain Size, Hard Bottom depth. Other types of data are allowed as well, such as: initial 2d salinity concentration, temperature, and fraction of suspended sediment evaluated with the Sediment Mapping feature. | These dataset values can be any type of data and are specified for every cell in the grid. Certain types of data are common to most project numerical grids, such as: Bottom Friction, Grain Size, Hard Bottom depth. Other types of data are allowed as well, such as: initial 2d salinity concentration, temperature, and fraction of suspended sediment evaluated with the Sediment Mapping feature. | ||
| Line 67: | Line 67: | ||
**Values - Dataset containing a list of the values for specific dataset. | **Values - Dataset containing a list of the values for specific dataset. | ||
=Wind Forcing= | |||
Wind forcing applied to the entire domain, but can be input either at each cell in the grid or from a field of values at a specified spacing that covers the domain. | Wind forcing applied to the entire domain, but can be input either at each cell in the grid or from a field of values at a specified spacing that covers the domain. | ||
| Line 77: | Line 77: | ||
**Magnitude - Dataset containing a list of the Wind speed values matching the Times dataset. | **Magnitude - Dataset containing a list of the Wind speed values matching the Times dataset. | ||
=Wave Forcing= | |||
Wave information typically comes in directly from the embedded wave model and mapped to every cell in the grid, but can also be input from pre-run wave cases that have been already mapped to the flow grid geometry. | Wave information typically comes in directly from the embedded wave model and mapped to every cell in the grid, but can also be input from pre-run wave cases that have been already mapped to the flow grid geometry. | ||
Revision as of 23:29, 5 March 2018
__notitle__
ASCII Input File
If ASCII input files are required for whatever reason, the user can enter a Card into the parameter file, *.cmcards, that will instruct the CMS to write out ASCII representations of the input specified in various XMDF files. The CMS will then go through each input type and take the information and write it back out into separate ASCII files.
Due to the large number of possible files for a large project, the CMS will create a subdirectory named "ASCII_Input" within the initial project directory location and place the files there.
To ensure that the ASCII file CMS writes out can potentially be read back into the SMS, file formats that are already supported in the SMS were chosen to hold the information for various types of information.
Boundary Conditions
Boundary conditions are specified along an external or internal a string of cells. For each boundary, a folder containing information is written to the file.
There are three presently supported boundary condition types (River flux, Water Level, and Tidal/Harmonic) for ASCII input. Others, such as Nested boundaries and Extracted WSE/Velocity will follow later.
For each boundary condition, there will be one Boundary ID file and one or more Boundary Condition forcing data files.
Boundary ID file
There may be multiple instances of River Flux and WSE boundary conditions for a single project. The cell IDs for all boundaries are written to one Boundary ID file. Each type of boundary condition is denoted by <BC_type> below. <BC_type> will consist of the following string:
- 'h' - WSE boundary condition
- 'q' - River flux boundary condition
- 'th' - Tidal/Harmonic boundary condition
- Filename - <project>*_<BC type>.bid
- File format for ASCII contents of file
<ns> !# of cellstrings/boundary conditions of each type
<nc> !# of cells in string #1
- <ID(1)>
- ...
- <ID(nc)>
<nc> !# of cells in string #2
- <ID(1)>
- ...
- <ID(nc)>
...
<nc> !# of cells in string #ns
- <ID(1)>
- ...
- <ID(nc)>
Boundary Condition forcing data files
There will be one forcing data file for each Boundary Condition of each type. Each file is designated by a number that corresponds to the boundary number, <BC_#>, given by SMS and is written within the .cmcards parameter file. Each of these files give the specific curve information for each boundary of each type.
- Filename - <project>*_<BC type>_<BC_#>.xys
- File format for ASCII contents of file
XYS 2 <n> "" !<n> is the total number of time records in the file.
<time(0)> <value(0)> ! Time and forcing value for Time 0
<time(1)> <value(1)> ! Time and forcing value for Time 1
<time(2)> <value(2)> ! Time and forcing value for Time 2
<time(3)> <value(3)> ! Time and forcing value for Time 3
...
<time(n-1)> <value(n-1)> ! Time and forcing value for Time n-1
Sample files
A link to a zip file containing the appropriate files for 4 river flow boundary conditions is given below.
Dataset values
These dataset values can be any type of data and are specified for every cell in the grid. Certain types of data are common to most project numerical grids, such as: Bottom Friction, Grain Size, Hard Bottom depth. Other types of data are allowed as well, such as: initial 2d salinity concentration, temperature, and fraction of suspended sediment evaluated with the Sediment Mapping feature.
Each dataset in this category is written in almost the exact same way with the only variant being the number of dimensions written. Scalar datasets have one value per cell and Vector datasets have two values per cell. The name of the dataset is shown in the filename with the indicator <dset name> below.
- Filename - <project>*_datasets_<dset name>.txt
- Contents of folder
- Times - Dataset containing a list all the times for the specific dataset (generally just one initial time = 0.00).
- Maxs - Dataset containing a list of the maximum values for the specific dataset.
- Mins - Dataset containing a list of the minimum values for the specific dataset.
- Values - Dataset containing a list of the values for specific dataset.
Wind Forcing
Wind forcing applied to the entire domain, but can be input either at each cell in the grid or from a field of values at a specified spacing that covers the domain.
- Filename (<project>*_mp.h5 file)
- XMDF Path - "PROPERTIES/Model Params/WindCurve"
- Contents of folder
- Times - Dataset containing a list of all the times for the Wind curve specification.
- Direction - Dataset containing a list of the Wind directions matching the Times dataset.
- Magnitude - Dataset containing a list of the Wind speed values matching the Times dataset.
Wave Forcing
Wave information typically comes in directly from the embedded wave model and mapped to every cell in the grid, but can also be input from pre-run wave cases that have been already mapped to the flow grid geometry.