rompy.swan.subcomponents.physics.TRANS1D#

pydantic model rompy.swan.subcomponents.physics.TRANS1D[source]#

Frequency dependent transmission.

TRANS1D < [trcoef] >

Examples

In [74]: from rompy.swan.subcomponents.physics import TRANS1D

In [75]: transm = TRANS1D(trcoef=[0.0, 0.0, 0.2, 0.5, 0.2, 0.0, 0.0])

In [76]: print(transm.render())
TRANS1D 0.0 0.0 0.2 0.5 0.2 0.0 0.0

Show JSON schema
{
   "title": "TRANS1D",
   "description": "Frequency dependent transmission.\n\n.. code-block:: text\n\n    TRANS1D < [trcoef] >\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import TRANS1D\n    transm = TRANS1D(trcoef=[0.0, 0.0, 0.2, 0.5, 0.2, 0.0, 0.0])\n    print(transm.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "trans1d",
         "description": "Model type discriminator",
         "enum": [
            "trans1d",
            "TRANS1D"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "trcoef": {
         "description": "Transmission coefficient (ratio of transmitted over incoming significant wave height) per frequency. The number of these transmission values must be equal to the number of frequencies, i.e. `msc` + 1",
         "items": {
            "maximum": 1.0,
            "minimum": 0.0,
            "type": "number"
         },
         "title": "Trcoef",
         "type": "array"
      }
   },
   "additionalProperties": false,
   "required": [
      "trcoef"
   ]
}

Fields:
field model_type: Literal['trans1d', 'TRANS1D'] = 'trans1d'#

Model type discriminator

field trcoef: list[float] [Required]#

Transmission coefficient (ratio of transmitted over incoming significant wave height) per frequency. The number of these transmission values must be equal to the number of frequencies, i.e. msc + 1

cmd() → str[source]#

Command file string for this subcomponent.