rompy.swan.subcomponents.numerics.DIRIMPL#

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

Numerical scheme for refraction.

DIRIMPL [cdd]

Examples

In [294]: from rompy.swan.subcomponents.numerics import DIRIMPL

In [295]: dirimpl = DIRIMPL()

In [296]: print(dirimpl.render())
DIRIMPL

In [297]: dirimpl = DIRIMPL(cdd=0.5)

In [298]: print(dirimpl.render())
DIRIMPL cdd=0.5

Show JSON schema
{
   "title": "DIRIMPL",
   "description": "Numerical scheme for refraction.\n\n.. code-block:: text\n\n    DIRIMPL [cdd]\n\nExamples\n--------\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.numerics import DIRIMPL\n    dirimpl = DIRIMPL()\n    print(dirimpl.render())\n    dirimpl = DIRIMPL(cdd=0.5)\n    print(dirimpl.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "dirimpl",
         "description": "Model type discriminator",
         "enum": [
            "dirimpl",
            "DIRIMPL"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cdd": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A value of `cdd=0` corresponds to a central scheme and has the largest accuracy (diffusion \u2248 0) but the computation may more easily generatespurious fluctuations. A value of `cdd=1` corresponds to a first orderupwind scheme and it is more diffusive and therefore preferable if (strong) gradients in depth or current are present (SWAN default: 0.5)",
         "title": "Cdd"
      }
   },
   "additionalProperties": false
}

Fields:
field cdd: float | None = None#

A value of cdd=0 corresponds to a central scheme and has the largest accuracy (diffusion ≈ 0) but the computation may more easily generatespurious fluctuations. A value of cdd=1 corresponds to a first orderupwind scheme and it is more diffusive and therefore preferable if (strong) gradients in depth or current are present (SWAN default: 0.5)

field model_type: Literal['dirimpl', 'DIRIMPL'] = 'dirimpl'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.