rompy.schism.namelists.wwminput.Proc#

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

Show JSON schema
{
   "title": "Proc",
   "type": "object",
   "properties": {
      "procname": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "ACS",
         "description": "Project name for the simulation",
         "title": "Procname"
      },
      "dimmode": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Mode of run: 2 for 2D (always 2D when coupled to SCHISM)",
         "title": "Dimmode"
      },
      "lstea": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Steady mode flag (under development)",
         "title": "Lstea"
      },
      "lqstea": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Quasi-Steady Mode flag. If True, WWM-II performs subiterations defined as DELTC/NQSITER unless QSCONVI is reached",
         "title": "Lqstea"
      },
      "lsphe": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Flag for spherical coordinates (lon/lat)",
         "title": "Lsphe"
      },
      "lnautin": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Flag for nautical convention in input angles (degrees). Recommended to be True",
         "title": "Lnautin"
      },
      "lnautout": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Flag for nautical convention in output angles. If True, 0 is from north, 90 is from east. If False, mathematical convention is used (0: to east, 90: to north)",
         "title": "Lnautout"
      },
      "lmono_in": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag for prescribing monochromatic wave height Hmono as boundary conditions. Incident wave is defined as Hmono = sqrt(2) * Hs",
         "title": "Lmono In"
      },
      "lmono_out": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag for outputting wave heights in terms of Lmono",
         "title": "Lmono Out"
      },
      "begtc": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "20200101.000000",
         "description": "Start time of the simulation in format 'yyyymmdd.hhmmss'",
         "title": "Begtc"
      },
      "deltc": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 600,
         "description": "Time step in seconds (must match dt*nstep_wwm in SCHISM)",
         "title": "Deltc"
      },
      "unitc": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "SEC",
         "description": "Unit of time step (SEC for seconds)",
         "title": "Unitc"
      },
      "endtc": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "20200201.000000",
         "description": "End time of the simulation in format 'yyyymmdd.hhmmss'",
         "title": "Endtc"
      },
      "dmin": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.01,
         "description": "Minimum water depth. Must be the same as h0 in SCHISM",
         "title": "Dmin"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field begtc: str | None = '20200101.000000'#

Start time of the simulation in format ‘yyyymmdd.hhmmss’

Validated by:
field deltc: int | None = 600#

Time step in seconds (must match dt*nstep_wwm in SCHISM)

Validated by:
field dimmode: int | None = 2#

Mode of run: 2 for 2D (always 2D when coupled to SCHISM)

Validated by:
field dmin: float | None = 0.01#

Minimum water depth. Must be the same as h0 in SCHISM

Validated by:
field endtc: str | None = '20200201.000000'#

End time of the simulation in format ‘yyyymmdd.hhmmss’

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

Flag for prescribing monochromatic wave height Hmono as boundary conditions. Incident wave is defined as Hmono = sqrt(2) * Hs

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

Flag for outputting wave heights in terms of Lmono

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

Flag for nautical convention in input angles (degrees). Recommended to be True

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

Flag for nautical convention in output angles. If True, 0 is from north, 90 is from east. If False, mathematical convention is used (0: to east, 90: to north)

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

Quasi-Steady Mode flag. If True, WWM-II performs subiterations defined as DELTC/NQSITER unless QSCONVI is reached

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

Flag for spherical coordinates (lon/lat)

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

Steady mode flag (under development)

Validated by:
field procname: str | None = 'ACS'#

Project name for the simulation

Validated by:
field unitc: str | None = 'SEC'#

Unit of time step (SEC for seconds)

Validated by:
validator validate_begtc  »  begtc[source]#
validator validate_deltc  »  deltc[source]#
validator validate_dimmode  »  dimmode[source]#
validator validate_dmin  »  dmin[source]#
validator validate_endtc  »  endtc[source]#
validator validate_lmono_in  »  lmono_in[source]#
validator validate_lmono_out  »  lmono_out[source]#
validator validate_lnautin  »  lnautin[source]#
validator validate_lnautout  »  lnautout[source]#
validator validate_lqstea  »  lqstea[source]#
validator validate_lsphe  »  lsphe[source]#
validator validate_lstea  »  lstea[source]#
validator validate_procname  »  procname[source]#
validator validate_unitc  »  unitc[source]#