Gridpp 0.6.0
A post-processing library for gridded weather forecasts
Public Member Functions | List of all members
gridpp::BarnesStructure Class Reference

#include <gridpp.h>

Inheritance diagram for gridpp::BarnesStructure:
gridpp::StructureFunction

Public Member Functions

 BarnesStructure (float h, float v=0, float w=0, float hmax=MV)
 Exponential structure function. More...
 
 BarnesStructure (Grid grid, vec2 h, vec2 v, vec2 w, float min_rho=StructureFunction::default_min_rho)
 Barnes structure function where decorrelation varyies spatially. More...
 
StructureFunctionclone () const
 
float corr (const Point &p1, const Point &p2) const
 Correlation between two points. More...
 
float localization_distance (const Point &p) const
 Maximum distance for which an observation can have an impact (localization) More...
 
- Public Member Functions inherited from gridpp::StructureFunction
virtual float corr_background (const Point &p1, const Point &p2) const
 
 StructureFunction (float localization_distance=0)
 

Additional Inherited Members

- Static Public Attributes inherited from gridpp::StructureFunction
static const float default_min_rho = 0.0013
 
- Protected Member Functions inherited from gridpp::StructureFunction
float barnes_rho (float dist, float length) const
 Barnes correlation function. More...
 
float cressman_rho (float dist, float length) const
 Cressman correlation function. More...
 
- Protected Attributes inherited from gridpp::StructureFunction
float m_localization_distance
 

Detailed Description

Simple structure function based on distance, elevation, and land area fraction.

Constructor & Destructor Documentation

◆ BarnesStructure() [1/2]

gridpp::BarnesStructure::BarnesStructure ( float  h,
float  v = 0,
float  w = 0,
float  hmax = MV 
)

Exponential structure function.

Barnes.

Parameters
hHorizontal decorrelation length >=0 [m]
vVertical decorrelation length >=0 [m]. If 0, disable decorrelation.
wLand/sea decorrelation length >=0 [1]. If 0, disable decorrelation.
hmaxTruncate horizontal correlation beyond this length [m]. If undefined, 3.64 * h.

◆ BarnesStructure() [2/2]

gridpp::BarnesStructure::BarnesStructure ( Grid  grid,
vec2  h,
vec2  v,
vec2  w,
float  min_rho = StructureFunction::default_min_rho 
)

Barnes structure function where decorrelation varyies spatially.

Parameters
gridGrid of decorrelation field
hHorizontal decorrelation length field >=0, same size as grid [m]
vVertical decorrelation length field >=0 [m]. Set all to 0 to disable decorrelation.
wLand/sea decorrelation length field >=0 [1]. Set all to 0 to disable decorrelation.
min_rhoTruncate horizontal correlation when rho less than this value [m].

Member Function Documentation

◆ clone()

gridpp::StructureFunction * gridpp::BarnesStructure::clone ( ) const
virtual

◆ corr()

float gridpp::BarnesStructure::corr ( const Point p1,
const Point p2 
) const
virtual

Correlation between two points.

Implements gridpp::StructureFunction.

◆ localization_distance()

float gridpp::BarnesStructure::localization_distance ( const Point p) const
virtual

Maximum distance for which an observation can have an impact (localization)

Returns
Distance [m]

Reimplemented from gridpp::StructureFunction.


The documentation for this class was generated from the following files: