rompy.swan.subcomponents.numerics.NONSTAT

pydantic model rompy.swan.subcomponents.numerics.NONSTAT

Computation parameters in nonstationary computation.

Show JSON schema

{
   "title": "NONSTAT",
   "description": "Computation parameters in nonstationary computation.",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "nonstat",
         "description": "Model type discriminator",
         "enum": [
            "nonstat",
            "NONSTAT"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "mxitns": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum number of iterations per time step for nonstationary computations. The computation moves to the next time step when this number is exceeded (SWAN default: `mxitns = 1`",
         "title": "Mxitns"
      }
   },
   "additionalProperties": false
}

Fields:

• model_type (Literal['nonstat', 'NONSTAT'])

• mxitns (int | None)

field model_type: Literal['nonstat', 'NONSTAT'] = 'nonstat'

Model type discriminator

field mxitns: int | None = None

The maximum number of iterations per time step for nonstationary computations. The computation moves to the next time step when this number is exceeded (SWAN default: mxitns = 1

cmd() → str

Command file string for this component.