Salt API

This section documents the SaltSimulationMixin class, which can be used to simulate advective and convective salt transport.

class rtctools_simulation.salt_simulation_mixin.SaltSimulationMixin[source]

Class for simulating advective and convective salt trasnport.

extra_equations()[source]

All necessary extra equations are added.

These extra equations connect the dispersive discharges to the blocks.

get_output_variables()[source]

This section adds extra output variables.

initialize()[source]

This run is initialized.

The initital middle discharge is set to zero and volumes are calculted from initial level.

read()[source]

This part is reading the input file.

If the input file is in csv format, the date format is automatically adjusted.

update(dt)[source]

Upate step.

In this section the convective discharges are set depending on which closing term is chosen.