Ice Sheet System Model  4.18
Code documentation
Public Member Functions | Protected Attributes
TransientParam Class Reference

#include <TransientParam.h>

Inheritance diagram for TransientParam:
Param Object

Public Member Functions

 TransientParam ()
 
 TransientParam (int in_enum_type, IssmDouble *in_values, IssmDouble *in_time, bool interpolation_on, int in_N)
 
 ~TransientParam ()
 
Param * copy ()
 
void DeepEcho ()
 
void Echo ()
 
int Id ()
 
void Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
 
int ObjectEnum ()
 
void GetParameterValue (bool *pbool)
 
void GetParameterValue (int *pinteger)
 
void GetParameterValue (int **pintarray, int *pM)
 
void GetParameterValue (int **pintarray, int *pM, int *pN)
 
void GetParameterValue (IssmDouble *pIssmDouble)
 
void GetParameterValue (IssmDouble *pdouble, IssmDouble time)
 
void GetParameterValue (char **pstring)
 
void GetParameterValue (char ***pstringarray, int *pM)
 
void GetParameterValue (IssmDouble **pIssmDoublearray, int *pM)
 
void GetParameterValue (IssmDouble **pIssmDoublearray, int *pM, int *pN)
 
void GetParameterValue (IssmDouble ***parray, int *pM, int **pmdims, int **pndims)
 
void GetParameterValue (Vector< IssmDouble > **pvec)
 
void GetParameterValue (Matrix< IssmDouble > **pmat)
 
void GetParameterValue (FILE **pfid)
 
void GetParameterValue (DataSet **pdataset)
 
int InstanceEnum ()
 
void SetEnum (int enum_in)
 
void SetValue (bool boolean)
 
void SetValue (int integer)
 
void SetValue (IssmDouble scalar)
 
void SetValue (char *string)
 
void SetValue (char **stringarray, int M)
 
void SetValue (IssmDouble *IssmDoublearray, int M)
 
void SetValue (IssmDouble *IssmDoublearray, int M, int N)
 
void SetValue (int *intarray, int M)
 
void SetValue (int *intarray, int M, int N)
 
void SetValue (Vector< IssmDouble > *vec)
 
void SetValue (Matrix< IssmDouble > *mat)
 
void SetValue (FILE *fid)
 
void SetValue (IssmDouble **array, int M, int *mdim_array, int *ndim_array)
 
- Public Member Functions inherited from Param
virtual ~Param ()
 
virtual void GetParameterValue (IssmDouble *pdouble, int row, IssmDouble time)
 
virtual void SetValue (DataSet *dataset)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 

Protected Attributes

int enum_type
 
int N
 
bool interpolation
 
IssmDouble * values
 
IssmDouble * timesteps
 

Detailed Description

Definition at line 20 of file TransientParam.h.

Constructor & Destructor Documentation

◆ TransientParam() [1/2]

TransientParam::TransientParam ( )

Definition at line 18 of file TransientParam.cpp.

18  {/*{{{*/
19  return;
20 }

◆ TransientParam() [2/2]

TransientParam::TransientParam ( int  in_enum_type,
IssmDouble *  in_values,
IssmDouble *  in_time,
bool  interpolation_on,
int  in_N 
)

Definition at line 22 of file TransientParam.cpp.

22  {/*{{{*/
23 
24  _assert_(in_values && in_time);
25 
26  enum_type=in_enum_type;
27  N=in_N;
28  interpolation=interpolation_on;
29 
30  values=xNew<IssmDouble>(N);
31  xMemCpy<IssmDouble>(values,in_values,N);
32 
33  timesteps=xNew<IssmDouble>(N);
34  xMemCpy<IssmDouble>(timesteps,in_time,N);
35 }

◆ ~TransientParam()

TransientParam::~TransientParam ( )

Definition at line 37 of file TransientParam.cpp.

37  {/*{{{*/
38  xDelete<IssmDouble>(values);
39  xDelete<IssmDouble>(timesteps);
40 }

Member Function Documentation

◆ copy()

Param * TransientParam::copy ( void  )
virtual

Implements Param.

Definition at line 44 of file TransientParam.cpp.

44  {/*{{{*/
45 
46  return new TransientParam(this->enum_type,this->values,this->timesteps,this->interpolation,this->N);
47 
48 }

◆ DeepEcho()

void TransientParam::DeepEcho ( void  )
virtual

Implements Param.

Definition at line 50 of file TransientParam.cpp.

50  {/*{{{*/
51 
52  _printf_("TransientParam:\n");
53  _printf_(" enum: " << this->enum_type << " (" << EnumToStringx(this->enum_type) << ")\n");
54  _printf_(" size: " << this->N << "\n");
55  for(int i=0;i<this->N;i++){
56  _printf_( "time: " << this->timesteps[i] << " value: " << this->values[i] << "\n");
57  }
58 }

◆ Echo()

void TransientParam::Echo ( void  )
virtual

Implements Param.

Definition at line 60 of file TransientParam.cpp.

60  {/*{{{*/
61 
62  _printf_("TransientParam:\n");
63  _printf_(" enum: " << this->enum_type << " (" << EnumToStringx(this->enum_type) << ")\n");
64  _printf_(" size: " << this->N << "\n");
65 
66 }

◆ Id()

int TransientParam::Id ( void  )
virtual

Implements Object.

Definition at line 68 of file TransientParam.cpp.

68 { return -1; }/*{{{*/

◆ Marshall()

void TransientParam::Marshall ( char **  pmarshalled_data,
int *  pmarshalled_data_size,
int  marshall_direction 
)
virtual

Implements Param.

Definition at line 70 of file TransientParam.cpp.

70  { /*{{{*/
71 
72  MARSHALLING_ENUM(TransientParamEnum);
73 
74  MARSHALLING(enum_type);
75  MARSHALLING(interpolation);
76  MARSHALLING(N);
77  if(marshall_direction==MARSHALLING_BACKWARD){
78  values=xNew<IssmDouble>(N);
79  timesteps=xNew<IssmDouble>(N);
80  }
81  MARSHALLING_ARRAY(values,IssmDouble,N);
82  MARSHALLING_ARRAY(timesteps,IssmDouble,N);
83 
84 }

◆ ObjectEnum()

int TransientParam::ObjectEnum ( void  )
virtual

Implements Param.

Definition at line 86 of file TransientParam.cpp.

86  {/*{{{*/
87 
88  return TransientParamEnum;
89 
90 }

◆ GetParameterValue() [1/15]

void TransientParam::GetParameterValue ( bool *  pbool)
inlinevirtual

Implements Param.

Definition at line 44 of file TransientParam.h.

44 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a bool");}

◆ GetParameterValue() [2/15]

void TransientParam::GetParameterValue ( int *  pinteger)
inlinevirtual

Implements Param.

Definition at line 45 of file TransientParam.h.

45 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return an integer");}

◆ GetParameterValue() [3/15]

void TransientParam::GetParameterValue ( int **  pintarray,
int *  pM 
)
inlinevirtual

Implements Param.

Definition at line 46 of file TransientParam.h.

46 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return an array of integers");}

◆ GetParameterValue() [4/15]

void TransientParam::GetParameterValue ( int **  pintarray,
int *  pM,
int *  pN 
)
inlinevirtual

Implements Param.

Definition at line 47 of file TransientParam.h.

47 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a array of integers");}

◆ GetParameterValue() [5/15]

void TransientParam::GetParameterValue ( IssmDouble *  pIssmDouble)
inlinevirtual

Implements Param.

Definition at line 48 of file TransientParam.h.

48 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a IssmDouble");}

◆ GetParameterValue() [6/15]

void TransientParam::GetParameterValue ( IssmDouble *  pdouble,
IssmDouble  time 
)
virtual

Implements Param.

Definition at line 94 of file TransientParam.cpp.

94  {/*{{{*/
95 
96  IssmDouble output;
97  bool found;
98 
99  /*Ok, we have the time, go through the timesteps, and figure out which interval we
100  *fall within. Then interpolate the values on this interval: */
101  if(time<this->timesteps[0]){
102  /*get values for the first time: */
103  output=this->values[0];
104  found=true;
105  }
106  else if(time>this->timesteps[this->N-1]){
107  /*get values for the last time: */
108  output=this->values[this->N-1];
109  found=true;
110  }
111  else{
112  /*Find which interval we fall within: */
113  for(int i=0;i<this->N;i++){
114  if(time==this->timesteps[i]){
115  /*We are right on one step time: */
116  output=this->values[i];
117  found=true;
118  break; //we are done with the time interpolation.
119  }
120  else{
121  if(this->timesteps[i]<time && time<this->timesteps[i+1]){
122  /*ok, we have the interval ]i:i+1[. Interpolate linearly for now: */
123  IssmDouble deltat=this->timesteps[i+1]-this->timesteps[i];
124  IssmDouble alpha=(time-this->timesteps[i])/deltat;
125  if(interpolation==true) output=(1.0-alpha)*this->values[i] + alpha*this->values[i+1];
126  else output=this->values[i];
127  found=true;
128  break;
129  }
130  else continue; //keep looking on the next interval
131  }
132  }
133  }
134  if(!found)_error_("did not find time interval on which to interpolate values");
135  *pdouble=output;
136 }

◆ GetParameterValue() [7/15]

void TransientParam::GetParameterValue ( char **  pstring)
inlinevirtual

Implements Param.

Definition at line 50 of file TransientParam.h.

50 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a string");}

◆ GetParameterValue() [8/15]

void TransientParam::GetParameterValue ( char ***  pstringarray,
int *  pM 
)
inlinevirtual

Implements Param.

Definition at line 51 of file TransientParam.h.

51 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a string array");}

◆ GetParameterValue() [9/15]

void TransientParam::GetParameterValue ( IssmDouble **  pIssmDoublearray,
int *  pM 
)
inlinevirtual

Implements Param.

Definition at line 52 of file TransientParam.h.

52 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a IssmDouble array");}

◆ GetParameterValue() [10/15]

void TransientParam::GetParameterValue ( IssmDouble **  pIssmDoublearray,
int *  pM,
int *  pN 
)
inlinevirtual

Implements Param.

Definition at line 53 of file TransientParam.h.

53 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a IssmDouble array");}

◆ GetParameterValue() [11/15]

void TransientParam::GetParameterValue ( IssmDouble ***  parray,
int *  pM,
int **  pmdims,
int **  pndims 
)
inlinevirtual

Implements Param.

Definition at line 54 of file TransientParam.h.

54 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a matrix array");}

◆ GetParameterValue() [12/15]

void TransientParam::GetParameterValue ( Vector< IssmDouble > **  pvec)
inlinevirtual

Implements Param.

Definition at line 55 of file TransientParam.h.

55 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a Vec");}

◆ GetParameterValue() [13/15]

void TransientParam::GetParameterValue ( Matrix< IssmDouble > **  pmat)
inlinevirtual

Implements Param.

Definition at line 56 of file TransientParam.h.

56 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a Mat");}

◆ GetParameterValue() [14/15]

void TransientParam::GetParameterValue ( FILE **  pfid)
inlinevirtual

Implements Param.

Definition at line 57 of file TransientParam.h.

57 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot return a FILE");}

◆ GetParameterValue() [15/15]

void TransientParam::GetParameterValue ( DataSet **  pdataset)
inlinevirtual

Implements Param.

Definition at line 58 of file TransientParam.h.

58 {_error_("Param "<< EnumToStringx(enum_type) << " cannot return a DataSet");}

◆ InstanceEnum()

int TransientParam::InstanceEnum ( )
inlinevirtual

Implements Param.

Definition at line 59 of file TransientParam.h.

59 {return enum_type;}

◆ SetEnum()

void TransientParam::SetEnum ( int  enum_in)
inlinevirtual

Implements Param.

Definition at line 61 of file TransientParam.h.

61 {this->enum_type = enum_in;};

◆ SetValue() [1/13]

void TransientParam::SetValue ( bool  boolean)
inlinevirtual

Implements Param.

Definition at line 62 of file TransientParam.h.

62 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a boolean");}

◆ SetValue() [2/13]

void TransientParam::SetValue ( int  integer)
inlinevirtual

Implements Param.

Definition at line 63 of file TransientParam.h.

63 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold an integer");}

◆ SetValue() [3/13]

void TransientParam::SetValue ( IssmDouble  scalar)
inlinevirtual

Implements Param.

Definition at line 64 of file TransientParam.h.

64 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a scalar");}

◆ SetValue() [4/13]

void TransientParam::SetValue ( char *  string)
inlinevirtual

Implements Param.

Definition at line 65 of file TransientParam.h.

65 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a string");}

◆ SetValue() [5/13]

void TransientParam::SetValue ( char **  stringarray,
int  M 
)
inlinevirtual

Implements Param.

Definition at line 66 of file TransientParam.h.

66 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a string array");}

◆ SetValue() [6/13]

void TransientParam::SetValue ( IssmDouble *  IssmDoublearray,
int  M 
)
inlinevirtual

Implements Param.

Definition at line 67 of file TransientParam.h.

67 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a IssmDouble vec array");}

◆ SetValue() [7/13]

void TransientParam::SetValue ( IssmDouble *  IssmDoublearray,
int  M,
int  N 
)
inlinevirtual

Implements Param.

Definition at line 68 of file TransientParam.h.

68 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a IssmDouble array");}

◆ SetValue() [8/13]

void TransientParam::SetValue ( int *  intarray,
int  M 
)
inlinevirtual

Implements Param.

Definition at line 69 of file TransientParam.h.

69 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a int vec array");}

◆ SetValue() [9/13]

void TransientParam::SetValue ( int *  intarray,
int  M,
int  N 
)
inlinevirtual

Implements Param.

Definition at line 70 of file TransientParam.h.

70 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a int mat array");};

◆ SetValue() [10/13]

void TransientParam::SetValue ( Vector< IssmDouble > *  vec)
inlinevirtual

Implements Param.

Definition at line 71 of file TransientParam.h.

71 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a Vec");}

◆ SetValue() [11/13]

void TransientParam::SetValue ( Matrix< IssmDouble > *  mat)
inlinevirtual

Implements Param.

Definition at line 72 of file TransientParam.h.

72 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a Mat");}

◆ SetValue() [12/13]

void TransientParam::SetValue ( FILE *  fid)
inlinevirtual

Implements Param.

Definition at line 73 of file TransientParam.h.

73 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold a FILE");}

◆ SetValue() [13/13]

void TransientParam::SetValue ( IssmDouble **  array,
int  M,
int *  mdim_array,
int *  ndim_array 
)
inlinevirtual

Implements Param.

Definition at line 74 of file TransientParam.h.

74 {_error_("Parameter " <<EnumToStringx(enum_type) << " cannot hold an array of matrices");}

Field Documentation

◆ enum_type

int TransientParam::enum_type
protected

Definition at line 23 of file TransientParam.h.

◆ N

int TransientParam::N
protected

Definition at line 24 of file TransientParam.h.

◆ interpolation

bool TransientParam::interpolation
protected

Definition at line 25 of file TransientParam.h.

◆ values

IssmDouble* TransientParam::values
protected

Definition at line 26 of file TransientParam.h.

◆ timesteps

IssmDouble* TransientParam::timesteps
protected

Definition at line 27 of file TransientParam.h.

The documentation for this class was generated from the following files:
TransientParam::enum_type
int enum_type
Definition: TransientParam.h:23
_assert_
#define _assert_(ignore)
Definition: exceptions.h:37
IssmDouble
double IssmDouble
Definition: types.h:37
TransientParam::interpolation
bool interpolation
Definition: TransientParam.h:25
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
TransientParam::TransientParam
TransientParam()
Definition: TransientParam.cpp:18
MARSHALLING_ENUM
#define MARSHALLING_ENUM(EN)
Definition: Marshalling.h:14
TransientParamEnum
@ TransientParamEnum
Definition: EnumDefinitions.h:1316
TransientParam::values
IssmDouble * values
Definition: TransientParam.h:26
MARSHALLING_ARRAY
#define MARSHALLING_ARRAY(FIELD, TYPE, SIZE)
Definition: Marshalling.h:45
EnumToStringx
const char * EnumToStringx(int enum_in)
Definition: EnumToStringx.cpp:15
alpha
IssmDouble alpha(IssmDouble x, IssmDouble y, IssmDouble z, int testid)
Definition: fsanalyticals.cpp:221
MARSHALLING
#define MARSHALLING(FIELD)
Definition: Marshalling.h:29
MARSHALLING_BACKWARD
@ MARSHALLING_BACKWARD
Definition: Marshalling.h:10
TransientParam::N
int N
Definition: TransientParam.h:24
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
TransientParam::timesteps
IssmDouble * timesteps
Definition: TransientParam.h:27
Generated on Thu Jul 2 2020 08:09:31 for Ice Sheet System Model by   doxygen 1.8.19