rompy.schism.namelists.wwminput.Coupl#

pydantic model rompy.schism.namelists.wwminput.Coupl[source]#

Show JSON schema
{
   "title": "Coupl",
   "type": "object",
   "properties": {
      "lcpl": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Main switch to enable coupling with the current model. Should be kept on for SCHISM-WWM coupling.",
         "title": "Lcpl"
      },
      "radflag": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "LON",
         "description": "Determines the formulation for wave-induced forces. 'LON' for Longuet-Higgins formulation, 'VOR' for vortex formulation. Usually set to 'LON'.",
         "title": "Radflag"
      },
      "letot": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Option to compute wave-induced radiation stress. If True, radiation stress is based on the integrated wave spectrum. If False (recommended), it's estimated using the directional spectra as described in Roland et al. (2008). False is preferred as it preserves spectral information.",
         "title": "Letot"
      },
      "nlvt": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "Number of vertical layers. Not used when coupled with SCHISM.",
         "title": "Nlvt"
      },
      "dtcoup": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 600.0,
         "description": "Coupling time step in seconds. Not used when coupled to SCHISM.",
         "title": "Dtcoup"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field dtcoup: float | None = 600.0#

Coupling time step in seconds. Not used when coupled to SCHISM.

Validated by:
field lcpl: bool | None = True#

Main switch to enable coupling with the current model. Should be kept on for SCHISM-WWM coupling.

Validated by:
field letot: bool | None = False#

Option to compute wave-induced radiation stress. If True, radiation stress is based on the integrated wave spectrum. If False (recommended), it’s estimated using the directional spectra as described in Roland et al. (2008). False is preferred as it preserves spectral information.

Validated by:
field nlvt: int | None = 10#

Number of vertical layers. Not used when coupled with SCHISM.

Validated by:
field radflag: str | None = 'LON'#

Determines the formulation for wave-induced forces. ‘LON’ for Longuet-Higgins formulation, ‘VOR’ for vortex formulation. Usually set to ‘LON’.

Validated by:
validator validate_dtcoup  »  dtcoup[source]#
validator validate_lcpl  »  lcpl[source]#
validator validate_letot  »  letot[source]#
validator validate_nlvt  »  nlvt[source]#
validator validate_radflag  »  radflag[source]#