rompy.schism.namelists.wwminput.History#
- pydantic model rompy.schism.namelists.wwminput.History[source]#
Show JSON schema
{ "title": "History", "type": "object", "properties": { "begtc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "20200101.000000", "description": "Start output time in 'yyyymmdd.hhmmss' format. Must fit within the simulation time, otherwise no output. Defaults to PROC%BEGTC if not specified.", "title": "Begtc" }, "deltc": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 3600, "description": "Time step for output in seconds. If smaller than simulation time step, the latter is used. Used for better 1D and 2D spectra analysis.", "title": "Deltc" }, "unitc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "SEC", "description": "Unit of time for DELTC. Currently only supports 'SEC' for seconds.", "title": "Unitc" }, "endtc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "20200201.000000", "description": "Stop time for output in 'yyyymmdd.hhmmss' format. Defaults to PROC%ENDC if not specified.", "title": "Endtc" }, "definetc": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": -1, "description": "Time scoop (in seconds) for history files. If negative or unset, only one file is generated. For example, 86400 creates daily output files.", "title": "Definetc" }, "outstyle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "NO", "description": "Output option. 'NO' for no output, 'NC' for netCDF, 'XFN' for XFN (default), 'SHP' for DARKO SHP output.", "title": "Outstyle" }, "multipleout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 0, "description": "Output file configuration. 0 for single netCDF file using MPI_reduce (default), 1 for separate netCDF files for each process.", "title": "Multipleout" }, "use_single_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Use single precision in the output of model variables. True by default.", "title": "Use Single Out" }, "paramwrite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Write the physical parametrization and chosen numerical method in the netCDF file. True by default.", "title": "Paramwrite" }, "gridwrite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Write the grid in the netCDF history file. True by default.", "title": "Gridwrite" }, "printmma": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Print minimum, maximum and average value of statistics during runtime. Requires MPI_REDUCE. False by default.", "title": "Printmma" }, "fileout": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "wwm_hist.nc", "description": "Name of the output file.", "title": "Fileout" }, "hs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output significant wave height.", "title": "Hs" }, "tm01": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output mean period.", "title": "Tm01" }, "tm02": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output zero-crossing mean period.", "title": "Tm02" }, "klm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output mean wave number.", "title": "Klm" }, "wlm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output mean wave length.", "title": "Wlm" }, "etotc": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output variable ETOTC.", "title": "Etotc" }, "etots": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output variable ETOTS.", "title": "Etots" }, "dm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output mean wave direction.", "title": "Dm" }, "dspr": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output directional spreading.", "title": "Dspr" }, "tppd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output direction of the peak (check source code for details).", "title": "Tppd" }, "tpp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output peak period.", "title": "Tpp" }, "cpp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output peak phase velocity.", "title": "Cpp" }, "wnpp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output peak wave number.", "title": "Wnpp" }, "cgpp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output peak group speed.", "title": "Cgpp" }, "kpp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output peak wave number.", "title": "Kpp" }, "lpp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output peak wave length.", "title": "Lpp" }, "peakd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output peak direction.", "title": "Peakd" }, "peakdspr": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output peak directional spreading.", "title": "Peakdspr" }, "dpeak": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output peak direction.", "title": "Dpeak" }, "ubot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output bottom excursion velocity.", "title": "Ubot" }, "orbital": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output bottom orbital velocity.", "title": "Orbital" }, "botexper": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output bottom excursion.", "title": "Botexper" }, "tmbot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output bottom period.", "title": "Tmbot" }, "ursell": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output Ursell number.", "title": "Ursell" }, "ufric": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output air friction velocity.", "title": "Ufric" }, "z0": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output air roughness length.", "title": "Z0" }, "alpha_ch": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output Charnock coefficient for air.", "title": "Alpha Ch" }, "windx": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output wind in X direction.", "title": "Windx" }, "windy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output wind in Y direction.", "title": "Windy" }, "cd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output drag coefficient.", "title": "Cd" }, "currtx": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output current in X direction.", "title": "Currtx" }, "currty": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output current in Y direction.", "title": "Currty" }, "watlev": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output water level.", "title": "Watlev" }, "watlevold": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output water level at previous time step.", "title": "Watlevold" }, "depdt": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output change of water level in time.", "title": "Depdt" }, "dep": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output depth.", "title": "Dep" }, "tauw": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output surface stress from the wave.", "title": "Tauw" }, "tauhf": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output high frequency surface stress.", "title": "Tauhf" }, "tautot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output total surface stress.", "title": "Tautot" }, "stokessurfx": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output surface Stokes drift in X direction.", "title": "Stokessurfx" }, "stokessurfy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Output surface Stokes drift in Y direction.", "title": "Stokessurfy" }, "stokesbarox": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output barotropic Stokes drift in X direction.", "title": "Stokesbarox" }, "stokesbaroy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output barotropic Stokes drift in Y direction.", "title": "Stokesbaroy" }, "rsxx": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output RSXX potential of LH.", "title": "Rsxx" }, "rsxy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output RSXY potential of LH.", "title": "Rsxy" }, "rsyy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output RSYY potential of LH.", "title": "Rsyy" }, "cfl1": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output CFL number 1.", "title": "Cfl1" }, "cfl2": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output CFL number 2.", "title": "Cfl2" }, "cfl3": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Output CFL number 3.", "title": "Cfl3" } }, "additionalProperties": false }
- Fields:
- Validators:
- field alpha_ch: bool | None = False#
Output Charnock coefficient for air.
- Validated by:
__lowercase_property_keys__
- field begtc: str | None = '20200101.000000'#
Start output time in ‘yyyymmdd.hhmmss’ format. Must fit within the simulation time, otherwise no output. Defaults to PROC%BEGTC if not specified.
- Validated by:
__lowercase_property_keys__
- field botexper: bool | None = False#
Output bottom excursion.
- Validated by:
__lowercase_property_keys__
- field cd: bool | None = False#
Output drag coefficient.
- Validated by:
__lowercase_property_keys__
- field cfl1: bool | None = False#
Output CFL number 1.
- Validated by:
__lowercase_property_keys__
- field cfl2: bool | None = False#
Output CFL number 2.
- Validated by:
__lowercase_property_keys__
- field cfl3: bool | None = False#
Output CFL number 3.
- Validated by:
__lowercase_property_keys__
- field cgpp: bool | None = False#
Output peak group speed.
- Validated by:
__lowercase_property_keys__
- field cpp: bool | None = False#
Output peak phase velocity.
- Validated by:
__lowercase_property_keys__
- field currtx: bool | None = False#
Output current in X direction.
- Validated by:
__lowercase_property_keys__
- field currty: bool | None = False#
Output current in Y direction.
- Validated by:
__lowercase_property_keys__
- field definetc: int | None = -1#
Time scoop (in seconds) for history files. If negative or unset, only one file is generated. For example, 86400 creates daily output files.
- Validated by:
__lowercase_property_keys__
- field deltc: int | None = 3600#
Time step for output in seconds. If smaller than simulation time step, the latter is used. Used for better 1D and 2D spectra analysis.
- Validated by:
__lowercase_property_keys__
- field dep: bool | None = False#
Output depth.
- Validated by:
__lowercase_property_keys__
- field depdt: bool | None = False#
Output change of water level in time.
- Validated by:
__lowercase_property_keys__
- field dm: bool | None = True#
Output mean wave direction.
- Validated by:
__lowercase_property_keys__
- field dpeak: bool | None = False#
Output peak direction.
- Validated by:
__lowercase_property_keys__
- field dspr: bool | None = True#
Output directional spreading.
- Validated by:
__lowercase_property_keys__
- field endtc: str | None = '20200201.000000'#
Stop time for output in ‘yyyymmdd.hhmmss’ format. Defaults to PROC%ENDC if not specified.
- Validated by:
__lowercase_property_keys__
- field etotc: bool | None = False#
Output variable ETOTC.
- Validated by:
__lowercase_property_keys__
- field etots: bool | None = False#
Output variable ETOTS.
- Validated by:
__lowercase_property_keys__
- field fileout: str | None = 'wwm_hist.nc'#
Name of the output file.
- Validated by:
__lowercase_property_keys__
- field gridwrite: bool | None = True#
Write the grid in the netCDF history file. True by default.
- Validated by:
__lowercase_property_keys__
- field hs: bool | None = True#
Output significant wave height.
- Validated by:
__lowercase_property_keys__
- field klm: bool | None = False#
Output mean wave number.
- Validated by:
__lowercase_property_keys__
- field kpp: bool | None = False#
Output peak wave number.
- Validated by:
__lowercase_property_keys__
- field lpp: bool | None = False#
Output peak wave length.
- Validated by:
__lowercase_property_keys__
- field multipleout: int | None = 0#
Output file configuration. 0 for single netCDF file using MPI_reduce (default), 1 for separate netCDF files for each process.
- Validated by:
__lowercase_property_keys__
- field orbital: bool | None = False#
Output bottom orbital velocity.
- Validated by:
__lowercase_property_keys__
- field outstyle: str | None = 'NO'#
Output option. ‘NO’ for no output, ‘NC’ for netCDF, ‘XFN’ for XFN (default), ‘SHP’ for DARKO SHP output.
- Validated by:
__lowercase_property_keys__
- field paramwrite: bool | None = True#
Write the physical parametrization and chosen numerical method in the netCDF file. True by default.
- Validated by:
__lowercase_property_keys__
- field peakd: bool | None = True#
Output peak direction.
- Validated by:
__lowercase_property_keys__
- field peakdspr: bool | None = True#
Output peak directional spreading.
- Validated by:
__lowercase_property_keys__
- field printmma: bool | None = False#
Print minimum, maximum and average value of statistics during runtime. Requires MPI_REDUCE. False by default.
- Validated by:
__lowercase_property_keys__
- field rsxx: bool | None = False#
Output RSXX potential of LH.
- Validated by:
__lowercase_property_keys__
- field rsxy: bool | None = False#
Output RSXY potential of LH.
- Validated by:
__lowercase_property_keys__
- field rsyy: bool | None = False#
Output RSYY potential of LH.
- Validated by:
__lowercase_property_keys__
- field stokesbarox: bool | None = False#
Output barotropic Stokes drift in X direction.
- Validated by:
__lowercase_property_keys__
- field stokesbaroy: bool | None = False#
Output barotropic Stokes drift in Y direction.
- Validated by:
__lowercase_property_keys__
- field stokessurfx: bool | None = True#
Output surface Stokes drift in X direction.
- Validated by:
__lowercase_property_keys__
- field stokessurfy: bool | None = True#
Output surface Stokes drift in Y direction.
- Validated by:
__lowercase_property_keys__
- field tauhf: bool | None = False#
Output high frequency surface stress.
- Validated by:
__lowercase_property_keys__
- field tautot: bool | None = True#
Output total surface stress.
- Validated by:
__lowercase_property_keys__
- field tauw: bool | None = True#
Output surface stress from the wave.
- Validated by:
__lowercase_property_keys__
- field tm01: bool | None = True#
Output mean period.
- Validated by:
__lowercase_property_keys__
- field tm02: bool | None = True#
Output zero-crossing mean period.
- Validated by:
__lowercase_property_keys__
- field tmbot: bool | None = False#
Output bottom period.
- Validated by:
__lowercase_property_keys__
- field tpp: bool | None = True#
Output peak period.
- Validated by:
__lowercase_property_keys__
- field tppd: bool | None = False#
Output direction of the peak (check source code for details).
- Validated by:
__lowercase_property_keys__
- field ubot: bool | None = False#
Output bottom excursion velocity.
- Validated by:
__lowercase_property_keys__
- field ufric: bool | None = False#
Output air friction velocity.
- Validated by:
__lowercase_property_keys__
- field unitc: str | None = 'SEC'#
Unit of time for DELTC. Currently only supports ‘SEC’ for seconds.
- Validated by:
__lowercase_property_keys__
- field ursell: bool | None = False#
Output Ursell number.
- Validated by:
__lowercase_property_keys__
- field use_single_out: bool | None = True#
Use single precision in the output of model variables. True by default.
- Validated by:
__lowercase_property_keys__
- field watlev: bool | None = False#
Output water level.
- Validated by:
__lowercase_property_keys__
- field watlevold: bool | None = False#
Output water level at previous time step.
- Validated by:
__lowercase_property_keys__
- field windx: bool | None = False#
Output wind in X direction.
- Validated by:
__lowercase_property_keys__
- field windy: bool | None = False#
Output wind in Y direction.
- Validated by:
__lowercase_property_keys__
- field wlm: bool | None = False#
Output mean wave length.
- Validated by:
__lowercase_property_keys__
- field wnpp: bool | None = False#
Output peak wave number.
- Validated by:
__lowercase_property_keys__
- field z0: bool | None = False#
Output air roughness length.
- Validated by:
__lowercase_property_keys__
- validator validate_multipleout » multipleout[source]#
- validator validate_paramwrite » paramwrite[source]#
- validator validate_stokesbarox » stokesbarox[source]#
- validator validate_stokesbaroy » stokesbaroy[source]#
- validator validate_stokessurfx » stokessurfx[source]#
- validator validate_stokessurfy » stokessurfy[source]#
- validator validate_use_single_out » use_single_out[source]#