SMS:PTM Files: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
No edit summary
Line 3: Line 3:
== Input Files ==
== Input Files ==
* Required files
* Required files
** [[SMS:PTM Program Control File|Program Control File]] (.pcf) - run time instruction for the model.
** [[SMS:PTM Program Control File|Program Control File]] (*.pcf) – run time instruction for the model.
** Mesh file - bathymetry and boundary information 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.
*** 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.
** Hydrodynamic input file – time varying water surface elevation and depth-averaged velocities.
*** The SMS 9.2 interface to PTM Version 1.0 supports XMDF (.h5) format hydrodynamic files.  SMS contains tools to convert mesh output files to this format.
*** The SMS 9.2 interface to PTM Version 1.0 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.
** [[SMS:PTM Sediment File|Native sediment file]] – native sediments over the domain defined by the mesh file.


* Optional files
* Optional files
** [[SMS:PTM Source File|Sediment source file]] - the sediment sources in the simulation.
** [[SMS:PTM Source File|Sediment source file]] – the sediment sources in the simulation.
** [[SMS:PTM Trap File|Trap file]] - locations where information about the simulation should be extracted.
** [[SMS:PTM Trap File|Trap file]] – locations where information about the simulation should be extracted.
** [[SMS:PTM Wave File|Wave file(s)]] - time varying information about the wave field
** [[SMS:PTM Wave File|Wave file(s)]] – time varying information about the wave field
** [[SMS:PTM Wave Breaking File|Wave breaking file(s)]] - time varying information about wave breaking
** [[SMS:PTM Wave Breaking File|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_Program_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_Program_Control_File|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.
* '''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.
* '''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) - 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.
* '''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 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.
* '''Trap Residency File''' (*_residency.out) – contains the time particles enter and exit a trap and the total time spent in the trap.





Revision as of 00:22, 7 November 2012

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.
      • The SMS 9.2 interface to PTM Version 1.0 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.

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.


Template:PTM