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

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.