general SectionΒΆ

This section configures general model settings, including time steps, mesh files, solver types, and parallelization options.


Parameter

Description

rootname

Root name for grid files.

time_step

Main time step for the model (default: NONE, in seconds).

sub_time_step

Sub-time step for the model (default: $TimeStep/3.0, in seconds).

nSubCycles

Number of sub-cycles (default: 1).

time_origine

Time origin for the simulation (default: 1950-01-01 00:00:00).

mesh_format

Format of the mesh file (nei, nod, nc).

mesh_type

Type of mesh (LINEAR, TRIANGULAR, QUADRANGULAR, MIXED, STRUCTURED).

mesh_meta

Input-output variable names for structured mesh.

mesh_file

Alternative path for grid file (only for mesh_format=nei).

mesh_proj4

PROJ4 parameters for Cartesian grids.

bel_file

BEL file for mesh.

topo_file

Bathymetry file.

slope_file

Bathymetry gradient file.

zmin_file

Minimum elevation file.

relative_minimum_depth

Minimum depth relative to minimum elevation (default: 5.0 m).

minimum_depth

Overall minimum depth in model bathymetry (default: 10.0 m).

run_duration

Run duration for the simulation (default: 48.0 hours).

spin_up

Spin-up duration for cold start (default: 48.0 hours).

spin_up_mode

Mode for spin-up (LINEAR, COSINE).

cold_start_ssh

Cold start sea surface height filename.

restart_file

Restart file or flag for cold start (COLD-START, FILE).

restart_format

Format of restart file (NETCDF, CLX).

ContinuationFlag

Flag to enable/disable rolling continuation files (ENABLED, DISABLED).

continuation_file

Root name for restart files (default: tugo_restart).

continuation_format

Format for restart files (NETCDF, CLX).

continuation_interval

Interval for restart files (default: 10800.0 s).

automatic_interval

Automatic interval for restart files (HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY).

output_path

Default path for model outputs (default: .).

solver_type

Solver type for implicit linear systems (DOMESTIC, LAPACK, SUNPERF, UMFPACK, PETSC_GMRES, TUGO_GMRES, MUMPS, MUMPS_SYM, SpDOMESTIC, HIPS, PASTIX, AUTO).

sub_solver_type

Sub-solver type for sub-cycling (AUTO, DOMESTIC, LAPACK, SUNPERF, UMFPACK, PETSC_GMRES, TUGO_GMRES, MUMPS, MUMPS_SYM, SpDOMESTIC, HIPS, PASTIX).

auxilliary_solver_type

Auxiliary solver type (AUTO, DOMESTIC, LAPACK, SUNPERF, UMFPACK, PETSC_GMRES, TUGO_GMRES, MUMPS, MUMPS_SYM, SpDOMESTIC, HIPS, PASTIX).

SolverShowPerfs

Flag to display solver performance (0 for no display).

solver_mode

Solver mode (AUTO, SEQUENTIAL, PARALLEL).

mode

Simulation mode (NO-DYNAMIC, 2D, 3D-BAROTROPIC, 3D-DIAGNOSTIC, 3D-PROGNOSTIC).

compressibility

Compressibility mode (BOUSSINESQ, COMPRESSIBLE).

pressure_mode

Pressure mode (HYDROSTATIC, NON-HYDROSTATIC).

wetting_drying

Wetting/drying capability (DISABLED, ENABLED).

OPENMP_nCPUsMax

Maximum number of CPUs for OpenMP (default: -1).

ProcessPartitioning

Flag to use METIS for process partitioning (TRUE, FALSE).

UnpartitionedProcessing

Mode for global information processing (COLLECTIVE, NODE, CLUSTER).

PartitionBalancing

Flag to balance extra-load due to sub-cycling (TRUE, FALSE).

ParallelMatrixDistribution

Matrix distribution in parallel solver (AUTO, CENTRALIZED, DISTRIBUTED).

ParallelRHSDistribution

RHS distribution in parallel solver (AUTO, CENTRALIZED, DISTRIBUTED).

ParallelSolutionDistribution

Solution distribution in parallel solver (AUTO, CENTRALIZED, DISTRIBUTED).

MetisPath

Path to METIS partitioner (mpmetis).

ArchivePartitionedMesh

Flag to archive MPI partition mesh (TRUE, FALSE).

ArchiveMeshPartition

Flag to archive mesh MPI partition (TRUE, FALSE).

PartitionMinElements

Minimum number of elements per partition (default: 2000).

3d_pressure

Flag for 3D pressure (TRUE, FALSE).

echo_file

Echo filename (default: tugo.echo).

CompatibilityScale

Compatibility scale (default: 1.0, dimensionless).

Stream_TMPDIR

Temporary directory for stream access (AUTO, NONE, <dirname>).