Ice Sheet System Model  4.18
Code documentation
Public Member Functions
Param Class Referenceabstract

#include <Param.h>

Inheritance diagram for Param:
Object BoolParam DataSetParam DoubleMatArrayParam DoubleMatParam DoubleParam DoubleVecParam FileParam GenericParam< P > IntMatParam IntParam IntVecParam MatrixParam StringArrayParam StringParam TransientArrayParam TransientParam VectorParam

Public Member Functions

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

Detailed Description

Definition at line 21 of file Param.h.

Constructor & Destructor Documentation

◆ ~Param()

virtual Param::~Param ( )
inlinevirtual

Definition at line 24 of file Param.h.

24 {};

Member Function Documentation

◆ DeepEcho()

virtual void Param::DeepEcho ( )
pure virtual

Implements Object.

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ copy()

virtual Param* Param::copy ( )
pure virtual

Implements Object.

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ Echo()

virtual void Param::Echo ( )
pure virtual

Implements Object.

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [1/16]

virtual void Param::GetParameterValue ( bool *  pbool)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [2/16]

virtual void Param::GetParameterValue ( int *  pinteger)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [3/16]

virtual void Param::GetParameterValue ( int **  pintarray,
int *  pM 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [4/16]

virtual void Param::GetParameterValue ( int **  pintarray,
int *  pM,
int *  pN 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [5/16]

virtual void Param::GetParameterValue ( IssmDouble *  pIssmDouble)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [6/16]

virtual void Param::GetParameterValue ( IssmDouble *  pdouble,
IssmDouble  time 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [7/16]

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

Reimplemented in TransientArrayParam.

Definition at line 36 of file Param.h.

36 {_error_("not implemented yet");};

◆ GetParameterValue() [8/16]

virtual void Param::GetParameterValue ( char **  pstring)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [9/16]

virtual void Param::GetParameterValue ( char ***  pstringarray,
int *  pM 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [10/16]

virtual void Param::GetParameterValue ( IssmDouble **  pIssmDoublearray,
int *  pM 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [11/16]

virtual void Param::GetParameterValue ( IssmDouble **  pIssmDoublearray,
int *  pM,
int *  pN 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [12/16]

virtual void Param::GetParameterValue ( IssmDouble ***  parray,
int *  pM,
int **  pmdims,
int **  pndims 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [13/16]

virtual void Param::GetParameterValue ( Vector< IssmDouble > **  pvec)
pure virtual

Implemented in TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, BoolParam, and VectorParam.

◆ GetParameterValue() [14/16]

virtual void Param::GetParameterValue ( Matrix< IssmDouble > **  pmat)
pure virtual

Implemented in MatrixParam, VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ GetParameterValue() [15/16]

virtual void Param::GetParameterValue ( FILE **  pfid)
pure virtual

Implemented in DataSetParam, VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, and BoolParam.

◆ GetParameterValue() [16/16]

virtual void Param::GetParameterValue ( DataSet **  pdataset)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ InstanceEnum()

virtual int Param::InstanceEnum ( )
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ Marshall()

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

Implements Object.

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ ObjectEnum()

virtual int Param::ObjectEnum ( )
pure virtual

Implements Object.

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetEnum()

virtual void Param::SetEnum ( int  enum_in)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [1/14]

virtual void Param::SetValue ( bool  boolean)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [2/14]

virtual void Param::SetValue ( int  integer)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [3/14]

virtual void Param::SetValue ( IssmDouble  scalar)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [4/14]

virtual void Param::SetValue ( char *  string)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [5/14]

virtual void Param::SetValue ( char **  stringarray,
int  M 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [6/14]

virtual void Param::SetValue ( DataSet *  dataset)
inlinevirtual

Reimplemented in DataSetParam.

Definition at line 56 of file Param.h.

56 {_error_("not implemented yet");};

◆ SetValue() [7/14]

virtual void Param::SetValue ( IssmDouble *  IssmDoublearray,
int  M 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [8/14]

virtual void Param::SetValue ( IssmDouble *  pIssmDoublearray,
int  M,
int  N 
)
pure virtual

Implemented in VectorParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DataSetParam, BoolParam, TransientParam, TransientArrayParam, IntMatParam, DoubleMatParam, and DoubleMatArrayParam.

◆ SetValue() [9/14]

virtual void Param::SetValue ( int *  intarray,
int  M 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [10/14]

virtual void Param::SetValue ( int *  pintarray,
int  M,
int  N 
)
pure virtual

Implemented in VectorParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, FileParam, DoubleVecParam, DoubleParam, DataSetParam, BoolParam, TransientParam, TransientArrayParam, IntParam, IntMatParam, GenericParam< P >, DoubleMatParam, and DoubleMatArrayParam.

◆ SetValue() [11/14]

virtual void Param::SetValue ( Vector< IssmDouble > *  vec)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [12/14]

virtual void Param::SetValue ( Matrix< IssmDouble > *  mat)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [13/14]

virtual void Param::SetValue ( FILE *  fid)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

◆ SetValue() [14/14]

virtual void Param::SetValue ( IssmDouble **  array,
int  M,
int *  mdim_array,
int *  ndim_array 
)
pure virtual

Implemented in VectorParam, TransientParam, TransientArrayParam, StringParam, StringArrayParam, MatrixParam, IntVecParam, IntParam, IntMatParam, GenericParam< P >, FileParam, DoubleVecParam, DoubleParam, DoubleMatParam, DoubleMatArrayParam, DataSetParam, and BoolParam.

The documentation for this class was generated from the following file:
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
Generated on Thu Jul 2 2020 08:09:29 for Ice Sheet System Model by   doxygen 1.8.19