FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
marenv::wake::JetBlendSum Struct Reference

#include <JetField.h>

Public Member Functions

void Add (double share, const JetSample &sample)
 Adds a snapshot's sample with its share of the blend.
 
void Add (double share, const JetBlendSum &part)
 Adds the sum of a state blended from with its share of the blend.
 
Status ToSample (JetSample &out) const
 

Public Attributes

bool inside = false
 True once a snapshot contributed.
 
double velocity [3] = {0.0, 0.0, 0.0}
 Sum of share Δu, m/s, NED.
 

Detailed Description

The sum over the snapshots of a jet blend that contributed at one point (WakeBlend::Evaluate() of a jet field).

The blend is linear in Δu: the sum is sum(share Δu).

Member Function Documentation

◆ ToSample()

Status marenv::wake::JetBlendSum::ToSample ( JetSample &  out) const
inline

The field's sample from the sum.

Parameters
[out]outΔu; zero when no snapshot contributed.
Returns
Status::OK, or Status::ERROR_NOT_SET when no snapshot contributed.

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