rompy.swan.subcomponents.spectrum.TMA#

pydantic model rompy.swan.subcomponents.spectrum.TMA[source]#

TMA spectral shape.

TMA [gamma] [d]

Examples

In [125]: from rompy.swan.subcomponents.spectrum import TMA

In [126]: shape = TMA(gamma=2.0, d=18)

In [127]: print(shape.render())
TMA gamma=2.0 d=18.0

Show JSON schema
{
   "title": "TMA",
   "description": "TMA spectral shape.\n\n.. code-block:: text\n\n    TMA [gamma] [d]\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.spectrum import TMA\n    shape = TMA(gamma=2.0, d=18)\n    print(shape.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "tma",
         "description": "Model type discriminator",
         "enum": [
            "tma",
            "TMA"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "gamma": {
         "default": 3.3,
         "description": "Peak enhancement parameter of the JONSWAP spectrum.",
         "exclusiveMinimum": 0.0,
         "title": "Gamma",
         "type": "number"
      },
      "d": {
         "description": "The reference depth at the wave maker in meters.",
         "exclusiveMinimum": 0.0,
         "title": "D",
         "type": "number"
      }
   },
   "additionalProperties": false,
   "required": [
      "d"
   ]
}

Fields:
field d: float [Required]#

The reference depth at the wave maker in meters.

Constraints:

  • gt = 0.0

field gamma: float = 3.3#

Peak enhancement parameter of the JONSWAP spectrum.

Constraints:

  • gt = 0.0

field model_type: Literal['tma', 'TMA'] = 'tma'#

Model type discriminator

cmd() → str[source]#