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

#include <TransientArrayParam.h>

Inheritance diagram for TransientArrayParam:
Param Object

Public Member Functions

 TransientArrayParam ()
 
 TransientArrayParam (int in_enum_type, IssmDouble *in_values, IssmDouble *in_time, bool interpolation_on, int in_N, int in_M)
 
 ~TransientArrayParam ()
 
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, int row, IssmDouble time)
 
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 SetValue (DataSet *dataset)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 

Protected Attributes

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

Detailed Description

Definition at line 20 of file TransientArrayParam.h.

Constructor & Destructor Documentation

◆ TransientArrayParam() [1/2]

TransientArrayParam::TransientArrayParam ( )

Definition at line 18 of file TransientArrayParam.cpp.

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

◆ TransientArrayParam() [2/2]

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

Definition at line 22 of file TransientArrayParam.cpp.

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

◆ ~TransientArrayParam()

TransientArrayParam::~TransientArrayParam ( )

Definition at line 38 of file TransientArrayParam.cpp.

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

Member Function Documentation

◆ copy()

Param * TransientArrayParam::copy ( void  )
virtual

Implements Param.

Definition at line 44 of file TransientArrayParam.cpp.

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

◆ DeepEcho()

void TransientArrayParam::DeepEcho ( void  )
virtual

Implements Param.

Definition at line 50 of file TransientArrayParam.cpp.

50  {/*{{{*/
51 
52  _printf_("TransientArrayParam:\n");
53  _printf_(" enum: " << this->enum_type << " (" << EnumToStringx(this->enum_type) << ")\n");
54  _printf_(" number of time steps: " << this->N << "\n");
55  _printf_(" number of rows: " << this->M << "\n");
56  for(int i=0;i<this->N;i++){
57  _printf_(" time: " << this->timesteps[i] << "\n");
58  for(int k=0;k<this->M;k++){
59  _printf_(" values: " << this->values[k*N+i] << "\n");
60  }
61  _printf_("\n");
62  }
63 }

◆ Echo()

void TransientArrayParam::Echo ( void  )
virtual

Implements Param.

Definition at line 65 of file TransientArrayParam.cpp.

65  {/*{{{*/
66 
67  _printf_("TransientArrayParam:\n");
68  _printf_(" enum: " << this->enum_type << " (" << EnumToStringx(this->enum_type) << ")\n");
69  _printf_(" size: " << this->M << " by " << this->N << "\n");
70 
71 }

◆ Id()

int TransientArrayParam::Id ( void  )
virtual

Implements Object.

Definition at line 73 of file TransientArrayParam.cpp.

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

◆ Marshall()

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

Implements Param.

Definition at line 75 of file TransientArrayParam.cpp.

75  { /*{{{*/
76 
77  MARSHALLING_ENUM(TransientArrayParamEnum);
78 
79  MARSHALLING(enum_type);
80  MARSHALLING(interpolation);
81  MARSHALLING(M);
82  MARSHALLING(N);
83  if(marshall_direction==MARSHALLING_BACKWARD){
84  values = xNew<IssmDouble>(M*N);
85  timesteps = xNew<IssmDouble>(N);
86  }
87  MARSHALLING_ARRAY(values,IssmDouble,M*N);
88  MARSHALLING_ARRAY(timesteps,IssmDouble,N);
89 
90 }/*}}}*/

◆ ObjectEnum()

int TransientArrayParam::ObjectEnum ( void  )
virtual

Implements Param.

Definition at line 91 of file TransientArrayParam.cpp.

91  {/*{{{*/
92 
93  return TransientArrayParamEnum;
94 
95 }/*}}}*/

◆ GetParameterValue() [1/16]

void TransientArrayParam::GetParameterValue ( bool *  pbool)
inlinevirtual

Implements Param.

Definition at line 45 of file TransientArrayParam.h.

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

◆ GetParameterValue() [2/16]

void TransientArrayParam::GetParameterValue ( int *  pinteger)
inlinevirtual

Implements Param.

Definition at line 46 of file TransientArrayParam.h.

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

◆ GetParameterValue() [3/16]

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

Implements Param.

Definition at line 47 of file TransientArrayParam.h.

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

◆ GetParameterValue() [4/16]

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

Implements Param.

Definition at line 48 of file TransientArrayParam.h.

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

◆ GetParameterValue() [5/16]

void TransientArrayParam::GetParameterValue ( IssmDouble *  pIssmDouble)
inlinevirtual

Implements Param.

Definition at line 49 of file TransientArrayParam.h.

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

◆ GetParameterValue() [6/16]

void TransientArrayParam::GetParameterValue ( IssmDouble *  pdouble,
int  row,
IssmDouble  time 
)
virtual

Reimplemented from Param.

Definition at line 98 of file TransientArrayParam.cpp.

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

◆ GetParameterValue() [7/16]

void TransientArrayParam::GetParameterValue ( IssmDouble *  pdouble,
IssmDouble  time 
)
inlinevirtual

Implements Param.

Definition at line 51 of file TransientArrayParam.h.

51 {_error_("Parameter " <<EnumToStringx(enum_type) << " needs row to be specified");}

◆ GetParameterValue() [8/16]

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

Implements Param.

Definition at line 52 of file TransientArrayParam.h.

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

◆ GetParameterValue() [9/16]

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

Implements Param.

Definition at line 53 of file TransientArrayParam.h.

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

◆ GetParameterValue() [10/16]

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

Implements Param.

Definition at line 54 of file TransientArrayParam.h.

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

◆ GetParameterValue() [11/16]

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

Implements Param.

Definition at line 55 of file TransientArrayParam.h.

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

◆ GetParameterValue() [12/16]

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

Implements Param.

Definition at line 56 of file TransientArrayParam.h.

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

◆ GetParameterValue() [13/16]

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

Implements Param.

Definition at line 57 of file TransientArrayParam.h.

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

◆ GetParameterValue() [14/16]

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

Implements Param.

Definition at line 58 of file TransientArrayParam.h.

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

◆ GetParameterValue() [15/16]

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

Implements Param.

Definition at line 59 of file TransientArrayParam.h.

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

◆ GetParameterValue() [16/16]

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

Implements Param.

Definition at line 60 of file TransientArrayParam.h.

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

◆ InstanceEnum()

int TransientArrayParam::InstanceEnum ( )
inlinevirtual

Implements Param.

Definition at line 61 of file TransientArrayParam.h.

61 {return enum_type;}

◆ SetEnum()

void TransientArrayParam::SetEnum ( int  enum_in)
inlinevirtual

Implements Param.

Definition at line 63 of file TransientArrayParam.h.

63 {this->enum_type = enum_in;};

◆ SetValue() [1/13]

void TransientArrayParam::SetValue ( bool  boolean)
inlinevirtual

Implements Param.

Definition at line 64 of file TransientArrayParam.h.

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

◆ SetValue() [2/13]

void TransientArrayParam::SetValue ( int  integer)
inlinevirtual

Implements Param.

Definition at line 65 of file TransientArrayParam.h.

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

◆ SetValue() [3/13]

void TransientArrayParam::SetValue ( IssmDouble  scalar)
inlinevirtual

Implements Param.

Definition at line 66 of file TransientArrayParam.h.

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

◆ SetValue() [4/13]

void TransientArrayParam::SetValue ( char *  string)
inlinevirtual

Implements Param.

Definition at line 67 of file TransientArrayParam.h.

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

◆ SetValue() [5/13]

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

Implements Param.

Definition at line 68 of file TransientArrayParam.h.

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

◆ SetValue() [6/13]

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

Implements Param.

Definition at line 69 of file TransientArrayParam.h.

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

◆ SetValue() [7/13]

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

Implements Param.

Definition at line 70 of file TransientArrayParam.h.

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

◆ SetValue() [8/13]

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

Implements Param.

Definition at line 71 of file TransientArrayParam.h.

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

◆ SetValue() [9/13]

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

Implements Param.

Definition at line 72 of file TransientArrayParam.h.

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

◆ SetValue() [10/13]

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

Implements Param.

Definition at line 73 of file TransientArrayParam.h.

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

◆ SetValue() [11/13]

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

Implements Param.

Definition at line 74 of file TransientArrayParam.h.

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

◆ SetValue() [12/13]

void TransientArrayParam::SetValue ( FILE *  fid)
inlinevirtual

Implements Param.

Definition at line 75 of file TransientArrayParam.h.

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

◆ SetValue() [13/13]

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

Implements Param.

Definition at line 76 of file TransientArrayParam.h.

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

Field Documentation

◆ enum_type

int TransientArrayParam::enum_type
protected

Definition at line 23 of file TransientArrayParam.h.

◆ N

int TransientArrayParam::N
protected

Definition at line 24 of file TransientArrayParam.h.

◆ M

int TransientArrayParam::M
protected

Definition at line 25 of file TransientArrayParam.h.

◆ interpolation

bool TransientArrayParam::interpolation
protected

Definition at line 26 of file TransientArrayParam.h.

◆ values

IssmDouble* TransientArrayParam::values
protected

Definition at line 27 of file TransientArrayParam.h.

◆ timesteps

IssmDouble* TransientArrayParam::timesteps
protected

Definition at line 28 of file TransientArrayParam.h.

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