rompy.swan.subcomponents.physics.TRANSM#

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

Constant transmission coefficient.

TRANSM [trcoef]

Examples

In [81]: from rompy.swan.subcomponents.physics import TRANSM

In [82]: transm = TRANSM()

In [83]: print(transm.render())
TRANSM

In [84]: transm = TRANSM(trcoef=0.5)

In [85]: print(transm.render())
TRANSM trcoef=0.5

Show JSON schema
{
   "title": "TRANSM",
   "description": "Constant transmission coefficient.\n\n.. code-block:: text\n\n    TRANSM [trcoef]\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import TRANSM\n    transm = TRANSM()\n    print(transm.render())\n    transm = TRANSM(trcoef=0.5)\n    print(transm.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "transm",
         "description": "Model type discriminator",
         "enum": [
            "transm",
            "TRANSM"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "trcoef": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Constant transmission coefficient (ratio of transmitted over incoming significant wave height) (SWAN default: 0.0) (no transmission = complete blockage)",
         "title": "Trcoef"
      }
   },
   "additionalProperties": false
}

Fields:
field model_type: Literal['transm', 'TRANSM'] = 'transm'#

Model type discriminator

field trcoef: float | None = None#

Constant transmission coefficient (ratio of transmitted over incoming significant wave height) (SWAN default: 0.0) (no transmission = complete blockage)

Constraints:

  • ge = 0.0

  • le = 1.0

cmd() → str[source]#

Command file string for this subcomponent.