rompy.swan.components.physics.BRAGG_FT#
- pydantic model rompy.swan.components.physics.BRAGG_FT[source]#
Bragg scattering with bottom spectrum computed from FFT.
BRAGG [ibrag] [nreg] [cutoff] FT
If this keyword is present the bottom spectrum will be computed in each active grid point using a Fast Fourier Transform (FFT).
Notes
The depth in each computational grid point is computed as the average of the inputted (high-resolution) bed levels within the square region.
Examples
In [18]: from rompy.swan.components.physics import BRAGG_FT In [19]: bragg = BRAGG_FT(nreg=350) In [20]: print(bragg.render()) BRAGG nreg=350 FT In [21]: bragg = BRAGG_FT(ibrag=2, nreg=350, cutoff=5.0) In [22]: print(bragg.render()) BRAGG ibrag=2 nreg=350 cutoff=5.0 FT
- Fields:
- field cutoff: float | None = None#
Cutoff to the ratio between surface and bottom wave numbers. Note: seethe Scientific/Technical documentation for details (SWAN default: 5.0)
- field ibrag: Literal[1, 2, 3] | None = None#
Indicates the computation of Bragg scattering term:
1: source term is calculated per sweep and bottom spectrum is interpolated at the difference wave number a priori (thus requiring storage)
2: source term is calculated per sweep and bottom spectrum is interpolated at the difference wave number per sweep (no storage)
3: source term is calculated per iteration and bottom spectrum is interpolated at the difference wave number per iteration (no storage)
(SWAN default: 1)
- field model_type: Literal['ft', 'FT'] = 'ft'#
Model type discriminator
- field nreg: int [Required]#
Size of square region around computational grid point (centered) for computing the mean depth and, if desired, the bed elevation spectrum. It is expressed in terms of the number of grid points (per direction) of the inputted bottom grid