rompy.schism.namelists.wwminput.Petscoptions

pydantic model rompy.schism.namelists.wwminput.Petscoptions

Show JSON schema

{
   "title": "Petscoptions",
   "type": "object",
   "properties": {
      "ksptype": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "LGMRES",
         "description": "Controls the linear solver type used by PETSc. Options include GMRES, LGMRES (augmented GMRES), DGMRES (deflated GMRES), PGMRES (pipelined GMRES), and KSPBCGSL (variant of Enhanced BiCGStab(L)).",
         "title": "Ksptype"
      },
      "rtol": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-20,
         "description": "Relative convergence tolerance, representing the relative decrease in the residual norm for the iterative solver.",
         "title": "Rtol"
      },
      "abstol": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-20,
         "description": "Absolute convergence tolerance, representing the absolute size of the residual norm for the iterative solver.",
         "title": "Abstol"
      },
      "dtol": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 10000.0,
         "description": "Divergence tolerance for the iterative solver.",
         "title": "Dtol"
      },
      "maxits": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1000,
         "description": "Maximum number of iterations allowed for the iterative solver.",
         "title": "Maxits"
      },
      "initialguessnonzero": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Boolean flag indicating whether the initial guess for the iterative solver is nonzero.",
         "title": "Initialguessnonzero"
      },
      "gmrespreallocate": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Boolean flag indicating whether GMRES and FGMRES should preallocate all needed work vectors at initial setup.",
         "title": "Gmrespreallocate"
      },
      "pctype": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "SOR",
         "description": "Controls the preconditioner type used by PETSc. Options include SOR (successive over relaxation), ASM (additive Schwarz method), HYPRE (LLNL package), SPAI (Sparse Approximate Inverse), and NONE (no preconditioning).",
         "title": "Pctype"
      }
   },
   "additionalProperties": false
}

Fields:

• abstol (float | None)

• dtol (float | None)

• gmrespreallocate (bool | None)

• initialguessnonzero (bool | None)

• ksptype (str | None)

• maxits (int | None)

• pctype (str | None)

• rtol (float | None)

Validators:

• validate_abstol » abstol

• validate_dtol » dtol

• validate_gmrespreallocate » gmrespreallocate

• validate_initialguessnonzero » initialguessnonzero

• validate_ksptype » ksptype

• validate_maxits » maxits

• validate_pctype » pctype

• validate_rtol » rtol

field abstol: float | None = 1e-20

Absolute convergence tolerance, representing the absolute size of the residual norm for the iterative solver.

Validated by:

• __lowercase_property_keys__

• validate_abstol

field dtol: float | None = 10000.0

Divergence tolerance for the iterative solver.

Validated by:

• __lowercase_property_keys__

• validate_dtol

field gmrespreallocate: bool | None = True

Boolean flag indicating whether GMRES and FGMRES should preallocate all needed work vectors at initial setup.

Validated by:

• __lowercase_property_keys__

• validate_gmrespreallocate

field initialguessnonzero: bool | None = False

Boolean flag indicating whether the initial guess for the iterative solver is nonzero.

Validated by:

• __lowercase_property_keys__

• validate_initialguessnonzero

field ksptype: str | None = 'LGMRES'

Controls the linear solver type used by PETSc. Options include GMRES, LGMRES (augmented GMRES), DGMRES (deflated GMRES), PGMRES (pipelined GMRES), and KSPBCGSL (variant of Enhanced BiCGStab(L)).

Validated by:

• __lowercase_property_keys__

• validate_ksptype

field maxits: int | None = 1000

Maximum number of iterations allowed for the iterative solver.

Validated by:

• __lowercase_property_keys__

• validate_maxits

field pctype: str | None = 'SOR'

Controls the preconditioner type used by PETSc. Options include SOR (successive over relaxation), ASM (additive Schwarz method), HYPRE (LLNL package), SPAI (Sparse Approximate Inverse), and NONE (no preconditioning).

Validated by:

• __lowercase_property_keys__

• validate_pctype

field rtol: float | None = 1e-20

Relative convergence tolerance, representing the relative decrease in the residual norm for the iterative solver.

Validated by:

• __lowercase_property_keys__

• validate_rtol

validator validate_abstol  »  abstol

validator validate_dtol  »  dtol

validator validate_gmrespreallocate  »  gmrespreallocate

validator validate_initialguessnonzero  »  initialguessnonzero

validator validate_ksptype  »  ksptype

validator validate_maxits  »  maxits

validator validate_pctype  »  pctype

validator validate_rtol  »  rtol