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

#include <Vertex.h>

Inheritance diagram for Vertex:
Object

Public Member Functions

 Vertex ()
 
 Vertex (int id, int sid, bool clone, IoModel *iomodel, bool isamr)
 
 ~Vertex ()
 
void Echo ()
 
void DeepEcho ()
 
int Id ()
 
int ObjectEnum ()
 
Object * copy ()
 
void Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
 
int Connectivity (void)
 
IssmDouble GetLatitude (void)
 
IssmDouble GetLongitude (void)
 
IssmDouble GetRadius (void)
 
IssmDouble GetX (void)
 
IssmDouble GetY (void)
 
IssmDouble GetZ (void)
 
int Pid (void)
 
int Lid (void)
 
int Sid (void)
 
void UpdatePosition (Vector< IssmDouble > *vx, Vector< IssmDouble > *vy, Vector< IssmDouble > *vz, Parameters *parameters, IssmDouble *thickness, IssmDouble *bed)
 
void VertexCoordinates (Vector< IssmDouble > *vx, Vector< IssmDouble > *vy, Vector< IssmDouble > *vz, bool spherical=false)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 

Data Fields

bool clone
 
int domaintype
 
int id
 
int sid
 
int pid
 
int lid
 
IssmDouble x
 
IssmDouble y
 
IssmDouble z
 
IssmDouble latitute
 
IssmDouble longitude
 
IssmDouble R
 
IssmDouble sigma
 
int connectivity
 

Detailed Description

Definition at line 19 of file Vertex.h.

Constructor & Destructor Documentation

◆ Vertex() [1/2]

Vertex::Vertex ( )

Definition at line 18 of file Vertex.cpp.

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

◆ Vertex() [2/2]

Vertex::Vertex ( int  id,
int  sid,
bool  clone,
IoModel *  iomodel,
bool  isamr 
)

Definition at line 22 of file Vertex.cpp.

22  {/*{{{*/
23 
24  /*Checks in debugging mode*/
25  _assert_(vertex_sid>=0 && vertex_sid<iomodel->numberofvertices);
26 
27  /*IDs*/
28  this->id = vertex_id;
29  this->sid = vertex_sid;
30  this->pid = -1; /*Assigned later*/
31  this->lid = -1; /*Assigned later*/
32  this->clone = vertex_clone;
33 
34  /*Properties from iomodel*/
35  _assert_(iomodel->numbernodetoelementconnectivity);
36  this->connectivity = iomodel->numbernodetoelementconnectivity[vertex_sid];
37  this->domaintype = iomodel->domaintype;
38 
39  /*Coordinates, only if not AMR*/
40  if(!isamr){
41  _assert_(iomodel->Data("md.mesh.x") && iomodel->Data("md.mesh.y") && iomodel->Data("md.mesh.z"));
42  this->x = iomodel->Data("md.mesh.x")[vertex_sid];
43  this->y = iomodel->Data("md.mesh.y")[vertex_sid];
44  this->z = iomodel->Data("md.mesh.z")[vertex_sid];
45  if(iomodel->Data("md.mesh.lat") && iomodel->Data("md.mesh.long")){
46  this->latitute = iomodel->Data("md.mesh.lat")[vertex_sid];
47  this->longitude = iomodel->Data("md.mesh.long")[vertex_sid];
48  }
49 
50  switch(iomodel->domaintype){
51  case Domain3DEnum:
52  _assert_(iomodel->Data("md.geometry.base") && iomodel->Data("md.geometry.thickness"));
53  this->sigma = (iomodel->Data("md.mesh.z")[vertex_sid]-iomodel->Data("md.geometry.base")[vertex_sid])/(iomodel->Data("md.geometry.thickness")[vertex_sid]);
54  break;
55  case Domain3DsurfaceEnum:
56  _assert_(iomodel->Data("md.mesh.lat") && iomodel->Data("md.mesh.long") && iomodel->Data("md.mesh.r"));
57  this->latitute = iomodel->Data("md.mesh.lat")[vertex_sid];
58  this->longitude = iomodel->Data("md.mesh.long")[vertex_sid];
59  this->R = iomodel->Data("md.mesh.r")[vertex_sid];
60  break;
61  case Domain2DhorizontalEnum:
62  this->sigma = 0.;
63  break;
64  case Domain2DverticalEnum:
65  _assert_(iomodel->Data("md.geometry.base") && iomodel->Data("md.geometry.thickness"));
66  this->sigma = (iomodel->Data("md.mesh.y")[vertex_sid]-iomodel->Data("md.geometry.base")[vertex_sid])/(iomodel->Data("md.geometry.thickness")[vertex_sid]);
67  break;
68  }
69  }
70  else{
71  this->x = 0.;
72  this->y = 0.;
73  this->z = 0.;
74  this->latitute = 0.;
75  this->longitude = 0.;
76  this->R = 0.;
77  this->sigma = 0.;
78  }
79 
80 }/*}}}*/

◆ ~Vertex()

Vertex::~Vertex ( )

Definition at line 81 of file Vertex.cpp.

81  {/*{{{*/
82  return;
83 }

Member Function Documentation

◆ Echo()

void Vertex::Echo ( void  )
virtual

Implements Object.

Definition at line 97 of file Vertex.cpp.

97  {/*{{{*/
98 
99  _printf_("Vertex:\n");
100  _printf_(" id: " << id << "\n");
101  _printf_(" sid: " << sid << "\n");
102  _printf_(" pid: " << pid << "\n");
103  _printf_(" lid: " << lid << "\n");
104  _printf_(" x: " << x << "\n");
105  _printf_(" y: " << y << "\n");
106  _printf_(" z: " << z << "\n");
107  _printf_(" sigma: " << sigma << "\n");
108  _printf_(" connectivity: " << connectivity << "\n");
109  _printf_(" clone: " << clone << "\n");
110 
111  return;
112 }

◆ DeepEcho()

void Vertex::DeepEcho ( void  )
virtual

Implements Object.

Definition at line 93 of file Vertex.cpp.

93  {/*{{{*/
94  this->Echo();
95 }

◆ Id()

int Vertex::Id ( void  )
virtual

Implements Object.

Definition at line 114 of file Vertex.cpp.

114 { return id; }/*{{{*/

◆ ObjectEnum()

int Vertex::ObjectEnum ( void  )
virtual

Implements Object.

Definition at line 133 of file Vertex.cpp.

133  {/*{{{*/
134  return VertexEnum;
135 }/*}}}*/

◆ copy()

Object * Vertex::copy ( void  )
virtual

Implements Object.

Definition at line 87 of file Vertex.cpp.

87  {/*{{{*/
88 
89  return new Vertex(*this);
90 
91 }

◆ Marshall()

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

Implements Object.

Definition at line 116 of file Vertex.cpp.

116  { /*{{{*/
117 
118  MARSHALLING_ENUM(VertexEnum);
119  MARSHALLING(clone);
120  MARSHALLING(domaintype);
121  MARSHALLING(id);
122  MARSHALLING(sid);
123  MARSHALLING(pid);
124  MARSHALLING(lid);
125  MARSHALLING(x);
126  MARSHALLING(y);
127  MARSHALLING(z);
128  MARSHALLING(sigma);
129  MARSHALLING(connectivity);
130 
131 }

◆ Connectivity()

int Vertex::Connectivity ( void  )

Definition at line 138 of file Vertex.cpp.

138 {return connectivity;}/*{{{*/

◆ GetLatitude()

IssmDouble Vertex::GetLatitude ( void  )

Definition at line 140 of file Vertex.cpp.

140  {/*{{{*/
141  return this->latitute;
142 }

◆ GetLongitude()

IssmDouble Vertex::GetLongitude ( void  )

Definition at line 144 of file Vertex.cpp.

144  {/*{{{*/
145  return this->longitude;
146 }

◆ GetRadius()

IssmDouble Vertex::GetRadius ( void  )

Definition at line 148 of file Vertex.cpp.

148  {/*{{{*/
149  return this->R;
150 }

◆ GetX()

IssmDouble Vertex::GetX ( void  )

Definition at line 152 of file Vertex.cpp.

152  {/*{{{*/
153  return this->x;
154 }

◆ GetY()

IssmDouble Vertex::GetY ( void  )

Definition at line 156 of file Vertex.cpp.

156  {/*{{{*/
157  return this->y;
158 }

◆ GetZ()

IssmDouble Vertex::GetZ ( void  )

Definition at line 160 of file Vertex.cpp.

160  {/*{{{*/
161  return this->z;
162 }

◆ Pid()

int Vertex::Pid ( void  )

Definition at line 164 of file Vertex.cpp.

164 { return pid; }/*{{{*/

◆ Lid()

int Vertex::Lid ( void  )

Definition at line 166 of file Vertex.cpp.

166 { return lid; }/*{{{*/

◆ Sid()

int Vertex::Sid ( void  )

Definition at line 168 of file Vertex.cpp.

168 { return sid; }/*{{{*/

◆ UpdatePosition()

void Vertex::UpdatePosition ( Vector< IssmDouble > *  vx,
Vector< IssmDouble > *  vy,
Vector< IssmDouble > *  vz,
Parameters *  parameters,
IssmDouble *  thickness,
IssmDouble *  bed 
)

Definition at line 170 of file Vertex.cpp.

170  {/*{{{*/
171 
172  IssmDouble oldy,newy,vely;
173  IssmDouble oldz,newz,velz;
174  IssmDouble dt;
175 
176  /*Get time stepping*/
177  parameters->FindParam(&dt,TimesteppingTimeStepEnum);
178 
179  /*sigma remains constant. z=bed+sigma*thickness*/
180  switch(this->domaintype){
181  case Domain2DhorizontalEnum:
182  /*Nothing*/
183  return;
184  case Domain2DverticalEnum:
185  oldy = this->y;
186  newy = bed[this->pid]+sigma*(surface[this->pid] - bed[this->pid]);
187  vely = (newy-oldy)/dt;
188  this->y = newy;
189  vy->SetValue(this->pid,vely,INS_VAL);
190  _assert_(!xIsNan<IssmDouble>(vely));
191  return;
192  case Domain3DEnum:
193  oldz = this->z;
194  newz = bed[this->pid]+sigma*(surface[this->pid] - bed[this->pid]);
195  velz = (newz-oldz)/dt;
196  this->z = newz;
197  vz->SetValue(this->pid,velz,INS_VAL);
198  _assert_(!xIsNan<IssmDouble>(velz));
199  return;
200  default:
201  _error_("not implemented");
202  }
203 }

◆ VertexCoordinates()

void Vertex::VertexCoordinates ( Vector< IssmDouble > *  vx,
Vector< IssmDouble > *  vy,
Vector< IssmDouble > *  vz,
bool  spherical = false 
)

Definition at line 205 of file Vertex.cpp.

205  {/*{{{*/
206 
207  if(this->clone==true) return;
208 
209  if(!spherical){
210  vx->SetValue(this->sid,this->x,INS_VAL);
211  vy->SetValue(this->sid,this->y,INS_VAL);
212  vz->SetValue(this->sid,this->z,INS_VAL);
213  }
214  else{
215  vx->SetValue(this->sid,this->latitute,INS_VAL);
216  vy->SetValue(this->sid,this->longitude,INS_VAL);
217  vz->SetValue(this->sid,this->R,INS_VAL);
218  }
219 
220  return;
221 }

Field Documentation

◆ clone

bool Vertex::clone

Definition at line 22 of file Vertex.h.

◆ domaintype

int Vertex::domaintype

Definition at line 23 of file Vertex.h.

◆ id

int Vertex::id

Definition at line 24 of file Vertex.h.

◆ sid

int Vertex::sid

Definition at line 25 of file Vertex.h.

◆ pid

int Vertex::pid

Definition at line 26 of file Vertex.h.

◆ lid

int Vertex::lid

Definition at line 27 of file Vertex.h.

◆ x

IssmDouble Vertex::x

Definition at line 28 of file Vertex.h.

◆ y

IssmDouble Vertex::y

Definition at line 29 of file Vertex.h.

◆ z

IssmDouble Vertex::z

Definition at line 30 of file Vertex.h.

◆ latitute

IssmDouble Vertex::latitute

Definition at line 31 of file Vertex.h.

◆ longitude

IssmDouble Vertex::longitude

Definition at line 32 of file Vertex.h.

◆ R

IssmDouble Vertex::R

Definition at line 33 of file Vertex.h.

◆ sigma

IssmDouble Vertex::sigma

Definition at line 34 of file Vertex.h.

◆ connectivity

int Vertex::connectivity

Definition at line 35 of file Vertex.h.

The documentation for this class was generated from the following files:
Vertex::z
IssmDouble z
Definition: Vertex.h:30
_assert_
#define _assert_(ignore)
Definition: exceptions.h:37
IssmDouble
double IssmDouble
Definition: types.h:37
IoModel::numbernodetoelementconnectivity
int * numbernodetoelementconnectivity
Definition: IoModel.h:92
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
Vertex::domaintype
int domaintype
Definition: Vertex.h:23
Vertex::clone
bool clone
Definition: Vertex.h:22
MARSHALLING_ENUM
#define MARSHALLING_ENUM(EN)
Definition: Marshalling.h:14
TimesteppingTimeStepEnum
@ TimesteppingTimeStepEnum
Definition: EnumDefinitions.h:433
Vertex::Vertex
Vertex()
Definition: Vertex.cpp:18
Vertex::x
IssmDouble x
Definition: Vertex.h:28
Vertex::longitude
IssmDouble longitude
Definition: Vertex.h:32
Vertex::id
int id
Definition: Vertex.h:24
Domain2DhorizontalEnum
@ Domain2DhorizontalEnum
Definition: EnumDefinitions.h:534
Vertex::pid
int pid
Definition: Vertex.h:26
Vertex::latitute
IssmDouble latitute
Definition: Vertex.h:31
Domain3DsurfaceEnum
@ Domain3DsurfaceEnum
Definition: EnumDefinitions.h:1039
MARSHALLING
#define MARSHALLING(FIELD)
Definition: Marshalling.h:29
INS_VAL
@ INS_VAL
Definition: toolkitsenums.h:14
Domain3DEnum
@ Domain3DEnum
Definition: EnumDefinitions.h:536
VertexEnum
@ VertexEnum
Definition: EnumDefinitions.h:1322
IoModel::Data
IssmDouble * Data(const char *data_name)
Definition: IoModel.cpp:437
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
Vertex::lid
int lid
Definition: Vertex.h:27
Vertex::R
IssmDouble R
Definition: Vertex.h:33
Parameters::FindParam
void FindParam(bool *pinteger, int enum_type)
Definition: Parameters.cpp:262
Vertex::Echo
void Echo()
Definition: Vertex.cpp:97
Vertex::y
IssmDouble y
Definition: Vertex.h:29
IoModel::domaintype
int domaintype
Definition: IoModel.h:78
Domain2DverticalEnum
@ Domain2DverticalEnum
Definition: EnumDefinitions.h:535
Vertex::connectivity
int connectivity
Definition: Vertex.h:35
Vertex::sigma
IssmDouble sigma
Definition: Vertex.h:34
Vector::SetValue
void SetValue(int dof, doubletype value, InsMode mode)
Definition: Vector.h:163
Vertex::sid
int sid
Definition: Vertex.h:25
Generated on Thu Jul 2 2020 08:09:31 for Ice Sheet System Model by   doxygen 1.8.19