rompy.schism.namelists.wwminput.Hotfile

pydantic model rompy.schism.namelists.wwminput.Hotfile

Show JSON schema

{
   "title": "Hotfile",
   "type": "object",
   "properties": {
      "lhotf": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Write hotfile",
         "title": "Lhotf"
      },
      "filehot_out": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "wwm_hot_out.nc",
         "description": "name of output",
         "title": "Filehot Out"
      },
      "begtc": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "20200101.000000",
         "description": "Starting time of hotfile writing. With ihot!=0 in SCHISM,",
         "title": "Begtc"
      },
      "deltc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 2678400.0,
         "description": "time between hotfile writes",
         "title": "Deltc"
      },
      "unitc": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "SEC",
         "description": "unit used above",
         "title": "Unitc"
      },
      "endtc": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "20200201.000000",
         "description": "Ending time of hotfile writing (adjust with BEGTC)",
         "title": "Endtc"
      },
      "lcyclehot": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Applies only to netcdf",
         "title": "Lcyclehot"
      },
      "hotstyle_out": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "1: binary hotfile of data as output",
         "title": "Hotstyle Out"
      },
      "multipleout": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "0: hotfile in a single file (binary or netcdf)",
         "title": "Multipleout"
      },
      "filehot_in": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "wwm_hot_in.nc",
         "description": "(Full) hot file name for input (which can be copied from FILEHOT_OUT above)",
         "title": "Filehot In"
      },
      "hotstyle_in": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "1: binary hotfile of data as input",
         "title": "Hotstyle In"
      },
      "ihotpos_in": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Position in hotfile (only for netcdf)",
         "title": "Ihotpos In"
      },
      "multiplein": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "0: read hotfile from one single file",
         "title": "Multiplein"
      }
   },
   "additionalProperties": false
}

Fields:

• begtc (str | None)

• deltc (float | None)

• endtc (str | None)

• filehot_in (str | None)

• filehot_out (str | None)

• hotstyle_in (int | None)

• hotstyle_out (int | None)

• ihotpos_in (int | None)

• lcyclehot (bool | None)

• lhotf (bool | None)

• multiplein (int | None)

• multipleout (int | None)

• unitc (str | None)

Validators:

field begtc: str | None = '20200101.000000'

Starting time of hotfile writing. With ihot!=0 in SCHISM,

Validated by:

• __lowercase_property_keys__

field deltc: float | None = 2678400.0

time between hotfile writes

Validated by:

• __lowercase_property_keys__

field endtc: str | None = '20200201.000000'

Ending time of hotfile writing (adjust with BEGTC)

Validated by:

• __lowercase_property_keys__

field filehot_in: str | None = 'wwm_hot_in.nc'

(Full) hot file name for input (which can be copied from FILEHOT_OUT above)

Validated by:

• __lowercase_property_keys__

field filehot_out: str | None = 'wwm_hot_out.nc'

name of output

Validated by:

• __lowercase_property_keys__

field hotstyle_in: int | None = 2

1: binary hotfile of data as input

Validated by:

• __lowercase_property_keys__

field hotstyle_out: int | None = 2

1: binary hotfile of data as output

Validated by:

• __lowercase_property_keys__

field ihotpos_in: int | None = 2

Position in hotfile (only for netcdf)

Validated by:

• __lowercase_property_keys__

field lcyclehot: bool | None = False

Applies only to netcdf

Validated by:

• __lowercase_property_keys__

field lhotf: bool | None = True

Write hotfile

Validated by:

• __lowercase_property_keys__

field multiplein: int | None = 0

0: read hotfile from one single file

Validated by:

• __lowercase_property_keys__

field multipleout: int | None = 0

0: hotfile in a single file (binary or netcdf)

Validated by:

• __lowercase_property_keys__

field unitc: str | None = 'SEC'

unit used above

Validated by:

• __lowercase_property_keys__