Output parameters

The output file contains a set of trajectories of the effluent jet, one for each release time. The first release time is output.release.start, the last release time is output.release.stop, and the number of intermediate trajectories is given by output.release.step.

Each trajectory is a collection of points, one for every output time step. The first trajectory time step is output.trajectory.start, the last one is output.trajectory.stop, and the number of intermediate trajectory points is determined by output.trajectory.step. The number of actual internal time steps is determined by solver parameters.

Output is either written to a text file (output.csv.file) or a netCDF file (output.nc.file). The option output.variables can be used to limit the number of variables written.

output.variables
Type:

array of strings

Default:

(all variables)

Variables to include in the output. Possible alternatives are:

  • release_time: Time of release [date]

  • t: Time since release from pipe outlet [s]

  • x: Centerline x position (co-flow direction) [m]

  • y: Centerline y position (crossflow direction) [m]

  • z: Centerline z position (depth below surface) [m]

  • u: Mean velocity in x direction [s]

  • v: Mean velocity in y direction [s]

  • w: Mean velocity in z direction [s]

  • density: Mean mass density [kg/m³]

  • radius: Radius of top-hat profile [m]

  • dilution: The dilution factor of the effluent volume [1]

  • salt: Plume salinity, if available [1]

  • temp: Plume temperature, if available [°C]

output.release.start
Type:

date

Default:

1970-01-01

Date and time of the first simulated trajectory.

output.release.stop
Type:

date

Default:

1970-01-01

Date and time of the last simulated trajectory.

output.release.step
Type:

number

Units:

s

Default:

86400

Time between each simulated trajectory.

output.trajectory.start
Type:

number

Units:

s

Default:

0

The first trajectory point (first value of t) written to the output file.

output.trajectory.stop
Type:

number

Units:

s

Default:

60

The last trajectory point (last value of t) written to the output file.

output.trajectory.step
Type:

number

Units:

s

Default:

1

The time between trajectory points (i.e., time between t values) written to the output file. This is not the same as the internal time step, which is chosen automatically by the integration algorithm.

output.csv.file
Type:

string

Write results to the specified comma-delimited text file. Rows are sorted by release_time, then by t.

output.csv.float_format
Type:

string

Default:

“%.10g”

Format and precision of floats written to file. Passed directly to pandas.DataFrame.to_csv.

output.nc.file
Type:

string

Write results to the specified file using the netCDF4 format. Output variables are structured with release_time as the first dimension and t as the second dimension.