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

#include <JetField.h>

+ Collaboration diagram for marenv::wake::JetSampleParts:

Public Member Functions

Status At (double t, JetSample &out) const
 

Public Attributes

bool blending = false
 True: the field blends at or after the sample time and At(t) weighs the blend at t.
 
Status status = Status::ERROR_NOT_SET
 Not blending: the status of JetField::Sample() at the sample time.
 
JetSample sample {}
 Not blending: JetField::Sample() at the sample time.
 
JetBlendSamples blend {}
 Blending: the samples of the blend's snapshots at the sample time.
 

Detailed Description

A jet field's sample at one point and time, split into the parts its blend weighs (as WakeSampleParts, owner ruling R136; JetField::SampleParts()).

A field that does not blend at the sample time or later holds the finished sample (blending false): At(t) returns it, with its status, for every t, bit for bit Sample() at the sample time.

Member Function Documentation

◆ At()

Status marenv::wake::JetSampleParts::At ( double  t,
JetSample &  out 
) const
inline

The field's sample at t composed from the parts.

Parameters
[in]tEvaluation time, s; at or after the sample time.
[out]outΔu, as JetField::Sample() at the sample time and point with the blend weight of t.
Returns
The status, as JetField::Sample().

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