rompy.schism.namelists.wwminput.Engs

pydantic model rompy.schism.namelists.wwminput.Engs

Show JSON schema

{
   "title": "Engs",
   "type": "object",
   "properties": {
      "mesnl": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Controls the nonlinear wave-wave interactions (NL4) using the Discrete Interaction Approximation. 1 enables the interactions, 0 disables them.",
         "title": "Mesnl"
      },
      "mesin": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Specifies the wind input formulation. Options include: 0 (no wind), 1 (Ardhuin et al.), 2 (ECMWF physics), 3 (Makin Stam), 4 (Babanin et al.), 5 (Cycle 3).",
         "title": "Mesin"
      },
      "ifric": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Determines the formulation for the atmospheric boundary layer. Should be 1 when MESIN=1, and 4 when MESIN=3.",
         "title": "Ifric"
      },
      "mesbf": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Selects the bottom friction formulation. 1 for JONSWAP (Default), 2 for Madsen et al. (1989), 3 for SHOWEX.",
         "title": "Mesbf"
      },
      "fricc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.006,
         "description": "Bottom friction coefficient or roughness, depending on MESBF. For MESBF=1: JONSWAP coefficient [0.038,0.067]. For MESBF=2: physical bottom roughness. For MESBF=3: D50 (negative value reads from SHOWEX_D50.gr3).",
         "title": "Fricc"
      },
      "mesbr": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Enables (1) or disables (0) shallow water wave breaking.",
         "title": "Mesbr"
      },
      "ibreak": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Selects the wave breaking formulation. Options range from 1 to 6, each representing a different model or approach.",
         "title": "Ibreak"
      },
      "icrit": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Specifies the wave breaking criterion. Options 1-6 represent different methods for determining the breaking point.",
         "title": "Icrit"
      },
      "brcr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.73,
         "description": "Breaking criterion parameter. Its meaning depends on IBREAK and ICRIT settings.",
         "title": "Brcr"
      },
      "a_brcr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.76,
         "description": "Coefficient used in ICRIT=4,5 for calculating the breaking criterion.",
         "title": "A Brcr"
      },
      "b_brcr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.29,
         "description": "Coefficient used in ICRIT=4,5 for calculating the breaking criterion.",
         "title": "B Brcr"
      },
      "min_brcr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.25,
         "description": "Minimum value for the breaking criterion when ICRIT=4,5.",
         "title": "Min Brcr"
      },
      "max_brcr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.8,
         "description": "Maximum value for the breaking criterion when ICRIT=4,5.",
         "title": "Max Brcr"
      },
      "a_biph": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.2,
         "description": "Biphase coefficient, used when IBREAK=3.",
         "title": "A Biph"
      },
      "br_coef_method": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Method for determining the breaking coefficient. 1 for constant, 2 for adaptive.",
         "title": "Br Coef Method"
      },
      "b_alp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "Breaking coefficient. If BR_COEF_METHOD = 2, B_ALP should be around 40.",
         "title": "B Alp"
      },
      "zprof_break": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Specifies the vertical distribution function of the wave breaking source term in 3D runs. Options 1-6 represent different distribution functions.",
         "title": "Zprof Break"
      },
      "bc_break": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Controls the application of depth-limited breaking at boundaries. 1 to enable, 0 to disable.",
         "title": "Bc Break"
      },
      "iroller": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Enables (1) or disables (0) the wave roller model. Currently not in use.",
         "title": "Iroller"
      },
      "alprol": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.85,
         "description": "Alpha coefficient for the wave roller model, determining the energy transfer to the roller. Range: 0 to 1.",
         "title": "Alprol"
      },
      "meveg": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Enables (1) or disables (0) vegetation effects. If enabled, isav must be 1 in param.nml.",
         "title": "Meveg"
      },
      "lmaxetot": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Controls the use of wave breaking limiter to limit shallow water wave height. True to enable, False to disable.",
         "title": "Lmaxetot"
      },
      "mesds": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Specifies the formulation for the whitecapping source function. Should have the same value as MESIN.",
         "title": "Mesds"
      },
      "mestr": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Selects the formulation for triad 3 wave interactions. 0 (off), 1 (Lumped Triad Approx.), 2 (corrected LTA by Salmon et al. (2016)).",
         "title": "Mestr"
      },
      "trico": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.1,
         "description": "Proportionality constant (\u03b1_EB) for triad interactions. Default is 0.1.",
         "title": "Trico"
      },
      "trira": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 2.5,
         "description": "Ratio of maximum frequency considered in triads over mean frequency. Suggested value is 2.5.",
         "title": "Trira"
      },
      "triurs": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.1,
         "description": "Critical Ursell number for triad computations. Triads are not computed if Ursell number < TRIURS.",
         "title": "Triurs"
      }
   },
   "additionalProperties": false
}

Fields:

• a_biph (float | None)

• a_brcr (float | None)

• alprol (float | None)

• b_alp (float | None)

• b_brcr (float | None)

• bc_break (int | None)

• br_coef_method (int | None)

• brcr (float | None)

• fricc (float | None)

• ibreak (int | None)

• icrit (int | None)

• ifric (int | None)

• iroller (int | None)

• lmaxetot (bool | None)

• max_brcr (float | None)

• mesbf (int | None)

• mesbr (int | None)

• mesds (int | None)

• mesin (int | None)

• mesnl (int | None)

• mestr (int | None)

• meveg (int | None)

• min_brcr (float | None)

• trico (float | None)

• trira (float | None)

• triurs (float | None)

• zprof_break (int | None)

Validators:

• validate_alprol » alprol

• validate_b_alp » b_alp

• validate_bc_break » bc_break

• validate_br_coef_method » br_coef_method

• validate_brcr » brcr

• validate_fricc » fricc

• validate_ibreak » ibreak

• validate_icrit » icrit

• validate_ifric » ifric

• validate_iroller » iroller

• validate_mesbf » mesbf

• validate_mesbr » mesbr

• validate_mesds » mesds

• validate_mesin » mesin

• validate_mesnl » mesnl

• validate_mestr » mestr

• validate_meveg » meveg

• validate_zprof_break » zprof_break

field a_biph: float | None = 0.2

Biphase coefficient, used when IBREAK=3.

Validated by:

• __lowercase_property_keys__

field a_brcr: float | None = 0.76

Coefficient used in ICRIT=4,5 for calculating the breaking criterion.

Validated by:

• __lowercase_property_keys__

field alprol: float | None = 0.85

Alpha coefficient for the wave roller model, determining the energy transfer to the roller. Range: 0 to 1.

Validated by:

• __lowercase_property_keys__

• validate_alprol

field b_alp: float | None = 0.5

Breaking coefficient. If BR_COEF_METHOD = 2, B_ALP should be around 40.

Validated by:

• __lowercase_property_keys__

• validate_b_alp

field b_brcr: float | None = 0.29

Coefficient used in ICRIT=4,5 for calculating the breaking criterion.

Validated by:

• __lowercase_property_keys__

field bc_break: int | None = 1

Controls the application of depth-limited breaking at boundaries. 1 to enable, 0 to disable.

Validated by:

• __lowercase_property_keys__

• validate_bc_break

field br_coef_method: int | None = 1

Method for determining the breaking coefficient. 1 for constant, 2 for adaptive.

Validated by:

• __lowercase_property_keys__

• validate_br_coef_method

field brcr: float | None = 0.73

Breaking criterion parameter. Its meaning depends on IBREAK and ICRIT settings.

Validated by:

• __lowercase_property_keys__

• validate_brcr

field fricc: float | None = 0.006

Bottom friction coefficient or roughness, depending on MESBF. For MESBF=1: JONSWAP coefficient [0.038,0.067]. For MESBF=2: physical bottom roughness. For MESBF=3: D50 (negative value reads from SHOWEX_D50.gr3).

Validated by:

• __lowercase_property_keys__

• validate_fricc

field ibreak: int | None = 1

Selects the wave breaking formulation. Options range from 1 to 6, each representing a different model or approach.

Validated by:

• __lowercase_property_keys__

• validate_ibreak

field icrit: int | None = 1

Specifies the wave breaking criterion. Options 1-6 represent different methods for determining the breaking point.

Validated by:

• __lowercase_property_keys__

• validate_icrit

field ifric: int | None = 1

Determines the formulation for the atmospheric boundary layer. Should be 1 when MESIN=1, and 4 when MESIN=3.

Validated by:

• __lowercase_property_keys__

• validate_ifric

field iroller: int | None = 0

Enables (1) or disables (0) the wave roller model. Currently not in use.

Validated by:

• __lowercase_property_keys__

• validate_iroller

field lmaxetot: bool | None = True

Controls the use of wave breaking limiter to limit shallow water wave height. True to enable, False to disable.

Validated by:

• __lowercase_property_keys__

field max_brcr: float | None = 0.8

Maximum value for the breaking criterion when ICRIT=4,5.

Validated by:

• __lowercase_property_keys__

field mesbf: int | None = 2

Selects the bottom friction formulation. 1 for JONSWAP (Default), 2 for Madsen et al. (1989), 3 for SHOWEX.

Validated by:

• __lowercase_property_keys__

• validate_mesbf

field mesbr: int | None = 1

Enables (1) or disables (0) shallow water wave breaking.

Validated by:

• __lowercase_property_keys__

• validate_mesbr

field mesds: int | None = 1

Specifies the formulation for the whitecapping source function. Should have the same value as MESIN.

Validated by:

• __lowercase_property_keys__

• validate_mesds

field mesin: int | None = 1

Specifies the wind input formulation. Options include: 0 (no wind), 1 (Ardhuin et al.), 2 (ECMWF physics), 3 (Makin Stam), 4 (Babanin et al.), 5 (Cycle 3).

Validated by:

• __lowercase_property_keys__

• validate_mesin

field mesnl: int | None = 1

Controls the nonlinear wave-wave interactions (NL4) using the Discrete Interaction Approximation. 1 enables the interactions, 0 disables them.

Validated by:

• __lowercase_property_keys__

• validate_mesnl

field mestr: int | None = 1

Selects the formulation for triad 3 wave interactions. 0 (off), 1 (Lumped Triad Approx.), 2 (corrected LTA by Salmon et al. (2016)).

Validated by:

• __lowercase_property_keys__

• validate_mestr

field meveg: int | None = 0

Enables (1) or disables (0) vegetation effects. If enabled, isav must be 1 in param.nml.

Validated by:

• __lowercase_property_keys__

• validate_meveg

field min_brcr: float | None = 0.25

Minimum value for the breaking criterion when ICRIT=4,5.

Validated by:

• __lowercase_property_keys__

field trico: float | None = 0.1

Proportionality constant (α_EB) for triad interactions. Default is 0.1.

Validated by:

• __lowercase_property_keys__

field trira: float | None = 2.5

Ratio of maximum frequency considered in triads over mean frequency. Suggested value is 2.5.

Validated by:

• __lowercase_property_keys__

field triurs: float | None = 0.1

Critical Ursell number for triad computations. Triads are not computed if Ursell number < TRIURS.

Validated by:

• __lowercase_property_keys__

field zprof_break: int | None = 2

Specifies the vertical distribution function of the wave breaking source term in 3D runs. Options 1-6 represent different distribution functions.

Validated by:

• __lowercase_property_keys__

• validate_zprof_break

validator validate_alprol  »  alprol

validator validate_b_alp  »  b_alp

validator validate_bc_break  »  bc_break

validator validate_br_coef_method  »  br_coef_method

validator validate_brcr  »  brcr

validator validate_fricc  »  fricc

validator validate_ibreak  »  ibreak

validator validate_icrit  »  icrit

validator validate_ifric  »  ifric

validator validate_iroller  »  iroller

validator validate_mesbf  »  mesbf

validator validate_mesbr  »  mesbr

validator validate_mesds  »  mesds

validator validate_mesin  »  mesin

validator validate_mesnl  »  mesnl

validator validate_mestr  »  mestr

validator validate_meveg  »  meveg

validator validate_zprof_break  »  zprof_break