rompy.schism.namelists.wwminput.Grid#

pydantic model rompy.schism.namelists.wwminput.Grid[source]#

Show JSON schema
{
   "title": "Grid",
   "type": "object",
   "properties": {
      "lcird": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Flag to indicate if a full circle in directional space is used. If True, MINDIR and MAXDIR are ignored.",
         "title": "Lcird"
      },
      "lstag": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag to stagger directional bins with a half Dtheta. Can only be True for regular grids to avoid characteristic line aligning with grid line.",
         "title": "Lstag"
      },
      "mindir": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Minimum direction for simulation in degrees (nautical convention; 0: from N; 90: from E). Not used if LCIRD is True.",
         "title": "Mindir"
      },
      "maxdir": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 360.0,
         "description": "Maximum direction for simulation in degrees. May be less than MINDIR. Not used if LCIRD is True.",
         "title": "Maxdir"
      },
      "mdc": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 24,
         "description": "Number of directional bins",
         "title": "Mdc"
      },
      "frlow": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.04,
         "description": "Low frequency limit of the discrete wave period in Hz (1/period)",
         "title": "Frlow"
      },
      "frhigh": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "High frequency limit of the discrete wave period in Hz",
         "title": "Frhigh"
      },
      "msc": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 24,
         "description": "Number of frequency bins",
         "title": "Msc"
      },
      "filegrid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "hgrid_WWM.gr3",
         "description": "Name of the grid file. Should be 'hgridi_WWM.gr3' if IGRIDTYPE is 3 (SCHISM)",
         "title": "Filegrid"
      },
      "igridtype": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 3,
         "description": "Grid type used. 1: XFN system.dat, 2: WWM-PERIODIC, 3: SCHISM, 4: old WWM type",
         "title": "Igridtype"
      },
      "lslop": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag to enable bottom slope limiter",
         "title": "Lslop"
      },
      "slmax": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.2,
         "description": "Maximum allowed bottom slope when LSLOP is True",
         "title": "Slmax"
      },
      "lvar1d": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag to use variable dx in 1D mode. Not used with SCHISM (IGRIDTYPE = 3)",
         "title": "Lvar1D"
      },
      "loptsig": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag to use optimal distributions of frequencies in spectral space (fi+1 = fi * 1.1)",
         "title": "Loptsig"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field filegrid: str | None = 'hgrid_WWM.gr3'#

Name of the grid file. Should be ‘hgridi_WWM.gr3’ if IGRIDTYPE is 3 (SCHISM)

Validated by:
field frhigh: float | None = 1.0#

High frequency limit of the discrete wave period in Hz

Validated by:
field frlow: float | None = 0.04#

Low frequency limit of the discrete wave period in Hz (1/period)

Validated by:
field igridtype: int | None = 3#

Grid type used. 1: XFN system.dat, 2: WWM-PERIODIC, 3: SCHISM, 4: old WWM type

Validated by:
field lcird: bool | None = True#

Flag to indicate if a full circle in directional space is used. If True, MINDIR and MAXDIR are ignored.

Validated by:
field loptsig: bool | None = False#

Flag to use optimal distributions of frequencies in spectral space (fi+1 = fi * 1.1)

Validated by:
field lslop: bool | None = False#

Flag to enable bottom slope limiter

Validated by:
field lstag: bool | None = False#

Flag to stagger directional bins with a half Dtheta. Can only be True for regular grids to avoid characteristic line aligning with grid line.

Validated by:
field lvar1d: bool | None = False#

Flag to use variable dx in 1D mode. Not used with SCHISM (IGRIDTYPE = 3)

Validated by:
field maxdir: float | None = 360.0#

Maximum direction for simulation in degrees. May be less than MINDIR. Not used if LCIRD is True.

Validated by:
field mdc: int | None = 24#

Number of directional bins

Validated by:
field mindir: float | None = 0.0#

Minimum direction for simulation in degrees (nautical convention; 0: from N; 90: from E). Not used if LCIRD is True.

Validated by:
field msc: int | None = 24#

Number of frequency bins

Validated by:
field slmax: float | None = 0.2#

Maximum allowed bottom slope when LSLOP is True

Validated by:
validator validate_filegrid  »  filegrid[source]#
validator validate_frhigh  »  frhigh[source]#
validator validate_frlow  »  frlow[source]#
validator validate_igridtype  »  igridtype[source]#
validator validate_lcird  »  lcird[source]#
validator validate_loptsig  »  loptsig[source]#
validator validate_lslop  »  lslop[source]#
validator validate_lstag  »  lstag[source]#
validator validate_lvar1d  »  lvar1d[source]#
validator validate_maxdir  »  maxdir[source]#
validator validate_mdc  »  mdc[source]#
validator validate_mindir  »  mindir[source]#
validator validate_msc  »  msc[source]#
validator validate_slmax  »  slmax[source]#