Ice Sheet System Model  4.18
Code documentation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
ExponentialVariogram.cpp
Go to the documentation of this file.
1 
5 #ifdef HAVE_CONFIG_H
6  #include <config.h>
7 #else
8 #error "Cannot compile with HAVE_CONFIG_H symbol! run configure first!"
9 #endif
10 
11 #include "../classes.h"
12 #include "../../shared/shared.h"
13 
14 /*ExponentialVariogram constructors and destructor*/
16  this->nugget = 0.2;
17  this->sill = 1;
18  this->range = SQRT3;
19  return;
20 }
21 /*}}}*/
23 
24  /*Defaults*/
25  this->nugget = 0.2;
26  this->sill = 1;
27  this->range = SQRT3;
28 
29  /*Overwrite from options*/
30  if(options->GetOption("nugget")) options->Get(&this->nugget,"nugget");
31  if(options->GetOption("sill")) options->Get(&this->sill,"sill");
32  if(options->GetOption("range")) options->Get(&this->range,"range");
33 
34  /*Checks*/
35  if(nugget==sill) _error_("nugget and sill cannot be equal (constant semivariogram not allowed)");
36 }
37 /*}}}*/
39  return;
40 }
41 /*}}}*/
42 
43 /*Object virtual functions definitions:*/
45  return new ExponentialVariogram(*this);
46 }
47 /*}}}*/
48 void ExponentialVariogram::Echo(void){/*{{{*/
49  _printf_("ExponentialVariogram\n");
50  _printf_(" nugget: " << this->nugget << "\n");
51  _printf_(" sill : " << this->sill << "\n");
52  _printf_(" range : " << this->range << "\n");
53 }
54 /*}}}*/
55 
56 /*Variogram function*/
57 double ExponentialVariogram::Covariance(double deltax,double deltay){/*{{{*/
58  /*The covariance can be deduced from the variogram from the following
59  * relationship:
60  * 2 gamma = C(x,x) + C(y,y) -2 C(x,y)
61  * so
62  * C(h) = sill - gamma */
63  double h,a,cova;
64 
65  /*Calculate length*/
66  h=sqrt(deltax*deltax + deltay*deltay);
67 
68  /*If h is too small, return sill*/
69  if(h<0.0000001) return sill;
70 
71  /*compute covariance*/
72  a = 1./3.;
73  cova = (sill-nugget)*exp(-h/(a*range));
74  return cova;
75 }
76 /*}}}*/
77 double ExponentialVariogram::SemiVariogram(double deltax,double deltay){/*{{{*/
78  /*http://en.wikipedia.org/wiki/Variogram*/
79  double h,a,gamma;
80 
81  /*Calculate length*/
82  h=sqrt(deltax*deltax + deltay*deltay);
83 
84  /*return semi-variogram*/
85  a = 1./3.;
86  gamma = (sill-nugget)*(1-exp(-h/(a*range))) + nugget;
87  return gamma;
88 }
89 /*}}}*/
Options
Definition: Options.h:9
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
ExponentialVariogram::ExponentialVariogram
ExponentialVariogram()
Definition: ExponentialVariogram.cpp:15
ExponentialVariogram::copy
Object * copy()
Definition: ExponentialVariogram.cpp:44
Object
Definition: Object.h:13
ExponentialVariogram::Covariance
double Covariance(double deltax, double deltay)
Definition: ExponentialVariogram.cpp:57
Options::Get
void Get(OptionType *pvalue, const char *name)
Definition: Options.h:21
ExponentialVariogram::SemiVariogram
double SemiVariogram(double deltax, double deltay)
Definition: ExponentialVariogram.cpp:77
ExponentialVariogram::sill
double sill
Definition: ExponentialVariogram.h:15
Options::GetOption
Option * GetOption(const char *name)
Definition: Options.cpp:67
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
SQRT3
#define SQRT3
Definition: constants.h:10
ExponentialVariogram::~ExponentialVariogram
~ExponentialVariogram()
Definition: ExponentialVariogram.cpp:38
ExponentialVariogram::range
double range
Definition: ExponentialVariogram.h:16
ExponentialVariogram::Echo
void Echo()
Definition: ExponentialVariogram.cpp:48
ExponentialVariogram::nugget
double nugget
Definition: ExponentialVariogram.h:14