diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:19:15 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:38:48 +0300 |
commit | ffc4c126f5416b04a01653e7a03451797b98aba4 (patch) | |
tree | ac63d70d33aae5ab1666c9c2f62058c9c1eebd5c /source/blender/blenkernel/intern/ocean_spectrum.c | |
parent | f159d49f56cedccd509ee93f5a5fb51f4f39eeb8 (diff) |
Cleanup: move public doc-strings into headers for 'blenkernel'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenkernel/intern/ocean_spectrum.c')
-rw-r--r-- | source/blender/blenkernel/intern/ocean_spectrum.c | 17 |
1 files changed, 0 insertions, 17 deletions
diff --git a/source/blender/blenkernel/intern/ocean_spectrum.c b/source/blender/blenkernel/intern/ocean_spectrum.c index c5504b22b43..43e0f399213 100644 --- a/source/blender/blenkernel/intern/ocean_spectrum.c +++ b/source/blender/blenkernel/intern/ocean_spectrum.c @@ -128,11 +128,6 @@ static float jonswap(const Ocean *oc, const float k2) return val; } -/** - * Pierson-Moskowitz model, 1964, assumes waves reach equilibrium with wind. - * Model is intended for large area 'fully developed' sea, where winds have been steadily blowing - * for days over an area that includes hundreds of wavelengths on a side. - */ float BLI_ocean_spectrum_piersonmoskowitz(const Ocean *oc, const float kx, const float kz) { const float k2 = kx * kx + kz * kz; @@ -159,10 +154,6 @@ float BLI_ocean_spectrum_piersonmoskowitz(const Ocean *oc, const float kx, const return val; } -/** - * TMA extends the JONSWAP spectrum. - * This spectral model is best suited to shallow water. - */ float BLI_ocean_spectrum_texelmarsenarsloe(const Ocean *oc, const float kx, const float kz) { const float k2 = kx * kx + kz * kz; @@ -195,14 +186,6 @@ float BLI_ocean_spectrum_texelmarsenarsloe(const Ocean *oc, const float kx, cons return val; } -/** - * Hasselmann et al, 1973. This model extends the Pierson-Moskowitz model with a peak sharpening - * function This enhancement is an artificial construct to address the problem that the wave - * spectrum is never fully developed. - * - * The fetch parameter represents the distance from a lee shore, - * called the fetch, or the distance over which the wind blows with constant velocity. - */ float BLI_ocean_spectrum_jonswap(const Ocean *oc, const float kx, const float kz) { const float k2 = kx * kx + kz * kz; |