Ice Sheet System Model  4.18
Code documentation
Public Member Functions | Data Fields
Nodalvalue Class Reference

#include <Nodalvalue.h>

Inheritance diagram for Nodalvalue:
Object Definition

Public Member Functions

 Nodalvalue ()
 
 Nodalvalue (char *in_name, int in_definitionenum, int in_model_enum, int in_node)
 
 ~Nodalvalue ()
 
Objectcopy ()
 
void DeepEcho (void)
 
void Echo (void)
 
int Id (void)
 
void Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
 
int ObjectEnum (void)
 
int DefinitionEnum ()
 
char * Name ()
 
IssmDouble Response (FemModel *femmodel)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 
- Public Member Functions inherited from Definition
virtual ~Definition ()
 

Data Fields

int definitionenum
 
int model_enum
 
char * name
 
int node
 

Detailed Description

Definition at line 17 of file Nodalvalue.h.

Constructor & Destructor Documentation

◆ Nodalvalue() [1/2]

Nodalvalue::Nodalvalue ( )

Definition at line 22 of file Nodalvalue.cpp.

22  {/*{{{*/
23 
24  this->definitionenum = -1;
25  this->name = NULL;
26  this->model_enum = UNDEF;
27  this->node = -1;
28 
29 }

◆ Nodalvalue() [2/2]

Nodalvalue::Nodalvalue ( char *  in_name,
int  in_definitionenum,
int  in_model_enum,
int  in_node 
)

Definition at line 31 of file Nodalvalue.cpp.

31  {/*{{{*/
32 
33  this->definitionenum=in_definitionenum;
34  this->name = xNew<char>(strlen(in_name)+1);
35  xMemCpy<char>(this->name,in_name,strlen(in_name)+1);
36 
37  this->model_enum=in_model_enum;
38  this->node=in_node;
39 }

◆ ~Nodalvalue()

Nodalvalue::~Nodalvalue ( )

Definition at line 41 of file Nodalvalue.cpp.

41  {/*{{{*/
42  if(this->name)xDelete(this->name);
43 }

Member Function Documentation

◆ copy()

Object * Nodalvalue::copy ( void  )
virtual

Implements Object.

Definition at line 46 of file Nodalvalue.cpp.

46  {/*{{{*/
47  Nodalvalue* mf = new Nodalvalue(this->name,this->definitionenum, this->model_enum,this->node);
48  return (Object*) mf;
49 }

◆ DeepEcho()

void Nodalvalue::DeepEcho ( void  )
virtual

Implements Object.

Definition at line 51 of file Nodalvalue.cpp.

51  {/*{{{*/
52  this->Echo();
53 }

◆ Echo()

void Nodalvalue::Echo ( void  )
virtual

Implements Object.

Definition at line 55 of file Nodalvalue.cpp.

55  {/*{{{*/
56  _printf_(" Nodalvalue: " << name << " " << this->definitionenum << "\n");
57  _printf_(" model_enum: " << model_enum << " " << EnumToStringx(model_enum) << "\n");
58  _printf_(" node: " << node << "\n");
59 }

◆ Id()

int Nodalvalue::Id ( void  )
virtual

Implements Object.

Definition at line 61 of file Nodalvalue.cpp.

61  {/*{{{*/
62  return -1;
63 }

◆ Marshall()

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

Implements Object.

Definition at line 65 of file Nodalvalue.cpp.

65  {/*{{{*/
66  _error_("not implemented yet!");
67 }

◆ ObjectEnum()

int Nodalvalue::ObjectEnum ( void  )
virtual

Implements Object.

Definition at line 69 of file Nodalvalue.cpp.

69  {/*{{{*/
70  return NodalvalueEnum;
71 }

◆ DefinitionEnum()

int Nodalvalue::DefinitionEnum ( )
virtual

Implements Definition.

Definition at line 74 of file Nodalvalue.cpp.

74  {/*{{{*/
75 
76  return this->definitionenum;
77 }

◆ Name()

char * Nodalvalue::Name ( )
virtual

Implements Definition.

Definition at line 79 of file Nodalvalue.cpp.

79  {/*{{{*/
80 
81  char* name2=xNew<char>(strlen(this->name)+1);
82  xMemCpy(name2,this->name,strlen(this->name)+1);
83 
84  return name2;
85 }

◆ Response()

IssmDouble Nodalvalue::Response ( FemModel femmodel)
virtual

Implements Definition.

Definition at line 87 of file Nodalvalue.cpp.

87  {/*{{{*/
88 
89  /*output:*/
90  IssmDouble value;
91 
92  /*set index, which will be used by the NodalValue module: */
94 
95  /*call Nodalvalue:*/
98 
99  /*done:*/
100  return value;
101  }

Field Documentation

◆ definitionenum

int Nodalvalue::definitionenum

Definition at line 21 of file Nodalvalue.h.

◆ model_enum

int Nodalvalue::model_enum

Definition at line 22 of file Nodalvalue.h.

◆ name

char* Nodalvalue::name

Definition at line 23 of file Nodalvalue.h.

◆ node

int Nodalvalue::node

Definition at line 24 of file Nodalvalue.h.


The documentation for this class was generated from the following files:
FemModel::vertices
Vertices * vertices
Definition: FemModel.h:49
IndexEnum
@ IndexEnum
Definition: EnumDefinitions.h:201
IssmDouble
double IssmDouble
Definition: types.h:37
Nodalvalue::name
char * name
Definition: Nodalvalue.h:23
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
Nodalvalue
Definition: Nodalvalue.h:17
NodalvalueEnum
@ NodalvalueEnum
Definition: EnumDefinitions.h:1199
FemModel::parameters
Parameters * parameters
Definition: FemModel.h:46
Nodalvalue::node
int node
Definition: Nodalvalue.h:24
Parameters::SetParam
void SetParam(bool boolean, int enum_type)
Definition: Parameters.cpp:441
Object
Definition: Object.h:13
FemModel::nodes
Nodes * nodes
Definition: FemModel.h:56
xDelete
void xDelete(T **&aT_pp)
Definition: MemOps.h:97
FemModel::materials
Materials * materials
Definition: FemModel.h:45
EnumToStringx
const char * EnumToStringx(int enum_in)
Definition: EnumToStringx.cpp:15
UNDEF
#define UNDEF
Definition: constants.h:8
NodalValuex
void NodalValuex(IssmDouble *pnodalvalue, int natureofdataenum, Elements *elements, Nodes *nodes, Vertices *vertices, Loads *loads, Materials *materials, Parameters *parameters)
Definition: NodalValuex.cpp:10
FemModel::loads
Loads * loads
Definition: FemModel.h:54
FemModel::elements
Elements * elements
Definition: FemModel.h:44
Nodalvalue::Nodalvalue
Nodalvalue()
Definition: Nodalvalue.cpp:22
Nodalvalue::model_enum
int model_enum
Definition: Nodalvalue.h:22
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
Nodalvalue::Echo
void Echo(void)
Definition: Nodalvalue.cpp:55
xMemCpy
T * xMemCpy(T *dest, const T *src, unsigned int size)
Definition: MemOps.h:152
Nodalvalue::definitionenum
int definitionenum
Definition: Nodalvalue.h:21
femmodel
FemModel * femmodel
Definition: esmfbinders.cpp:16