rompy.swan.components.physics.OFF#

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

Deactivate physics commands.

OFF WINDGROWTH|QUADRUPL|WCAPPING|BREAKING|REFRAC|FSHIFT|BNDCHK

This command deactivates physics commands. The command can be used to switch off the computation of a certain physics component without having to remove the command from the input file. This is useful for testing purposes.

Examples:#

In [105]: from rompy.swan.components.physics import OFF

In [106]: off = OFF(physics="windgrowth")

In [107]: print(off.render())
OFF WINDGROWTH

Show JSON schema

{
   "title": "OFF",
   "description": "Deactivate physics commands.\n\n.. code-block:: text\n\n    OFF WINDGROWTH|QUADRUPL|WCAPPING|BREAKING|REFRAC|FSHIFT|BNDCHK\n\nThis command deactivates physics commands. The command can be used to switch off\nthe computation of a certain physics component without having to remove the command\nfrom the input file. This is useful for testing purposes.\n\nExamples:\n---------\n\n.. ipython:: python\n\n    from rompy.swan.components.physics import OFF\n    off = OFF(physics=\"windgrowth\")\n    print(off.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "off",
         "description": "Model type discriminator",
         "enum": [
            "off",
            "OFF"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "physics": {
         "$ref": "#/$defs/PhysicsOff",
         "description": "Physics command to be switched off"
      }
   },
   "$defs": {
      "PhysicsOff": {
         "description": "Physics commands to be switched off.\n\nAttributes\n----------\nWINDGROWTH : str = \"windgrowth\"\n    Switches off wind growth (in commands GEN1, GEN2, GEN3).\nQUADRUPL : str = \"quadrupl\"\n    Switches off quadruplet wave interactions (in command GEN3).\nWCAPPING : str = \"wcapping\"\n    Switches off whitecapping (in command GEN3).\nBREAKING : str = \"breaking\"\n    Switches off wave breaking dissipation.\nREFRAC : str = \"refrac\"\n    Switches off wave refraction (action transport in theta space).\nFSHIFT : str = \"fshift\"\n    Switches off frequency shifting (action transport in sigma space).\nBNDCHK : str = \"bndchk\"\n    Switches off the checking of the delta imposed and computed Hs at the boundary.",
         "enum": [
            "windgrowth",
            "quadrupl",
            "wcapping",
            "breaking",
            "refrac",
            "fshift",
            "bndchk"
         ],
         "title": "PhysicsOff",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "physics"
   ]
}

Fields:

model_type (Literal['off', 'OFF'])
physics (rompy.swan.types.PhysicsOff)

field model_type: Literal['off', 'OFF'] = 'off'#: Model type discriminator

field physics: PhysicsOff [Required]#: Physics command to be switched off

cmd() → str[source]#: Command file string for this component.