rompy.swan.components.physics.OFFS#

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

Deactivate multiple physics commands.

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

This group component is a convenience to allow defining and rendering a list of OFF components.

Examples

In [108]: from rompy.swan.components.physics import OFFS

In [109]: off1 = dict(physics="windgrowth")

In [110]: off2 = dict(physics="wcapping")

In [111]: offs = OFFS(offs=[off1, off2])

In [112]: for off in offs.render():
   .....:     print(off)
   .....: 
O
F
F
 
W
I
N
D
G
R
O
W
T
H


O
F
F
 
W
C
A
P
P
I
N
G

Show JSON schema
{
   "title": "OFFS",
   "description": "Deactivate multiple physics commands.\n\n.. code-block:: text\n\n    OFF WINDGROWTH|QUADRUPL|WCAPPING|BREAKING|REFRAC|FSHIFT|BNDCHK\n    OFF WINDGROWTH|QUADRUPL|WCAPPING|BREAKING|REFRAC|FSHIFT|BNDCHK\n    .\n\nThis group component is a convenience to allow defining and rendering\na list of `OFF` components.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import OFFS\n    off1 = dict(physics=\"windgrowth\")\n    off2 = dict(physics=\"wcapping\")\n    offs = OFFS(offs=[off1, off2])\n    for off in offs.render():\n        print(off)",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "offs",
         "description": "Model type discriminator",
         "enum": [
            "offs",
            "OFFS"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "offs": {
         "description": "Physics commands to deactivate",
         "items": {
            "$ref": "#/$defs/OFF"
         },
         "title": "Offs",
         "type": "array"
      }
   },
   "$defs": {
      "OFF": {
         "additionalProperties": false,
         "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())",
         "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"
            }
         },
         "required": [
            "physics"
         ],
         "title": "OFF",
         "type": "object"
      },
      "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": [
      "offs"
   ]
}

Fields:
field model_type: Literal['offs', 'OFFS'] = 'offs'#

Model type discriminator

field offs: list[OFF] [Required]#

Physics commands to deactivate

cmd() list[source]#

Command file strings for this component.