Static Interval Adapters

class StaticIntervalOutputClassAdapter(model, output_interval, ow_class, name='class-output-writer', **static_interval_kwargs)[source]

Bases: terrainbento.output_writers.static_interval_writer.StaticIntervalOutputWriter

__init__(model, output_interval, ow_class, name='class-output-writer', **static_interval_kwargs)[source]

A simple output writer which converts old style ‘class’ output writers to a new style static interval writer.

Parameters

  • model (a terrainbento ErosionModel instance) –

  • output_interval (float, int) – The model defined output interval.

  • ow_class (uninstantiated output class) – An uninstantiated class that writes output in a run_one_step function.

  • name (string, optional) – The name of the output writer to use when generating output filenames. Defaults to ‘class-output-writer’

  • static_interval_kwargs (keyword args, optional) –

    Keyword arguments that will be passed directly to StaticIntervalOutputWriter. These include:

    • save_first_timestep : bool, defaults to False

    • save_last_timestep : bool, defaults to True

    • output_dir : string, defaults to ‘./output’

    Please see StaticIntervalOutputWriter and GenericOutputWriter for more detail. Note: add_id is automatically included as True.

Returns

StaticIntervalOutputClassAdapter

Return type

object

run_one_step()[source]

Call the old-style class’s output function.

class StaticIntervalOutputFunctionAdapter(model, output_interval, ow_function, name='function-output-writer', **static_interval_kwargs)[source]

Bases: terrainbento.output_writers.static_interval_writer.StaticIntervalOutputWriter

__init__(model, output_interval, ow_function, name='function-output-writer', **static_interval_kwargs)[source]

A simple output writer which converts old style ‘function’ output writers to a new style static interval writer.

Parameters

  • model (a terrainbento ErosionModel instance) –

  • output_interval (float, int) – The model defined output interval.

  • ow_function (output function) – A function that can write output. This function must accept the model as its only argument.

  • name (string, optional) – The name of the output writer to use when generating output filenames. Defaults to ‘function-output-writer’

  • static_interval_kwargs (keyword args, optional) –

    Keyword arguments that will be passed directly to StaticIntervalOutputWriter. These include:

    • save_first_timestep : bool, defaults to False

    • save_last_timestep : bool, defaults to True

    • output_dir : string, defaults to ‘./output’

    Please see StaticIntervalOutputWriter and GenericOutputWriter for more detail. Note: add_id is automatically included as True.

Returns

StaticIntervalOutputFunctionAdapter

Return type

object

run_one_step()[source]

Call the old-style output function.