SMS:PTM Traps: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Overview ==
A trap is defined as an area into which particles enter and are counted.
A trap is defined as an area into which particles enter and are counted.


== Global Trap Options ==
== Global Trap Options ==
Global options affect all traps.
Global options affect all traps.
* Time limits can be specified on the trap's operation in the [[SMS:PTM_Model_Control#Time|PTM Model Control, Time Tab]].
* Time limits can be specified on the trap's operation in the ''Time'' tab of the [[SMS:PTM_Model_Control#Time|''PTM Model Control'']] dialog.
* Traps can be set to only be active on the last time step of the PTM simulation by selecting "Last timestep trap" in the [[SMS:PTM_Model_Control#Time|PTM Model Control, Time Tab]].
* Traps can be set to only be active on the last time step of the PTM simulation by selecting "Last timestep trap" in the ''Time'' tab of the [[SMS:PTM_Model_Control#Time|''PTM Model Control'']] dialog.


== Individual Trap Options ==
== Individual Trap Options ==
Line 12: Line 11:
* Particles can be counted once per simulation (single trap) or every time they re-enter an open trap.
* Particles can be counted once per simulation (single trap) or every time they re-enter an open trap.
* The trap can have a bottom and top elevation defining the portion of the water column the trap exists within.
* The trap can have a bottom and top elevation defining the portion of the water column the trap exists within.
* ID - Integer value to identify the trap
* ID – Integer value to identify the trap
* Name - Text to identify the trap
* Name – Text to identify the trap
===PTM Polygon Attribute Dialog===
The options for an individual trap can be set in the ''Feature Object Attributes'' dialog. The dialog is accessed by right-clicking on the trap polygon and selecting the '''Attributes''' menu command.
[[Image:PTM Polygon Att 1.png|thumb|none|left|500 px|''Feature Object Attributes'' dialog showing the ''Trap'' options]]


== Horizontal Line Traps ==
== Horizontal Line Traps ==
Line 19: Line 21:


Horizontal line traps have a direction associated with them. The direction of a trap determines which particles the trap will count.
Horizontal line traps have a direction associated with them. The direction of a trap determines which particles the trap will count.
* Decreasing x-coordinate - only counts particles passing through the trap moving in the negative x-direction.
* Decreasing x-coordinate – Only counts particles passing through the trap moving in the negative x-direction.
* Either direction - counts particles passing through the trap regardless of direction.
* Either direction – Counts particles passing through the trap regardless of direction.
* Increasing x-coordinate - only counts particles passing through the trap moving in the positive x-direction.
* Increasing x-coordinate – Only counts particles passing through the trap moving in the positive x-direction.


== Horizontal Polygon Traps ==
== Horizontal Polygon Traps ==
Line 30: Line 32:
* [[SMS:PTM Sources|PTM Sources]]
* [[SMS:PTM Sources|PTM Sources]]


{{Template:PTM}}
 
{{Template:SMSMain}}
{{Template:Navbox SMS}}


[[Category:PTM|T]]
[[Category:PTM|T]]
[[Category:PTM Dialogs|T]]

Latest revision as of 19:32, 11 June 2020

A trap is defined as an area into which particles enter and are counted.

Global Trap Options

Global options affect all traps.

  • Time limits can be specified on the trap's operation in the Time tab of the PTM Model Control dialog.
  • Traps can be set to only be active on the last time step of the PTM simulation by selecting "Last timestep trap" in the Time tab of the PTM Model Control dialog.

Individual Trap Options

Individual options are specified on a trap by trap basis.

  • The trap may be open (particles are free to leave) or closed.
  • Particles can be counted once per simulation (single trap) or every time they re-enter an open trap.
  • The trap can have a bottom and top elevation defining the portion of the water column the trap exists within.
  • ID – Integer value to identify the trap
  • Name – Text to identify the trap

PTM Polygon Attribute Dialog

The options for an individual trap can be set in the Feature Object Attributes dialog. The dialog is accessed by right-clicking on the trap polygon and selecting the Attributes menu command.

Feature Object Attributes dialog showing the Trap options

Horizontal Line Traps

Horizontal line traps lie in a vertical plane, defined by the trap end points and a top and bottom elevation.

Horizontal line traps have a direction associated with them. The direction of a trap determines which particles the trap will count.

  • Decreasing x-coordinate – Only counts particles passing through the trap moving in the negative x-direction.
  • Either direction – Counts particles passing through the trap regardless of direction.
  • Increasing x-coordinate – Only counts particles passing through the trap moving in the positive x-direction.

Horizontal Polygon Traps

Horizontal polygon traps lie on a horizontal plane and are extruded in the vertical direction based on the trap's top and bottom elevation.

Related Topics