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

#include <Superposition.h>

Public Member Functions

void Add (double deficit)
 
double Deficit () const
 

Detailed Description

Running composition of deficits by the momentum-flux rule (R95): D = max(C(S), min(1, L)).

Example usage:

sum.Add(0.2);
sum.Add(0.1);
const double deficit = sum.Deficit(); // D (1 - D) = 0.2 * 0.8 + 0.1 * 0.9
Definition Superposition.h:83
void Add(double deficit)

Member Function Documentation

◆ Add()

void marenv::wake::MomentumFluxSum::Add ( double  deficit)

Adds one deficit.

Parameters
[in]deficitDeficit d_i; clamped to [0, 1]; 0 and NaN add nothing.

◆ Deficit()

double marenv::wake::MomentumFluxSum::Deficit ( ) const
Returns
The composed deficit D in [0, 1]; 0 when nothing was added, the deficit itself (bit for bit) when one was.

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