SMS:PTM Files: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
No edit summary |
|||
(12 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
== Input Files == | == Input Files == | ||
===Required files=== | |||
* Optional files | * '''[[SMS:PTM Control File|Program Control File]]''' (*.pcf) – Run time instruction for the model. | ||
* | * '''Mesh file''' – Bathymetry and boundary information for the model. | ||
* | *:PTM Version 1.0 supports [[SMS:ADCIRC|ADCIRC]] compatible three-noded triangular finite element mesh files ([[SMS:ADCIRC Mesh|fort.14 or .grd]]). SMS contains tools to convert mesh files to this format. | ||
* | * '''Hydrodynamic input file''' – Time varying water surface elevation and depth-averaged velocities. | ||
* | *:Versions of SMS including 9.2 and later supports XMDF (*.h5) format hydrodynamic files. SMS contains tools to convert mesh output files to this format. | ||
* | * '''[[SMS:PTM Sediment File|Native sediment file]]''' – Native sediments over the domain defined by the mesh file. | ||
===Optional files=== | |||
* '''[[SMS:PTM Source File|Sediment source file]]''' – The sediment sources in the simulation. | |||
* '''[[SMS:PTM Trap File|Trap file]]''' (*.trap) – Locations where information about the simulation should be extracted. | |||
* '''[[SMS:PTM Wave File|Wave file(s)]]''' – Time varying information about the wave field. | |||
* '''Wave breaking file(s)''' – Time varying information about wave breaking. | |||
* '''[[SMS:PTM Boundary Condition File|PTM Boundary Condition file]]''' – Describes the wet/dry interface. | |||
== Output Files == | == Output Files == | ||
The output files use the name given after the keyword :OUTPUT_PREFIX in the [[SMS:PTM Control File|program control file]] and are appended with the following endings: | The output files use the name given after the keyword :OUTPUT_PREFIX in the [[SMS:PTM Control File|program control file]] and are appended with the following endings: | ||
* '''Mapping Output File''' (*_maps.h5) – | * '''Mapping Output File''' (*_maps.h5) – Behavior of the flow and native sediments over the whole domain incremented by time. | ||
* '''Parcel Data File''' (*_particles.h5) – | * '''Parcel Data File''' (*_particles.h5) – Parcel information incremented by time. | ||
* '''Echo file''' (*_input.out) – ASCII file echoing the input parameters of the simulation. | * '''Echo file''' (*_input.out) – ASCII file echoing the input parameters of the simulation. | ||
* '''Neighbor file''' (*.neighbors) – | * '''Neighbor file''' (*.neighbors) – Contains mesh connectivity information. Once generated, can be specified as an input file to avoid regenerating for subsequent simulations with a given mesh. If the mesh changes, the neighbor file should be regenerated. | ||
* '''Trap Count File''' (*_count.out) – | * '''Trap Count File''' (*_count.out) – Contains the time and ID of particles entering a trap | ||
* '''Trap Residency File''' (*_residency.out) – | * '''Trap Residency File''' (*_residency.out) – Contains the time particles enter and exit a trap and the total time spent in the trap. | ||
==Related Topics== | |||
* [[SMS:PTM|PTM]] | |||
Line 30: | Line 35: | ||
[[Category:PTM|F]] | [[Category:PTM|F]] | ||
[[Category:SMS File Formats|P]] |
Latest revision as of 14:14, 30 March 2017
Input and Output files for PTM.
Input Files
Required files
- Program Control File (*.pcf) – Run time instruction for the model.
- Mesh file – Bathymetry and boundary information for the model.
- PTM Version 1.0 supports ADCIRC compatible three-noded triangular finite element mesh files (fort.14 or .grd). SMS contains tools to convert mesh files to this format.
- Hydrodynamic input file – Time varying water surface elevation and depth-averaged velocities.
- Versions of SMS including 9.2 and later supports XMDF (*.h5) format hydrodynamic files. SMS contains tools to convert mesh output files to this format.
- Native sediment file – Native sediments over the domain defined by the mesh file.
Optional files
- Sediment source file – The sediment sources in the simulation.
- Trap file (*.trap) – Locations where information about the simulation should be extracted.
- Wave file(s) – Time varying information about the wave field.
- Wave breaking file(s) – Time varying information about wave breaking.
- PTM Boundary Condition file – Describes the wet/dry interface.
Output Files
The output files use the name given after the keyword :OUTPUT_PREFIX in the program control file and are appended with the following endings:
- Mapping Output File (*_maps.h5) – Behavior of the flow and native sediments over the whole domain incremented by time.
- Parcel Data File (*_particles.h5) – Parcel information incremented by time.
- Echo file (*_input.out) – ASCII file echoing the input parameters of the simulation.
- Neighbor file (*.neighbors) – Contains mesh connectivity information. Once generated, can be specified as an input file to avoid regenerating for subsequent simulations with a given mesh. If the mesh changes, the neighbor file should be regenerated.
- Trap Count File (*_count.out) – Contains the time and ID of particles entering a trap
- Trap Residency File (*_residency.out) – Contains the time particles enter and exit a trap and the total time spent in the trap.
Related Topics
SMS – Surface-water Modeling System | ||
---|---|---|
Modules: | 1D Grid • Cartesian Grid • Curvilinear Grid • GIS • Map • Mesh • Particle • Quadtree • Raster • Scatter • UGrid | |
General Models: | 3D Structure • FVCOM • Generic • PTM | |
Coastal Models: | ADCIRC • BOUSS-2D • CGWAVE • CMS-Flow • CMS-Wave • GenCade • STWAVE • WAM | |
Riverine/Estuarine Models: | AdH • HEC-RAS • HYDRO AS-2D • RMA2 • RMA4 • SRH-2D • TUFLOW • TUFLOW FV | |
Aquaveo • SMS Tutorials • SMS Workflows |