sailfish.driver.DriverArgs

class sailfish.driver.DriverArgs(setup_name: Optional[str] = None, chkpt_file: Optional[str] = None, model_parameters: Optional[dict] = None, solver_options: Optional[dict] = None, cfl_number: Optional[float] = None, end_time: Optional[float] = None, execution_mode: Optional[str] = None, fold: Optional[int] = None, resolution: Optional[int] = None, num_patches: Optional[int] = None, events: Dict[str, Recurrence] = {}, new_timestep_cadence: Optional[int] = None, verbose_output: str = '')[source]

Bases: NamedTuple

Contains data used by the driver.

__init__()

Methods

`__init__`()
`count`(value, /)	Return number of occurrences of value.
`from_namespace`()	Construct an instance from an argparse-type namespace object.
`index`(value[, start, stop])	Return first index of value.

Attributes

`cfl_number`	Alias for field number 4
`chkpt_file`	Alias for field number 1
`end_time`	Alias for field number 5
`events`	Alias for field number 10
`execution_mode`	Alias for field number 6
`fold`	Alias for field number 7
`model_parameters`	Alias for field number 2
`new_timestep_cadence`	Alias for field number 11
`num_patches`	Alias for field number 9
`resolution`	Alias for field number 8
`setup_name`	Alias for field number 0
`solver_options`	Alias for field number 3
`verbose_output`	Alias for field number 12

cfl_number: float: Alias for field number 4

chkpt_file: str: Alias for field number 1

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

end_time: float: Alias for field number 5

events: Dict[str, Recurrence]: Alias for field number 10

execution_mode: str: Alias for field number 6

fold: int: Alias for field number 7

from_namespace()[source]: Construct an instance from an argparse-type namespace object.

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

Return first index of value.

Raises ValueError if the value is not present.

model_parameters: dict: Alias for field number 2

new_timestep_cadence: int: Alias for field number 11

num_patches: int: Alias for field number 9

resolution: int: Alias for field number 8

setup_name: str: Alias for field number 0

solver_options: dict: Alias for field number 3

verbose_output: str: Alias for field number 12