marenv::wake::WakeSampleParts Struct Reference

#include <WakeSampleParts.h>

Collaboration diagram for marenv::wake::WakeSampleParts:

Public Member Functions
Status	At (double t, WakeSample &out) const

Public Attributes
bool	blending = false
	True: the field blends at or after the sample time and At(t) weighs blend at t.
Status	status = Status::ERROR_NOT_SET
	Not blending: the status of WakeField::Sample() at the sample time.
WakeSample	sample {}
	Not blending: WakeField::Sample() at the sample time.
WakeBlendSamples	blend {}
	Blending: the samples of the blend's snapshots at the sample time.
double	zeroDeficitVelocity [3] = {0.0, 0.0, 0.0}
	Blending: the source velocity the field reports where d = 0, m/s, NED.

Detailed Description

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

A caller that holds a sample over a time interval, such as fhsim_environment's per-step take of the wakes at a structure's points, keeps the parts and composes them at each evaluation time t with At(t). The positions and the snapshots stay those of the sample time; the blend weight is that of t, so the held composition is C1 in t through a blend, as the live one.

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::WakeSampleParts::At ( double  t, WakeSample &  out  ) const

inline

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

Parameters

[in]	t	Evaluation time, s; at or after the sample time.
[out]	out	Deficit and source velocity, as WakeField::Sample() at the sample time and point with the blend weight of t.

Returns

The status, as WakeField::Sample().

---

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

• webfhsim/reloadrepos/marenv/include/marenv/wake/WakeSampleParts.h