line::fluid::FluidClosure Struct Reference

The second moment the drift closes its non-linear terms with, i.e. More...

#include <line/solvers/fluid/fluid_odes.h>

Collaboration diagram for line::fluid::FluidClosure:

Public Member Functions
bool	gaussian () const
	any(sigma2 > 0), the reference's GLOBAL gaussian flag.
double	sigma2_of (std::size_t i) const
const Matrix< double > *	cov_of (std::size_t i) const

Public Attributes
std::vector< double >	sigma2
	per station; empty selects first order
std::vector< Matrix< double > >	cov
	per station, 0x0 keeps the plug-in share

Detailed Description

The second moment the drift closes its non-linear terms with, i.e.

options.config.moment_sigma2 and options.config.moment_cov.

EMPTY IS THE FIRST-ORDER CLOSURE, and not a missing input: every closure evaluates at the mean when it is given no variance, which is what the closing, matrix, statedep, softmin and tbi methods do. Only solver_fluid_moments fills this, and it fills it from the covariance it converged to rather than from the one its own solve produced – see there for why the two must be the same one.

sigma2[i] is the population variance of station i and closes its min(); the capacity SHARE is a ratio of coordinates, so closing it needs cov[i], the covariance block over station i's own coordinates, and not just their total.

Definition at line 123 of file fluid_odes.h.

Member Function Documentation

cov_of()

const Matrix< double > * line::fluid::FluidClosure::cov_of ( std::size_t i ) const

inline

Definition at line 133 of file fluid_odes.h.

References cov.

Referenced by line::fluid::fluid_drift_jacobian(), and line::fluid::fluid_rates_closing_factors().

gaussian()

bool line::fluid::FluidClosure::gaussian ( ) const

inline

any(sigma2 > 0), the reference's GLOBAL gaussian flag.

Definition at line 127 of file fluid_odes.h.

References sigma2.

Referenced by line::fluid::fluid_drift_jacobian(), line::fluid::fluid_rates_closing_factors(), and line::fluid::fluid_refine_meanfield().

sigma2_of()

double line::fluid::FluidClosure::sigma2_of ( std::size_t i ) const

inline

Definition at line 132 of file fluid_odes.h.

References sigma2.

Referenced by line::fluid::fluid_drift_jacobian(), and line::fluid::fluid_rates_closing_factors().

Member Data Documentation

cov

std::vector<Matrix<double> > line::fluid::FluidClosure::cov

per station, 0x0 keeps the plug-in share

Definition at line 125 of file fluid_odes.h.

Referenced by cov_of(), line::fluid::fluid_blend_closure(), line::fluid::fluid_dae_residual(), line::fluid::solver_fluid_dae(), line::fluid::solver_fluid_dae_transient(), and line::fluid::solver_fluid_moments().

sigma2

std::vector<double> line::fluid::FluidClosure::sigma2

per station; empty selects first order

Definition at line 124 of file fluid_odes.h.

Referenced by line::fluid::fluid_blend_closure(), line::fluid::fluid_dae_residual(), line::fluid::fluid_kink_stations(), line::fluid::fluid_passage_time(), gaussian(), sigma2_of(), line::fluid::solver_fluid_dae(), line::fluid::solver_fluid_dae_transient(), and line::fluid::solver_fluid_moments().

---

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

• include/line/solvers/fluid/fluid_odes.h