rompy.swan.subcomponents.numerics.CTHETA#

pydantic model rompy.swan.subcomponents.numerics.CTHETA[source]#

Prevents excessive directional turning.

CTheta [cfl]

This option prevents an excessive directional turning at a single grid point or vertex due to a very coarse bathymetry or current locally. This option limits the directional turning rate cθ based on the CFL restriction. (See Eq. 3.41 of Scientific/Technical documentation). See also the final remark in Section 2.6.3. Note that if this command is not specified, then the limiter is not activated.

Examples

In [289]: from rompy.swan.subcomponents.numerics import CTHETA

In [290]: ctheta = CTHETA()

In [291]: print(ctheta.render())
CTHETA

In [292]: ctheta = CTHETA(cfl=0.9)

In [293]: print(ctheta.render())
CTHETA cfl=0.9

Show JSON schema
{
   "title": "CTHETA",
   "description": "Prevents excessive directional turning.\n\n.. code-block:: text\n\n    CTheta [cfl]\n\nThis option prevents an excessive directional turning at a single grid point or\nvertex due to a very coarse bathymetry or current locally. This option limits the\ndirectional turning rate c\u03b8 based on the CFL restriction. (See Eq. 3.41 of\nScientific/Technical documentation). See also the final remark in Section 2.6.3.\nNote that if this command is not specified, then the limiter is not activated.\n\nExamples\n--------\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.numerics import CTHETA\n    ctheta = CTHETA()\n    print(ctheta.render())\n    ctheta = CTHETA(cfl=0.9)\n    print(ctheta.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "ctheta",
         "description": "Model type discriminator",
         "enum": [
            "ctheta",
            "CTHETA"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cfl": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Upper limit for the CFL restriction for ctheta. A suggestion for this parameter is `cfl = 0.9` (SWAN default: 0.9 when CTHETA is activated)",
         "title": "Cfl"
      }
   },
   "additionalProperties": false
}

Fields:
field cfl: float | None = None#

Upper limit for the CFL restriction for ctheta. A suggestion for this parameter is cfl = 0.9 (SWAN default: 0.9 when CTHETA is activated)

field model_type: Literal['ctheta', 'CTHETA'] = 'ctheta'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.