rompy.swan.subcomponents.numerics.STAT#

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

Computation parameters in stationary computation.

Show JSON schema
{
   "title": "STAT",
   "description": "Computation parameters in stationary computation.",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "stat",
         "description": "Model type discriminator",
         "enum": [
            "stat",
            "STAT"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "mxitst": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum number of iterations for stationary computations. The computation stops when this number is exceeded (SWAN default:  50)",
         "title": "Mxitst"
      },
      "alfa": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Proportionality constant used in the frequency-dependent under-relaxation technique. Based on experiences, a suggestion for this parameter is `alfa = 0.01`. In case of diffraction computations, the use of this parameter is recommended (SWAN default: 0.00)",
         "title": "Alfa"
      }
   },
   "additionalProperties": false
}

Fields:
field alfa: float | None = None#

Proportionality constant used in the frequency-dependent under-relaxation technique. Based on experiences, a suggestion for this parameter is alfa = 0.01. In case of diffraction computations, the use of this parameter is recommended (SWAN default: 0.00)

field model_type: Literal['stat', 'STAT'] = 'stat'#

Model type discriminator

field mxitst: int | None = None#

The maximum number of iterations for stationary computations. The computation stops when this number is exceeded (SWAN default: 50)

cmd() → str[source]#

Command file string for this component.