WVFixedAmplitudeForcing
Create fixed-amplitude forcing for selected coefficients.
Declaration
self = WVFixedAmplitudeForcing(wvt,options)
Parameters
wvttransform that owns and evaluates the forcingnamerequired unique forcing-registry nameApbaroptional column of prescribedApvalues; default emptyAmbaroptional column of prescribedAmvalues; default emptyA0baroptional column of prescribedA0values; default emptyAp_indicesoptional column of correspondingAplinear indices; default emptyAm_indicesoptional column of correspondingAmlinear indices; default emptyA0_indicesoptional column of correspondingA0linear indices; default empty
Returns
selffixed-amplitude forcing owned bywvt
Discussion
Supply a unique registry name. Coefficients may be selected
directly with paired value/index column vectors, or later with
setWaveForcingCoefficients and
setGeostrophicForcingCoefficients.
See the WVFixedAmplitudeForcing overview for the tendency and restoration behavior, modeling cautions, and a usage example.