rompy.swan.subcomponents.boundary.HOTSINGLE#

pydantic model rompy.swan.subcomponents.boundary.HOTSINGLE[source]#

Hotstart single initial conditions.

HOTSTART SINGLE fname='fname' FREE|UNFORMATTED

Initial wave field is read from file; this file was generated in a previous SWAN run by means of the HOTFILE command. If the previous run was nonstationary, the time found on the file will be assumed to be the initial time of computation. It can also be used for stationary computation as first guess. The computational grid (both in geographical space and in spectral space) must be identical to the one in the run in which the initial wave field was computed

Input will be read from a single (concatenated) hotfile. In the case of a previous parallel MPI run, the concatenated hotfile can be created from a set of multiple hotfiles using the program hcat.exe, see Implementation Manual.

Examples

In [253]: from rompy.swan.subcomponents.boundary import HOTSINGLE

In [254]: init = HOTSINGLE(fname="hotstart.swn", format="free")

In [255]: print(init.render())
HOTSTART SINGLE fname='hotstart.swn' FREE

Show JSON schema
{
   "title": "HOTSINGLE",
   "description": "Hotstart single initial conditions.\n\n.. code-block:: text\n\n    HOTSTART SINGLE fname='fname' FREE|UNFORMATTED\n\nInitial wave field is read from file; this file was generated in a previous SWAN\nrun by means of the HOTFILE command. If the previous run was nonstationary,\nthe time found on the file will be assumed to be the initial time of computation. It\ncan also be used for stationary computation as first guess. The computational grid\n(both in geographical space and in spectral space) must be identical to the one in\nthe run in which the initial wave field was computed\n\nInput will be read from a single (concatenated) hotfile. In the case of a previous\nparallel MPI run, the concatenated hotfile can be created from a set of multiple\nhotfiles using the program hcat.exe, see Implementation Manual.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.boundary import HOTSINGLE\n    init = HOTSINGLE(fname=\"hotstart.swn\", format=\"free\")\n    print(init.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "hotsingle",
         "description": "Model type discriminator",
         "enum": [
            "hotsingle",
            "HOTSINGLE"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "fname": {
         "description": "Name of the file containing the initial wave field",
         "maxLength": 36,
         "title": "Fname",
         "type": "string"
      },
      "format": {
         "default": "free",
         "description": "Format of the file containing the initial wave field. FREE: free format, UNFORMATTED: binary format",
         "enum": [
            "free",
            "unformatted"
         ],
         "title": "Format",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "fname"
   ]
}

Fields:
field fname: str [Required]#

Name of the file containing the initial wave field

Constraints:

  • max_length = 36

field format: Literal['free', 'unformatted'] = 'free'#

Format of the file containing the initial wave field. FREE: free format, UNFORMATTED: binary format

field model_type: Literal['hotsingle', 'HOTSINGLE'] = 'hotsingle'#

Model type discriminator

cmd() → str[source]#

Render subcomponent cmd.