rompy.swan.components.physics.NEGATINP#

pydantic model rompy.swan.components.physics.NEGATINP[source]#

Negative wind input.

NEGATINP [rdcoef]

With this optional command the user activates negative wind input. This is intended only for use with non-breaking swell dissipation SSWELL ZIEGER. Parameter rdcoef is a fraction between 0 and 1, representing the strength of negative wind input. As an example, with [rdcoef]=0.04, for a spectral bin that is opposed to the wind direction, the wind input factor W(k, θ) is negative, and its magnitude is 4% of the corresponding value of the spectral bin that is in the opposite direction (i.e. in the wind direction). See Zieger et al. (2015) eq. 11, where a0 is their notation for [rdcoef]. Default [rdcoef]=0.0 and rdcoef=0.04 is recommended, though as implied by Zieger et al. (2015), this value is not well-established, so the user is encouraged to experiment with other values.

References

Zieger, S., Babanin, A.V., Rogers, W.E. and Young, I.R., 2015. Observation-based source terms in the third-generation wave model WAVEWATCH. Ocean Modelling, 96, pp.2-25.

Examples

In [86]: from rompy.swan.components.physics import NEGATINP

In [87]: negatinp = NEGATINP()

In [88]: print(negatinp.render())
NEGATINP

In [89]: negatinp = NEGATINP(rdcoef=0.04)

In [90]: print(negatinp.render())
NEGATINP rdcoef=0.04

Show JSON schema
{
   "title": "NEGATINP",
   "description": "Negative wind input.\n\n.. code-block:: text\n\n    NEGATINP [rdcoef]\n\nWith this optional command the user activates negative wind input. **This is\nintended only for use with non-breaking swell dissipation SSWELL ZIEGER**.\nParameter `rdcoef` is a fraction between 0 and 1, representing the strength of\nnegative wind input. As an example, with [rdcoef]=0.04, for a spectral bin that is\nopposed to the wind direction, the wind input factor W(k, \u03b8) is negative, and its\nmagnitude is 4% of the corresponding value of the spectral bin that is in the\nopposite direction (i.e. in the wind direction). See Zieger et al. (2015) eq. 11,\nwhere a0 is their notation for [rdcoef]. Default [rdcoef]=0.0 and `rdcoef=0.04` is\nrecommended, though as implied by Zieger et al. (2015), this value is not\nwell-established, so the user is encouraged to experiment with other values.\n\nReferences\n----------\nZieger, S., Babanin, A.V., Rogers, W.E. and Young, I.R., 2015. Observation-based\nsource terms in the third-generation wave model WAVEWATCH. Ocean Modelling, 96,\npp.2-25.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import NEGATINP\n    negatinp = NEGATINP()\n    print(negatinp.render())\n    negatinp = NEGATINP(rdcoef=0.04)\n    print(negatinp.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "negatinp",
         "description": "Model type discriminator",
         "enum": [
            "negatinp",
            "NEGATINP"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "rdcoef": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Coefficient representing the strength of negative wind input",
         "title": "Rdcoef"
      }
   },
   "additionalProperties": false
}

Fields:
field model_type: Literal['negatinp', 'NEGATINP'] = 'negatinp'#

Model type discriminator

field rdcoef: float | None = None#

Coefficient representing the strength of negative wind input

Constraints:

  • ge = 0.0

  • le = 1.0

cmd() → str[source]#

Command file string for this component.