FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
marenv::wake::KernelProfile Class Reference

#include <Kernel.h>

Public Member Functions

 KernelProfile (const ElementarySource &source, const KernelParams &params)
 
double XStart () const
 x_start = max(xStartFactor D, xStartMin), m.
 
KernelCentreline At (double x) const
 Centreline amplitude and sigma at x >= x_start, m along flowDir.
 
double PeakAmplitude (double xFrom, double xTo) const
 

Detailed Description

The kernel of ElementaryDeficit() along one source's wake axis.

d(x, rho) = At(x).amplitude exp(-rho^2 / (2 At(x).sigma^2)) for x >= XStart(), else 0. ElementaryDeficit() and the gridded builder both evaluate the kernel through this profile, so the formulas exist once (MENV-0009).

Constructor & Destructor Documentation

◆ KernelProfile()

marenv::wake::KernelProfile::KernelProfile ( const ElementarySource &  source,
const KernelParams &  params 
)
Parameters
[in]sourceThe elementary source; it must have a positive area.
[in]paramsThe kernel parameters.

Member Function Documentation

◆ PeakAmplitude()

double marenv::wake::KernelProfile::PeakAmplitude ( double  xFrom,
double  xTo 
) const

Upper bound of At(x).amplitude for x in [xFrom, xTo], x_start <= xFrom <= xTo, m.

The amplitude does not fall with x before x_p and does not rise beyond it (k >= 0, which Validate() requires of the fields), so the bound is its value at the end of the interval nearest to x_p, or d_mom where the interval holds x_p.


The documentation for this class was generated from the following file: