rompy.swan.components.boundary.INITIAL

pydantic model rompy.swan.components.boundary.INITIAL

Initial conditions.

INITIAL -> DEFAULT|ZERO|PAR|HOTSTART

This command can be used to specify the initial values for a stationary (INITIAL HOTSTART only) or nonstationary computation. The initial values thus specified override the default initialization (see Section 2.6.3). Note that it is possible to obtain an initial state by carrying out a previous stationary or nonstationary computation.

Examples

In [16]: from rompy.swan.components.boundary import INITIAL

In [17]: init = INITIAL()

In [18]: print(init.render())
INITIAL DEFAULT

In [19]: init = INITIAL(
   ....:     kind=dict(model_type="hotmultiple", fname="hotstart.swn", format="free")
   ....: )
   ....: 

In [20]: print(init.render())
INITIAL HOTSTART MULTIPLE fname='hotstart.swn' FREE

Fields:

• kind (rompy.swan.subcomponents.boundary.DEFAULT | rompy.swan.subcomponents.boundary.ZERO | rompy.swan.subcomponents.boundary.PAR | rompy.swan.subcomponents.boundary.HOTSINGLE | rompy.swan.subcomponents.boundary.HOTMULTIPLE)

• model_type (Literal['initial', 'INITIAL'])

field kind: DEFAULT | ZERO | PAR | HOTSINGLE | HOTMULTIPLE [Optional]

Initial condition type

field model_type: Literal['initial', 'INITIAL'] = 'initial'

Model type discriminator

cmd() → str

Return the string or list of strings to render the component to the CMD.