SMS:PTM Model Control: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
 
(19 intermediate revisions by 2 users not shown)
Line 2: Line 2:


== Time ==
== Time ==
[[Image:PTM MC Time.jpg|thumb|450 px|''PTM Model Control'' dialog showing the ''Time'' tab]]
[[Image:PTM MC Time.png|thumb|450 px|''PTM Model Control'' dialog showing the ''Time'' tab]]
The ''Time'' tab is used to specify time information to be written to the [[SMS:PTM Control File|program control file]].  If a control on the dialog is not enabled, the corresponding keyword will not be written to the [[SMS:PTM Control File|program control file]].  Controls on the dialog are disabled based on the options chosen on the other model control tabs.  For example, if no trap file is specified on the ''Files'' tab, the time controls related to traps will not be available.  There is a plot on the dialog of the specified times. This tab has the following inpute fields:
The ''Time'' tab is used to specify time information to be written to the [[SMS:PTM Control File|program control file]].  If a control on the dialog is not enabled, the corresponding keyword will not be written to the [[SMS:PTM Control File|program control file]].  Controls on the dialog are disabled based on the options chosen on the other model control tabs.  For example, if no trap file is specified on the ''Files'' tab, the time controls related to traps will not be available.  There is a plot on the dialog of the specified times. This tab has the following inpute fields:
*Simulation
*Simulation
<blockquote>
**Start
*Start
**Stop
*Stop
**Duration
*Duration
**Time Step
*Time Step
</blockquote>
*Particle Output
*Particle Output
*Shear, Bedforms, and Mobility Updates
*Shear, Bedforms, and Mobility Updates
Line 16: Line 14:
*Flow and Elevation Update
*Flow and Elevation Update
*Waves
*Waves
<blockquote>
**Start
*Start
**Time Step
*Time Step
</blockquote>
*Hydrodynamics
*Hydrodynamics
*Traps
*Traps
<blockquote>
**Start
*Start
**Stop
*Stop
**Last time step trap
*Last time step trap
</blockquote>


== Files ==
== Files ==
[[Image:PTM MC Files.jpg|thumb|450 px|''PTM Model Control'' dialog showing the ''Files'' tab]]
[[Image:PTM MC Files.png|thumb|450 px|''PTM Model Control'' dialog showing the ''Files'' tab]]
The ''Files'' tab is used to specify [[SMS:PTM Files#Input Files|input]] and [[SMS:PTM Files#Output Files|output]] file information to be written to the [[SMS:PTM Control File|program control file]].
The ''Files'' tab is used to specify [[SMS:PTM Files#Input Files|input]] and [[SMS:PTM Files#Output Files|output]] file information to be written to the [[SMS:PTM Control File|program control file]] (*.pcf).


Pressing the '''Create input file(s) from data...''' button on the ''Files'' tab will open the ''Create PTM External Input Files'' dialog.
Pressing the '''Create input file(s) from data...''' button on the ''Files'' tab will open the ''Create PTM External Input Files'' dialog. This dialog can import results from ADCIRC, ADH, SRH-2D, CMS-FLOW or other models to create a mesh (fort.14) file, grain size native sediment (*.sediment) file, and/or a XMDF hydrodynamic input flow file (*.h5) to import into a PTM model. This option is not necessary for basic ADCIRC and CMS-FLOW models since their files will import into PTM if specified in the input files section.
*'''''Note:''''' SMS is not capable of importing RMA2 and FESWMS files into PTM at this time.


===Native Sediment Grain Size===
===Native Sediment Grain Size===
# If "Uniform bed" is selected from the "Options" column an '''Options''' button is displayed under "Filename".  Pressing this button allows the user to create uniform grain sizes for D35, D50 and D90.  If the project is saved, the :SEDIMENT_FORMAT card is created, with the keyword UNIFORM and the 3 grain sizes being written out.
# If "Uniform bed" is selected from the "Options" column an '''Options''' button is displayed under "Filename".  Pressing this button allows creating uniform grain sizes for D35, D50 and D90 (where D35 means 35% of the grains are smaller than diameter D).  If the project is saved, the :SEDIMENT_FORMAT card is created, with the keyword UNIFORM and the 3 grain sizes being written out.
# If Sediment file is selected, the user can manually select the filename by pressing the button under "Filename".   
# If Sediment file is selected, manually select the file name by pressing the button under "Filename".   
# Pressing the '''Create input file(s) from data''' and selecting to create a Native sediment grain size file will automatically toggle the native sediments grain size to "sediments file" and place the new file under the "Filename".
# Pressing the '''Create input file(s) from data''' and selecting to create a Native sediment grain size file will automatically toggle the native sediments grain size to "sediments file" and place the new file under the "Filename". The user can enter in the D values with the constant mobile bed type or a Nikuradse‘s equivalent sand roughness Ks (surface roughness height which equals D90) for the constant fixed bed type or use a dataset for spatially varied grain sizes.


[[Image:PTM Create External Input.jpg|thumb|none|left|500 px|''Create PTM External Input Files'' dialog]]
[[Image:PTM Create External Input.png|thumb|none|left|500 px|''Create PTM External Input Files'' dialog]]


== Computations ==
== Computations ==
[[Image:PTM MC Computations.jpg|thumb|450 px|''PTM Model Control'' dialog showing the ''Computations'' tab]]
[[Image:PTM MC Computations.png|thumb|450 px|''PTM Model Control'' dialog showing the ''Computations'' tab]]
The ''Computations'' tab is used to specify model computation options to be written to the [[SMS:PTM Control File|program control file]]. This tab has the following input fields:
The ''Computations'' tab is used to specify model computation options to be written to the [[SMS:PTM Control File|program control file]]. This tab has the following input fields:
*Computation Methods
*Computation Methods
<blockquote>
**Advection
*Advection
**Centroid
*Centroid
**Distribution
*Distribution
**Eulenian
*Eulenian
**Velocity
*Velocity
**Numerical scheme
*Numirical scheme
</blockquote>
*Computational Parameters
*Computational Parameters
<blockquote>
**Bed porosity
*Bed porosity
**Temperature
*Temperature
**Bed density
*Bed density
**Salinity
*Salinity
**Minimum depth
*Minimum depth
</blockquote>
*Diffusion Parameters
*Diffusion Parameters
<blockquote>
**Min. diffusion coefficient
*Min. diffusion coefficient
**Turbulent diffusion scalar
*Turbulent diffusion scalar
**Wave diffusion scalar
*Wave diffusion scalar
</blockquote>
*Model Calculation Options
*Model Calculation Options
<blockquote>
**Currents
*Currents
**Morphology
*Morphology
**Neutrally buoyant particles
*Neutrally buoyant particles
**Bedforms
*Bedforms
**Hiding and exposure
*Hiding and exposure
**Particle-bed interaction
*Particle-bed interaction
**Turbulent shear
*Turbulent shear
**Source and trap Z-value relative to datum
*Source and trap Z-value relative to datum
**Residency (polygon trap required)
*Residency (polygon trap required)
**Wave mass transport
*Wave mass transport
</blockquote>


== Output ==
== Output ==
[[Image:PTM MC Output.jpg|thumb|450 px|''PTM Model Control'' dialog showing the ''Output'' tab]]
[[Image:PTM MC Output.png|thumb|450 px|''PTM Model Control'' dialog showing the ''Output'' tab]]
The ''Output'' tab is used to specify model output options to be written to the [[SMS:PTM Control File|program control file]]. This tab has the following input fields:
The ''Output'' tab is used to specify model output options to be written to the [[SMS:PTM Control File|program control file]]. This tab has the following input fields:
*File Output
*File Output
<blockquote>
**Print default keywords
*Print default keywords
**Compress XMDF files
*Compress XMDF files
**Tecplot map data
*Tecplot map data
**Tecplot particle data
*Tecplot particle data
**Tecplot particle path data
*Tecplot particle path data
**tecplot population history
*tecplot population history
</blockquote>
*Mapping Output (on Hydrodynamic Grid)
*Mapping Output (on Hydrodynamic Grid)
<blockquote>
**Bed evolution
*Bed evolution
**Bed level change
*Bed level change
**Flow conditions
*Flow conditions
**Mobility of native sediments
*Mobility of native sediments
**Native sediment bedforms
*Native sediment bedforms
**Potential sediment transport rate
*Potential sediment transport rate
**Shear stress
*Shear stress
**Wave parameters
*Wave parameters
</blockquote>
*Particle Output
*Particle Output
<blockquote>
**Critical shear
*Critical shear
**Density
*Density
**Fall velocity
*Fall velocity
**Grain size
*Grain size
**Height above the bed
*Height above the bed
**Mass
*Mass
**Mobility
*Mobility
**Source
*Source
**State
*State
**Velocity components
*Velocity components
</blockquote>


==Related Topics==
==Related Topics==
Line 125: Line 106:


[[Category:PTM|M]]
[[Category:PTM|M]]
[[Category:PTM Dialogs]]
[[Category:PTM Dialogs|M]]
[[Category:SMS Model Control|P]]
[[Category:SMS Model Control|P]]

Latest revision as of 17:33, 10 January 2020

The PTM model control is used to create the program control file, which contains general simulation options. Refer to the PTM manual for a more detailed description of how these parameters affect the model results.

Time

PTM Model Control dialog showing the Time tab

The Time tab is used to specify time information to be written to the program control file. If a control on the dialog is not enabled, the corresponding keyword will not be written to the program control file. Controls on the dialog are disabled based on the options chosen on the other model control tabs. For example, if no trap file is specified on the Files tab, the time controls related to traps will not be available. There is a plot on the dialog of the specified times. This tab has the following inpute fields:

  • Simulation
    • Start
    • Stop
    • Duration
    • Time Step
  • Particle Output
  • Shear, Bedforms, and Mobility Updates
  • Mapping Output
  • Flow and Elevation Update
  • Waves
    • Start
    • Time Step
  • Hydrodynamics
  • Traps
    • Start
    • Stop
    • Last time step trap

Files

PTM Model Control dialog showing the Files tab

The Files tab is used to specify input and output file information to be written to the program control file (*.pcf).

Pressing the Create input file(s) from data... button on the Files tab will open the Create PTM External Input Files dialog. This dialog can import results from ADCIRC, ADH, SRH-2D, CMS-FLOW or other models to create a mesh (fort.14) file, grain size native sediment (*.sediment) file, and/or a XMDF hydrodynamic input flow file (*.h5) to import into a PTM model. This option is not necessary for basic ADCIRC and CMS-FLOW models since their files will import into PTM if specified in the input files section.

  • Note: SMS is not capable of importing RMA2 and FESWMS files into PTM at this time.

Native Sediment Grain Size

  1. If "Uniform bed" is selected from the "Options" column an Options button is displayed under "Filename". Pressing this button allows creating uniform grain sizes for D35, D50 and D90 (where D35 means 35% of the grains are smaller than diameter D). If the project is saved, the :SEDIMENT_FORMAT card is created, with the keyword UNIFORM and the 3 grain sizes being written out.
  2. If Sediment file is selected, manually select the file name by pressing the button under "Filename".
  3. Pressing the Create input file(s) from data and selecting to create a Native sediment grain size file will automatically toggle the native sediments grain size to "sediments file" and place the new file under the "Filename". The user can enter in the D values with the constant mobile bed type or a Nikuradse‘s equivalent sand roughness Ks (surface roughness height which equals D90) for the constant fixed bed type or use a dataset for spatially varied grain sizes.
Create PTM External Input Files dialog

Computations

PTM Model Control dialog showing the Computations tab

The Computations tab is used to specify model computation options to be written to the program control file. This tab has the following input fields:

  • Computation Methods
    • Advection
    • Centroid
    • Distribution
    • Eulenian
    • Velocity
    • Numerical scheme
  • Computational Parameters
    • Bed porosity
    • Temperature
    • Bed density
    • Salinity
    • Minimum depth
  • Diffusion Parameters
    • Min. diffusion coefficient
    • Turbulent diffusion scalar
    • Wave diffusion scalar
  • Model Calculation Options
    • Currents
    • Morphology
    • Neutrally buoyant particles
    • Bedforms
    • Hiding and exposure
    • Particle-bed interaction
    • Turbulent shear
    • Source and trap Z-value relative to datum
    • Residency (polygon trap required)
    • Wave mass transport

Output

PTM Model Control dialog showing the Output tab

The Output tab is used to specify model output options to be written to the program control file. This tab has the following input fields:

  • File Output
    • Print default keywords
    • Compress XMDF files
    • Tecplot map data
    • Tecplot particle data
    • Tecplot particle path data
    • tecplot population history
  • Mapping Output (on Hydrodynamic Grid)
    • Bed evolution
    • Bed level change
    • Flow conditions
    • Mobility of native sediments
    • Native sediment bedforms
    • Potential sediment transport rate
    • Shear stress
    • Wave parameters
  • Particle Output
    • Critical shear
    • Density
    • Fall velocity
    • Grain size
    • Height above the bed
    • Mass
    • Mobility
    • Source
    • State
    • Velocity components

Related Topics