% Keyword input file for tUGOm 2.0 and later. The suggested suffix is .intg % % Sections started with # % % Within sections the form is = value(s) optional comments % [on one line]. At least 1 space is needed each side of the "=". % % The order of the sections and the order of the keywords within % sections does not matter, but there can only be one of each % type of section and data must be specfic to that section. % % Extra characters to the right of the input value(s) are ignored. % % Lines beginning with "%" are copied directly to the echo file % in the section where they occur in input and are ignored % for input. % % With the exception of the #model section, no other section has to % appear in this input file. % % At least one type of forcing needs to be specified. % % Lines which have defaults identified can be excluded if the % defaults match your desired run parameters. % #model rootname = ../data/ZKERG12_mesh_zgr.nc //give the model rootname time_step = 45.0 //the time step sub_time_step = $TimeStep/3.0 //the sub time step time_origine = 1950-01-01 00:00:00 //give the time origine mesh_format = nc //give the mesh format mesh_type = STRUCTURED //give the mesh type mesh_meta = file=../data/ZKERG12_mesh_zgr.nc maskfile=../data/ZKERG12_byte_mask.nc vlon_t=nav_lon vlat_t=nav_lat vtopo_t=hdepw vmask_t=tmask //give the mesh type mesh_file = ../data/ZKERG12_mesh_zgr.nc //the mesh file bel_file = ../data/ZKERG12_mesh_zgr.bel //bathy_rade.bel topo_file = NONE //bathymetry file slope_file = NONE //bathymetry gradient's file zmin_file = NONE //minimum elevation file relative_minimum_depth = 5.0 //minimum depth relative to minimum elevation minimum_depth = 2.0 //overall minimum depth in model bathymetry run_duration = 0 //RunDuration spin_up = 48.0 //the spin up spin_up_mode = LINEAR //the spin up mode restart_file = COLD-START //the start condition Or filename restart_format = NETCDF //Type of the file used for restart continuation_file = tugo_restart //Restart files rootname continuation_format = NETCDF //Restart file format continuation_interval = 10800.0 //Restart interval automatic_interval = MONTHLY //Restart interval output_path = test-3 //default pathname for model outputs solver_type = PASTIX //Solver Type sub_solver_type = AUTO //Solver Type solver_mode = AUTO //Solver mode mode = NO-DYNAMIC //simulation mode compressibility = BOUSSINESQ //compressibility mode OPENMP_nCPUsMax = -1 //Max number of CPUs allowed in OPENMP optimisation MetisPath = /home/softs/metis-4.0 //path to METIS executables 3d_pressure = FALSE //FLAG echo_file = echo //the echo filename ## #physics gravity_mode = LATITUDE-DEPENDANT //gravitational constant definition anelastic_body_tide = FALSE //anelastic body tide flag coriolis_mode = LATITUDE-DEPENDANT //coriolis parameter definition coriolis_latitude = 0.0 //coriolis latitude water_viscosity = 1.0e-06 //water viscosity ## #dissipation min_background_speed = .01 //some comments BKG_polygones = NONE //some comments BKG_values = NONE //some comments background_velocity_file = NONE //some comments ice_shelves_file = NONE //ice shelves polygons ice_shelves_coefficients = 2.0 //friction factor applied below ice shelves bottom_friction_type = QUADRATIC //some comments bottom_rugosity_file = NONE //prescribed z0 file, LGP1 discretisation linear_friction_coeff = 1.5e-3 //default linear bottom friction coefficient (r) quadratic_friction_coeff = 3.0e-3 //default quadratic bottom friction coefficient (Cd) QFC_polygones = NONE //some comments QFC_values = NONE //some comments roughness_length = 5.0e-4 //equivalent roughness length (z0) in quadratic bottom friction coefficient (Cd) computation min_quadratic_friction_coeff = -999 //minimum value for Cd when using roughness formulation QFCM_polygones = NONE //some comments QFCM_values = NONE //some comments bottom_coeff_file = NONE //prescribed Cd file, LGP1 discretisation rugosity_polygones = NONE //some comments rugosity_values = NONE //some comments rugosity_values_by_regions = NONE //some comments internal_drag_algorithm = 0 //some comments internal_drag_slope = 0.0 //some comments internal_drag_hmin = 200 //some comments internal_drag_hmax = 300 //some comments internal_drag_polygones = NONE //some comments internal_drag_values = NONE //some comments internal_drag_values_by_regions = NONE //some comments internal_drag_rugosity = 0.00 //some comments mixed_layer_coeff = 0.00 //some comments min_horizontal_viscosity = 1.00 //some comments smagorinsky_coefficient = 0.28 //some comments horizontal_viscosity_mode = SMAGORINSKY //some comments brunt_vassalla_value = 0.002 //some comments brunt_vassalla_file = NONE //some comments shear_drag_flag = FALSE //some comments ## #dissipation3D min_background_speed = 0.05 //some comments BKG_polygones = NONE //some comments BKG_values = NONE //some comments background_velocity_file = NONE //some comments ice_shelves_file = NONE //ice shelves polygons ice_shelves_coefficients = 2.0 //friction factor applied below ice shelves bottom_friction_type = QUADRATIC //some comments bottom_rugosity_file = NONE //prescribed z0 file, LGP1 discretisation linear_friction_coeff = 2.5e-3 //default linear bottom friction coefficient (r) quadratic_friction_coeff = 2.5e-3 //default quadratic bottom friction coefficient (Cd) QFC_polygones = NONE //some comments QFC_values = NONE //some comments roughness_length = 1.0e-4 //equivalent roughness length (z0) in quadratic bottom friction coefficient (Cd) computation min_quadratic_friction_coeff = -999 //minimum value for Cd when using roughness formulation QFCM_polygones = NONE //some comments QFCM_values = NONE //some comments bottom_coeff_file = NONE //prescribed Cd file, LGP1 discretisation rugosity_polygones = NONE //some comments rugosity_values = NONE //some comments rugosity_values_by_regions = NONE //some comments internal_drag_algorithm = 0 //some comments internal_drag_slope = 0.00 //some comments internal_drag_hmin = 300 //some comments internal_drag_hmax = 500 //some comments internal_drag_polygones = NONE //some comments internal_drag_values = NONE //some comments internal_drag_values_by_regions = NONE //some comments internal_drag_rugosity = 0.00 //some comments mixed_layer_coeff = 0.00 //some comments min_horizontal_viscosity = 1.00 //some comments smagorinsky_coefficient = 0.28 //some comments horizontal_viscosity_mode = SMAGORINSKY //some comments brunt_vassalla_value = 0.002 //some comments brunt_vassalla_file = NONE //some comments shear_drag_flag = FALSE //some comments ## #tide tide_flag = TRUE //some comments AstronomicPotentialFlag = TRUE //enable/disable gravitaional forcing LSA_flag = TRUE //enable/disable LSA forcing LSA_directory = /home/softs/data/loading/FES2004 //pathname for LSA input files LSA_convention = WAVE.load.nc //LSA filename formatting Atlas_directory = /data1/FES2013 //Tidal atlas pathname for online OBC computation Atlas_convention = WAVE.spectral.nc //Atlas filename formatting pressure_flag = FALSE //enable/disable atmospheric pressure forcing pressure_directory = NONE //pathname for atmospheric pressure input files pressure_convention = WAVE.tide.nc //pressure forcing filename formatting admittance = FALSE //enable/disable admittance spectrum extension equilibrium = FALSE //enable/disbale equilibrium tide onnline OBC computation nodal_correction = FALSE //enabke/disbale nodal corrections LSA_coeff = 0.0 //some comments Deformation_love_num = 0.1 //linear LSA coefficient tidal_BC = TRUE //enable/disable tidal boundary conditions BC_tide_file = ../data/OBC-FES2012/tides.obc //tidal boundary conditions input file spectral_solver = TRUE //enable/disable spectral tide solver solver_type = PASTIX //spectral linear solver dominant_wave_1 = M2 //1st dominant wave for spectral solver dominant_wave_2 = K1 //2nd dominant wave for spectral solver prior_solution = /home/models/iroise-HYCOM/simulation-tides/prior //prior solution for friction spectral_paire = CQN1xCQP0 //discretisation for spectral solver spectral_max_iteration = 1 //max iterations for dominant waves in spectral solver compound_max_iteration = 10 //max iterations for compound waves in spectral solver spectral_specific_data = FALSE //use discretisation-specific database for spectral solver spectral_topo_file = NONE //specific topography for spectral solver (u-discretisation compatible) spectral_slope_file = NONE //specific topography's slope for spectral solver (u-discretisation compatible) spectral_recycle = FALSE //recycle spectral solutions for tidal OBCs spectral_archive_level = STANDARD //spectral solutions archive content spectral3D_solver = DISABLED //enable/disable 3D-spectral tidal solver spectral3D_OBCs = BAROTROPIC //OBCs diffusion_duration = 72 //integration duration turbulence model diffusion_time_step = 120 //time step for turbulence model spectral3D_max_iteration = 10 //max iterations for dominant waves in 3D-spectral solver spectral3D_first_iteration = 0 //first iteration for dominant waves in 3D-spectral solver ## #atmosphere atmosphere_flag = FALSE //some comments pressure_flag = FALSE //some comments pressure_directory = AUTO //pathname for atmospheric pressure input files pressure_convention = AUTO //pressure forcing filename formatting wind_flag = FALSE //some comments long_wave_radiation = FALSE //some comments short_wave_radiation = FALSE //some comments atmospheric_directory = NONE //some comments file_format = NETCDF //some comments file_endian = UNIX //some comments file_convention = NONE //some comments MaskFile = NONE //some comments apply_landsea_mask = FALSE //apply land/sea mask on meteorological fields keep_mean_pressure = FALSE //some comments keep_mean_wind = FALSE //some comments time_interpolation = LINEAR //some comments bulk_formula = CLASSIC //some comments wind_stress = BULK //some comments inversebarometer = FALSE //some comments ## #OceanWaves OceanWaves_flag = FALSE //some comments parameterisation = MAC-WILLIAMS //some comments drag_flag = FALSE //some comments friction_flag = FALSE //some comments time_interpolation = LINEAR //some comments discretisation = UNSTRUCTURED //some comments file_directory = NONE //some comments file_format = WW3_SG_NETCDF //input format of ocean waves forcing file_convention = NONE //some comments MaskFile = NONE //some comments ## #boundaries type = 7=(1->2) //some comments mode = LOCAL //some comments relax_time = 2.0 //some comments archived_BC_use = FALSE //some comments archived_BC_directory = NONE //some comments archived_BC_format = BINARY //some comments archived_BC_root = analysis //some comments archived_BC_units = MKS //some comments archived_BC_transport = u //some comments periodic_conditions_file = NONE //contains instructions for boundary condition periodicity sponge_flag = FALSE //some comments rivers_flag = FALSE //some comments rivers_file = rivers.dat //some comments rivers_time_template = CNESTIME //some comments solid_boundary_condition = FREE-SLIP //some comments no_slip_size = 100.0 //some comments ## #ice ice_flag = FALSE //some comments ice_cover_file = NONE //some comments ice_elasticity_file = NONE //some comments TimeStep = 60 //some comments MomentumSolver = 1 //some comments Rheology = 1 //some comments ## #tsunami OnOffFlag = FALSE //some comments bottom_motion_flag = FALSE //some comments bottom_motion_directory = NONE //some comments bottom_motion_file_convention = NONE //some comments ## #miscellaneous non_tidal_loading_flag = FALSE //some comments smoothing_flag = FALSE //some comments checks = FALSE //some comments Check_Wconsistency = FALSE //some comments CompatibilityScale = 1.0 //some comments 2D_3D_coupling = TRUE //some comments Stability_Check = TRUE //some comments Stability_Control = DYNAMIC //some comments Max_Delta_Elevation = 4.0 //some comments Max_Delta_Currents = 4.0 //some comments Max_Delta_Period = 3600. //some comments nSubCycles = 1 //some comments persistence = 6. //some comments SubcyclingTemporization = 10 //some comments SubcyclingExtension = 5 //some comments SubcyclingLockLimit = 5 //some comments SubcyclingCFLratio = 2 //some comments SmoothZField = FALSE //some comments SmoothUField = FALSE //some comments SmoothAdvection = FALSE //some comments SmoothDiffusion = FALSE //some comments flush_tracking = FALSE //some comments toponyms_file = NONE //ocean partition codes ## #fe_archive % if no lines are follow the fe archives use only defaults values OnOffFlag = FALSE //some comments state_file = tugo.state //some comments vector_file = tugo.forcing //some comments archive_format = NETCDF //some comments archive_convention = NONE //some comments archive_start = 0.0 //some comments archive_interval = 10800.0 //some comments archive_bits = 2 //some comments archive_huvscale = 100 100 100 //some comments archive_pWsxWsy_scale = 1000 1000 1000 //some comments overwrite_append_flag = APPEND //some comments surface_elevation = TRUE //some comments barotropic_currents = TRUE //some comments horizontal_diffusion2D = FALSE //some comments horizontal_advection2D = FALSE //some comments transport2D = FALSE //some comments divergence2D = FALSE //some comments horizontal_currents = TRUE //some comments vertical_velocity = TRUE //some comments temperature = FALSE //some comments salinity = FALSE //some comments density = FALSE //some comments horizontal_diffusion = FALSE //some comments horizontal_advection = FALSE //some comments lateral_mixing = FALSE //some comments IB-departure = FALSE //some comments atmospheric_surface_pressure = FALSE //some comments wind_stress = FALSE //some comments radiation_stress = FALSE //some comments gradSxx = FALSE //some comments ## #structured_archive OnOffFlag = FALSE //some comments zone = AUTO //some comments overwrite_append_flag = APPEND //some comments start = 0.0 //some comments interval = 10800.0 //some comments surface_elevation = TRUE //some comments barotropic_currents = TRUE //some comments horizontal_diffusion2D = FALSE //some comments horizontal_advection2D = FALSE //some comments transport2D = FALSE //some comments divergence2D = FALSE //some comments surface_elevation_extrema = FALSE //some comments mean_kinetic_energy2D = FALSE //some comments friction_coefficient = FALSE //some comments IB-departure = FALSE //some comments atmospheric_surface_pressure = FALSE //some comments wind_stress = FALSE //some comments horizontal_currents = TRUE //some comments vertical_velocity = TRUE //some comments temperature = FALSE //some comments salinity = FALSE //some comments density = FALSE //some comments horizontal_diffusion = FALSE //some comments horizontal_advection = FALSE //some comments pressure_gradient = FALSE //some comments lateral_mixing = FALSE //some comments tracer_2d = FALSE //some comments radiation_stress = FALSE //some comments ## #sample_points % if no lines are follow the sample points use only defaults values OnOffFlag = FALSE //some comments file = tugoPlot.input //some comments start = 0.0 //some comments save_interval = 1800 //some comments overwright_append_flag = APPEND //some comments SectionOnOffFlag = FALSE //some comments SectionInputFile = NONE //some comments SectionStart = 0.0 //some comments SectionSaveInterval = 1800 //some comments SectionOverAppendFlag = APPEND //some comments ## #analysis % if no lines are follow the harmonic analysis use only defaults values OnOffFlag = FALSE //some comments list_file = NONE //some comments auto_completion = TRUE //if list file not given, do spectrum auto-completion harmonic_start = 2*#MODEL.$spinup./3600/24.0 //some comments sample_interval = 1800 //some comments compute_interval = 365 //some comments strategy = FULL //some comments sequential_recycle = MANAGED //recycle sequential solutions for tidal OBCs sequential_archive_level = STANDARD //sequential solutions archive content LGP1ArchiveFlag = TRUE //create a LGP1xLGP1 ASCII archive for compatibility purposes NETCDFArchiveFlag = TRUE //create a netcdf UG archive (on computational discretisation) SGFlag = TRUE //some comments zone = AUTO //some comments surface_elevation = TRUE //some comments horizontal_currents = TRUE //some comments LSA_potential = TRUE //some comments ## #energy_budget % if no lines are follow the energy budget use only defualts values OnOffFlag = FALSE //some comments start = 0.0 //some comments interval = 1800 //some comments time_step_energy_budget = FALSE //some comments harmonic_energy_budget = TRUE //some comments harmonic_energy_budget_by_regions = NONE //some comments resonance_exploration = FALSE //some comments resonance_frequencies = NONE //some comments ## #tracers % if no lines are follow the energy budget module use only defaults values tracers computation = FALSE //some comments start = 0.0 //some comments interval = 1800 //some comments time_integration = LEAPFROG //some comments input_file = tracers.dat //some comments initialisation_file = NONE //some comments horizontal_diffusion_mode = DEFAULT //some comments horizontal_diffusion_coefficient = 0.0 //some comments smagorinsky_coefficient = 2.8 //some comments upwind_coefficient = 0.1 //some comments ## #drifters2D % if no lines are follow the tracers module use only defaults values drifters2D computation = FALSE //some comments start = 0.0 //some comments interval = 1800 //some comments input_file = drifters2D.dat //some comments ## #dynamics2D % if no lines are follow the 3D module use only defaults values WaveEquationForm = GWE-CLX //continuity equation type Continuity2D_integration = LEAPFROG //continuity time scheme Momentum2D_integration = FORWARD //momentum time scheme Momentum2D_mode = VELOCITY //velocity/transport option in model state variables Advection2D_mode = NON-CONSERVATIVE //some comments AdvectionDiffusion_discretisation = NODE-WISE //some comments SLV_discretisation = CQP0 //elevation/pressure/tracer discretisation v2D_discretisation = CQN1 //velocity discretisation G2D_discretisation = INTRINSIC //pressure gradient discretisation wave_scalar_prouct = QUADRATURE //type of scalar product in wave equation discretization tau_0 = 2e-4 //weight of CE in GWE (more by clicking...) theta = 0.75 //implicit/explicit coefficient (more by clicking...) barotropic_w = FALSE //compute vertical velocity checks horizontal_viscosity_mode = SMAGORINSKY //horizontal diffusion upwind_coefficient = 0.1 //upwind in diffusion computation(more by clicking...) AsselinFilteringH = FALSE //Asselin coefficient for elevation (Leapfrog) AsselinFilteringU = TRUE //Asselin coefficient for velocity (Leapfrog) AsselinCoefficientC1 = 0.1 //c Xn + 1/2*c(Xn-1 + Xn+1) ## #dynamics3D % if no lines are follow the 3D module use only defaults values 3D_computation = FALSE //some comments 3D_time_step = $2D_time_step //some comments Momentum_integration = LEAPFROG //some comments 3D_mode = BAROCLINIC //some comments pressure_mode = HYDROSTATIC //some comments w_derivation = DIRECT //some comments v_discretisation = NCP1 //some comments w_discretisation = QLP1 //some comments max_number_layers = 20 //some comments level_distribution = UNIFORM //some comments level_displacement = SURFACE-ONLY //some comments turbulence_closure = CONSTANT //some comments lateral_diffusion_coefficient = 0.0 //some comments vertical_diffusion_coefficient = 1.e-04 //some comments ## #tracers3D % if no lines are follow the tracers3D module use only defaults values 3D_computation = TRUE //some comments Tracers_integration = FORWARD //some comments tracers_mode = DIAGNOSTIC //some comments tracers_discretisation = LGP0 //some comments tracers_advection_centering = 0.5 //some comments tracer_initialisation = HOMOGENEOUS //some comments initialisation_files_directory = NONE //some comments temperature_initialisation_file = NONE //some comments temperature_variable = AUTO //name of temperature variable salinity_initialisation_file = NONE //some comments salinity_variable = AUTO //name of salinity variable density_initialisation_file = NONE //some comments density_variable = NONE //name of density variable tracer_profile_file = NONE //some comments tracers_lateral_diffusion_coefficient = 0.0 //some comments tracers_horizontal_diffusion_coefficient = 0.0 //some comments tracer_vertical_diffusion_coefficient = 1.e-04 //some comments tracers_Hsmoothing = FALSE //some comments compute_diagnostics = FALSE //some comments ## #streamf % if no lines are follow the tracers module use only defaults values stream_function_computation = FALSE //some comments compute_interval = 1800 //some comments ##