OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmm::fv::implicit_wet::Jet Struct Reference

#include <ImplicitWetKernels.hpp>

Collaboration diagram for openswmm::fv::implicit_wet::Jet:

Public Member Functions

 Jet ()=default
 Construct a zero primal value with all five directional derivatives zero.
 
 Jet (double value)
 Lift a scalar constant into five-direction forward arithmetic.
 

Static Public Member Functions

static Jet seed (double value, int column)
 Create one local independent variable for forward differentiation.
 

Public Attributes

double v = 0.0
 
std::array< double, 5 > d {}
 

Constructor & Destructor Documentation

◆ Jet() [1/2]

openswmm::fv::implicit_wet::Jet::Jet ( )
default

Construct a zero primal value with all five directional derivatives zero.

Here is the caller graph for this function:

◆ Jet() [2/2]

openswmm::fv::implicit_wet::Jet::Jet ( double value)
inline

Lift a scalar constant into five-direction forward arithmetic.

All derivative entries are zero. No allocation or retained references.

Parameters
[in]valuePrimal scalar, in the units of the represented variable; copied without validation.

Member Function Documentation

◆ seed()

static Jet openswmm::fv::implicit_wet::Jet::seed ( double value,
int column )
inlinestatic

Create one local independent variable for forward differentiation.

Parameters
[in]valuePrimal scalar value.
[in]columnDerivative seed index in [0,4], unchecked.
Returns
Jet with primal value, derivative one in column and zeros in every other direction.
Here is the call graph for this function:

Member Data Documentation

◆ d

std::array<double, 5> openswmm::fv::implicit_wet::Jet::d {}

◆ v

double openswmm::fv::implicit_wet::Jet::v = 0.0

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