sailfish.driver.DriverState

class sailfish.driver.DriverState(iteration: int, driver: DriverArgs, mesh: object, timeseries: list, event_states: list, solver: SolverBase, setup: SetupBase, cfl_number: float, timestep_dt: float)[source]

Bases: NamedTuple

Contains the stateful variables in use by the simulate function.

An instance of this class is yielded by simulate each time an event takes place.

__init__()

Methods

`__init__`()
`count`(value, /)	Return number of occurrences of value.
`index`(value[, start, stop])	Return first index of value.

Attributes

`cfl_number`	Alias for field number 7
`driver`	Alias for field number 1
`event_states`	Alias for field number 4
`iteration`	Alias for field number 0
`mesh`	Alias for field number 2
`setup`	Alias for field number 6
`solver`	Alias for field number 5
`timeseries`	Alias for field number 3
`timestep_dt`	Alias for field number 8

cfl_number: float: Alias for field number 7

count(value, /): Return number of occurrences of value.

driver: DriverArgs: Alias for field number 1

event_states: list: Alias for field number 4

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

iteration: int: Alias for field number 0

mesh: object: Alias for field number 2

setup: SetupBase: Alias for field number 6

solver: SolverBase: Alias for field number 5

timeseries: list: Alias for field number 3

timestep_dt: float: Alias for field number 8