Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimestepSettings

Settings to modify W.I.S.E. behaviour at the end of every timestep.

author

"Travis Redpath"

Hierarchy

  • TimestepSettings

Index

Properties

discretize

discretize: number | null = null

The amount to discritize the existing grid to (optional). Will only be applied to statistics that require a discretization parameter. Must be in [1,1001].

Private statistics

statistics: GlobalStatistics[] = new Array<GlobalStatistics>()

Static Private Readonly PARAM_EMIT_STATISTIC

PARAM_EMIT_STATISTIC: "mng_statistic" = "mng_statistic"

Methods

addStatistic

checkValid

  • Find all errors that may exist in the timestep settings.

    Returns Array<ValidationError>

    A list of all errors that were found.

removeStatistic

  • Remove a statistic string from the statistics.

    Parameters

    Returns boolean

    A boolean indicating if the string was found and removed

stream

  • stream(builder: Socket): void
  • Streams the settings to a socket.

    Parameters

    • builder: Socket

    Returns void

Static Private validateInput

  • Check to see if a global statistic if valid to be used as a timestep setting.

    Parameters

    • stat: GlobalStatistics

      True if the input statistic if valid for timestep settings.

    Returns boolean