rompy.swan.subcomponents.physics.ST6#

pydantic model rompy.swan.subcomponents.physics.ST6[source]#

St6 source terms subcomponent.

ST6 [a1sds] [a2sds] [p1sds] [p2sds] UP|DOWN HWANG|FAN|ECMWF VECTAU|SCATAU &
    TRUE10|U10PROXY [windscaling] DEBIAS [cdfac] (AGROW [a])

wind input and whitecapping from Rogers et al. (2012) (RBW12).

Notes

The two arguments are specified in the Appendix C of the User manual but not in the command description for WESTH in Section 4.5.4. They are also options in the WCAPPING command. It is not entirely clear if they should/could be specified here.

References

Fan, Y., Lin, S.J., Held, I.M., Yu, Z. and Tolman, H.L., 2012. Global ocean surface wave simulation using a coupled atmosphere–wave model. Journal of Climate, 25(18), pp.6233-6252.

Rogers, W.E., Babanin, A.V. and Wang, D.W., 2012. Observation-consistent input and whitecapping dissipation in a model for wind-generated surface waves: Description and simple calculations. Journal of Atmospheric and Oceanic Technology, 29(9), pp.1329-1346.

Examples

In [53]: from rompy.swan.subcomponents.physics import ST6

In [54]: st6 = ST6(a1sds=4.7e-7, a2sds=6.6e-6)

In [55]: print(st6.render())
ST6 a1sds=4.7e-07 a2sds=6.6e-06 UP HWANG VECTAU U10PROXY windscaling=32.0

In [56]: kwargs = dict(
   ....:     a1sds=2.8e-6,
   ....:     a2sds=3.5e-5,
   ....:     normalization="up",
   ....:     wind_drag="hwang",
   ....:     tau="vectau",
   ....:     u10="u10proxy",
   ....:     windscaling=32.0,
   ....:     cdfac=0.89,
   ....:     agrow=True,
   ....:     a=0.0015,
   ....: )
   ....: 

In [57]: st6 = ST6(**kwargs)

In [58]: print(st6.render())
ST6 a1sds=2.8e-06 a2sds=3.5e-05 UP HWANG VECTAU U10PROXY windscaling=32.0 DEBIAS cdfac=0.89 AGROW a=0.0015

Fields:

a (Optional[float])
a1sds (float)
a2sds (float)
agrow (bool)
cdfac (float | None)
model_type (Literal['st6'])
normalization (Literal['up', 'down'])
p1sds (float | None)
p2sds (float | None)
tau (Literal['vectau', 'scatau'])
u10 (Literal['u10proxy', 'true10'])
wind_drag (Literal['hwang', 'fan', 'ecmwf'])
windscaling (float | None)

Validators:

debias_only_with_hwang » all fields

field a: float | None = None#

Proportionality coefficient when activating the Cavaleri and Malanotte (1981) wave growth term (SWAN default: 0.0015)

Validated by:

debias_only_with_hwang

field a1sds: float [Required]#

Coefficient related to local dissipation term T1 (a1 in RBW12)

Validated by:

debias_only_with_hwang

field a2sds: float [Required]#

Coefficient related to local dissipation term T2 (a2 in RBW12)

Validated by:

debias_only_with_hwang

field agrow: bool = False#

Activate the Cavaleri and Malanotte (1981) wave growth term

Validated by:

debias_only_with_hwang

field cdfac: float | None = None#

Counter bias in the input wind fields by providing a multiplier on the drag coefficient

Constraints:

gt = 0.0

Validated by:

debias_only_with_hwang

field model_type: Literal['st6'] = 'st6'#

Model type discriminator

Validated by:

debias_only_with_hwang

field normalization: Literal['up', 'down'] = 'up'#

Selection of normalization of exceedance level by ET(f) (up) or E(f) (down) as in RBW12 (right column, page 1333), up is default and strongly recommended

Validated by: