Tolosa-sw Outputs
Tolosa-sw supports several output formats. All files are written to the bin/ directory. Write intervals can be specified as formatted strings ("N seconds/minutes/hours/days") or as raw second values.
Output Formats
Section titled “Output Formats”Tecplot (w_tecplot)
Section titled “Tecplot (w_tecplot)”5-digit flag controlling Tecplot .dat output:
| Digit | Controls |
|---|---|
| D1 | 0=off, 1=on, 2=original format |
| D2 | Longitude/latitude fields |
| D3 | Friction coefficients (cl, cb, z0 or Manning) |
| D4 | External forcings |
| D5 | Interpolation coefficients |
w_tecplot = 10000 ! Tecplot on, no extrasdt_tecplot = 10 minutesVTK (w_vtk)
Section titled “VTK (w_vtk)”Same flag structure as w_tecplot. Produces .vtu files compatible with ParaView and VisIt.
w_vtk = 10000dt_vtk = 30 minutesBinary (w_bin)
Section titled “Binary (w_bin)”Fortran unformatted binary output, readable by PyTolosa.
w_bin = 10000dt_binary = 1 hourPost-Treatment (w_post)
Section titled “Post-Treatment (w_post)”When w_post > 0, writes time series of global diagnostics at interval dtp:
- Volume, maximum velocity
- Kinetic energy, potential energy, total energy
Output goes to CSV and Tecplot files.
w_post = 1dtp = 60. ! every 60 secondsWrite Interval Parameters
Section titled “Write Interval Parameters”| Parameter | Default | Description |
|---|---|---|
dt_tecplot | null | Tecplot write interval (formatted string) |
dt_vtk | null | VTK write interval (formatted string) |
dt_binary | null | Binary write interval (formatted string) |
dt_restart | null | Restart file write interval |
dtw | -1. | Tecplot and VTK interval in seconds (fallback when dt_tecplot/dt_vtk are null) |
dtb | -1. | Binary interval in seconds (fallback) |
dtrst | -1. | Restart interval in seconds (fallback) |
dtp | -1. | Post-treatment diagnostic interval in seconds |
Restart Files
Section titled “Restart Files”| Parameter | Default | Description |
|---|---|---|
restart | 0 | 0=cold start, 1=restart from restart.bin |
dt_restart | null | Write interval for restart snapshots |
Verbosity
Section titled “Verbosity”| Parameter | Default | Description |
|---|---|---|
verbose | 1 | Terminal output level: 0=quiet, higher=more detail |
Specific Outputs — savefield.yaml
Section titled “Specific Outputs — savefield.yaml”Beyond the full-domain outputs configured in input.txt, you can define specific outputs in bin/savefield.yaml:
gauge— time series at individual points (wave gauges, sensor locations)field— field snapshots in a spatial sub-windowtransect— time series along a line of evenly spaced points
All three sections are optional and can coexist in the same file.
Gauges — Time Series at Points
Section titled “Gauges — Time Series at Points”gauge:- name: WG1 x: 100. y: 500. variables: sshuv format: csv dt: 0.1- name: BALEINES lon: -1.565 lat: 46.244 format: plt dt: 0.5 t_min: 3600.Each gauge is located by x/y (Cartesian, m), lon/lat (degrees), or Gmsh cell index — the nearest mesh cell is used.
| Key | Required | Description |
|---|---|---|
name | yes | Filename stem |
x / y | one of | Cartesian coordinates (m) |
lon / lat | one of | Geographic coordinates (degrees) |
cell | one of | Gmsh global cell index |
variables | no | ssh (default), sshuv, sshuvb, sshb, huv, huvb, hb, h, u, v — suffix b adds bathymetry |
dt | no | Write interval (s); default = dtp |
t_min / t_max | no | Active time range (default: full simulation) |
format | no | csv (default), plt (Tecplot) |
Results are written to res/gauge/<name>.<fmt>.
Fields — Sub-domain Snapshots
Section titled “Fields — Sub-domain Snapshots”field:- name: NEARSHORE x_min: 0. x_max: 500. y_min: 0. y_max: 100. variables: sshuv dt: 5.- name: BALEINES lon_min: -1.568 lon_max: -1.555 lat_min: 46.240 lat_max: 46.252 format: vtk dt: 2.Without a bounding box the entire domain is written.
| Key | Required | Description |
|---|---|---|
name | yes | Subdirectory name |
x_min/x_max / y_min/y_max | no | Window in meters |
lon_min/lon_max / lat_min/lat_max | no | Window in degrees (alternative) |
variables | no | Same options as gauge (default: sshb) |
dt | no | Write interval (s); default = dtp |
t_min / t_max | no | Active time range |
format | no | vtk (default), bin (one file per snapshot), binc (all snapshots concatenated) |
Results are written to res/field/<name>/. VTK files can be opened in ParaView.
Transects — Lines of Points
Section titled “Transects — Lines of Points”transect:- name: CROSS_SHORE x1: 0. y1: 500. x2: 300. y2: 500. nb_points: 50 variables: ssh format: csv dt: 5.Points are distributed evenly between the two endpoints; each maps to the nearest mesh cell.
| Key | Required | Description |
|---|---|---|
name | yes | Subdirectory name |
x1/y1 + x2/y2 | one of | Cartesian endpoints (m) |
lon1/lat1 + lon2/lat2 | one of | Geographic endpoints (degrees) |
nb_points | no | Number of points along the transect (default: 100) |
variables | no | ssh (default), h |
dt | no | Write interval (s); default = dtp |
t_min / t_max | no | Active time range |
format | no | csv (default), plt (Tecplot) |
Results are written to res/transect/<name>/.