Ice Sheet System Model  4.18
Code documentation
Public Member Functions | Private Attributes
SpcTransient Class Reference

#include <SpcTransient.h>

Inheritance diagram for SpcTransient:
Constraint Object

Public Member Functions

 SpcTransient ()
 
 SpcTransient (int id_in, int nodeid, int dof, int nsteps, IssmDouble *times, IssmDouble *values, int analysis_type)
 
 ~SpcTransient ()
 
Object * copy ()
 
void DeepEcho ()
 
void Echo ()
 
int Id ()
 
void Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
 
int ObjectEnum ()
 
void ActivatePenaltyMethod (void)
 
void ConstrainNode (Nodes *nodes, Parameters *parameters)
 
void PenaltyDofAndValue (int *dof, IssmDouble *value, Nodes *nodes, Parameters *parameters)
 
void InputUpdateFromVectorDakota (IssmDouble *vector, Nodes *nodes, int name, int type)
 
int GetDof ()
 
int GetNodeId ()
 
IssmDouble GetValue ()
 
- Public Member Functions inherited from Constraint
virtual ~Constraint ()
 
- Public Member Functions inherited from Object
virtual ~Object ()
 

Private Attributes

int id
 
int nodeid
 
int dof
 
IssmDouble * values
 
IssmDouble * times
 
int nsteps
 
int analysis_type
 
bool penalty
 

Detailed Description

Definition at line 13 of file SpcTransient.h.

Constructor & Destructor Documentation

◆ SpcTransient() [1/2]

SpcTransient::SpcTransient ( )

Definition at line 16 of file SpcTransient.cpp.

16  {/*{{{*/
17  penalty = false;
18  id = -1;
19  nodeid = -1;
20  dof = -1;
21  values = NULL;
22  times = NULL;
23  nsteps = -1;
24  analysis_type = -1;
25  return;
26 }

◆ SpcTransient() [2/2]

SpcTransient::SpcTransient ( int  id_in,
int  nodeid,
int  dof,
int  nsteps,
IssmDouble *  times,
IssmDouble *  values,
int  analysis_type 
)

Definition at line 28 of file SpcTransient.cpp.

28  {/*{{{*/
29 
30  penalty = false;
31  id = spc_id;
32  nodeid = spc_nodeid;
33  dof = spc_dof;
34  nsteps = spc_nsteps;
35  if(spc_nsteps){
36  values = xNew<IssmDouble>(spc_nsteps);
37  times = xNew<IssmDouble>(spc_nsteps);
38  xMemCpy<IssmDouble>(values,spc_values,nsteps);
39  xMemCpy<IssmDouble>(times,spc_times,nsteps);
40  }
41  analysis_type=spc_analysis_type;
42  return;
43 }

◆ ~SpcTransient()

SpcTransient::~SpcTransient ( )

Definition at line 45 of file SpcTransient.cpp.

45  {/*{{{*/
46  xDelete<IssmDouble>(times);
47  xDelete<IssmDouble>(values);
48  return;
49 }

Member Function Documentation

◆ copy()

Object * SpcTransient::copy ( void  )
virtual

Implements Object.

Definition at line 53 of file SpcTransient.cpp.

53  {/*{{{*/
54  return new SpcTransient(id,nodeid,dof,nsteps,times,values,analysis_type);
55 }

◆ DeepEcho()

void SpcTransient::DeepEcho ( void  )
virtual

Implements Object.

Definition at line 57 of file SpcTransient.cpp.

57  {/*{{{*/
58  this->Echo();
59 }

◆ Echo()

void SpcTransient::Echo ( void  )
virtual

Implements Object.

Definition at line 61 of file SpcTransient.cpp.

61  {/*{{{*/
62 
63  int i;
64  _printf_("SpcTransient:\n");
65  _printf_(" id: " << id << "\n");
66  _printf_(" nodeid: " << nodeid << "\n");
67  _printf_(" dof: " << dof << "\n");
68  _printf_(" nsteps: " << nsteps << "\n");
69  _printf_(" analysis_type: " << EnumToStringx(analysis_type) << "\n");
70  _printf_(" steps|times|values\n");
71  for(i=0;i<nsteps;i++){
72  _printf_(i << "-" << times[i] << ":" << values[i] << "\n");
73  }
74  return;
75 }

◆ Id()

int SpcTransient::Id ( void  )
virtual

Implements Object.

Definition at line 77 of file SpcTransient.cpp.

77  {/*{{{*/
78  return id;
79 }

◆ Marshall()

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

Implements Object.

Definition at line 81 of file SpcTransient.cpp.

81  { /*{{{*/
82 
83  MARSHALLING_ENUM(SpcTransientEnum);
84 
85  MARSHALLING(id);
86  MARSHALLING(nodeid);
87  MARSHALLING(dof);
88  MARSHALLING(analysis_type);
89  MARSHALLING(penalty);
90  MARSHALLING(nsteps);
91  if(nsteps){
92  MARSHALLING_DYNAMIC(values,IssmDouble,nsteps);
93  MARSHALLING_DYNAMIC(times,IssmDouble,nsteps);
94  }
95  else{
96  values=NULL;
97  times=NULL;
98  }
99 
100 }

◆ ObjectEnum()

int SpcTransient::ObjectEnum ( void  )
virtual

Implements Object.

Definition at line 102 of file SpcTransient.cpp.

102  {/*{{{*/
103 
104  return SpcTransientEnum;
105 
106 }

◆ ActivatePenaltyMethod()

void SpcTransient::ActivatePenaltyMethod ( void  )
virtual

Implements Constraint.

Definition at line 110 of file SpcTransient.cpp.

110  {/*{{{*/
111  this->penalty = true;
112 }

◆ ConstrainNode()

void SpcTransient::ConstrainNode ( Nodes *  nodes,
Parameters *  parameters 
)
virtual

Implements Constraint.

Definition at line 114 of file SpcTransient.cpp.

114  {/*{{{*/
115 
116  Node *node = NULL;
117  IssmDouble time = 0.;
118  int i;
119  IssmDouble alpha = -1.;
120  IssmDouble value;
121  bool found = false;
122 
123  /*Chase through nodes and find the node to which this SpcTransient applys: */
124  node=(Node*)nodes->GetObjectById(NULL,nodeid);
125 
126  if(!this->penalty && node){ //in case the spc is dealing with a node on another cpu
127 
128  /*Retrieve time in parameters: */
129  parameters->FindParam(&time,TimeEnum);
130 
131  /*Now, go fetch value for this time: */
132  if (time<=times[0]){
133  value=values[0];
134  found=true;
135  }
136  else if (time>=times[nsteps-1]){
137  value=values[nsteps-1];
138  found=true;
139  }
140  else{
141  for(i=0;i<nsteps-1;i++){
142  if (times[i]<=time && time<times[i+1]){
143  alpha=(time-times[i])/(times[i+1]-times[i]);
144  value=(1-alpha)*values[i]+alpha*values[i+1];
145  found=true;
146  break;
147  }
148  }
149  }
150 
151  if(!found)_error_("could not find time segment for constraint");
152 
153  /*Apply or relax constraint: */
154  if(xIsNan<IssmDouble>(value)){
155  node->RelaxConstraint(dof);
156  }
157  else node->ApplyConstraint(dof,value);
158  }
159 }

◆ PenaltyDofAndValue()

void SpcTransient::PenaltyDofAndValue ( int *  dof,
IssmDouble *  value,
Nodes *  nodes,
Parameters *  parameters 
)
virtual

Implements Constraint.

Definition at line 161 of file SpcTransient.cpp.

161  {/*{{{*/
162 
163  if(!this->penalty) _error_("cannot return dof and value for non penalty constraint");
164 
165  Node *node = NULL;
166  IssmDouble time = 0.;
167  int i,gdof;
168  IssmDouble alpha = -1.;
169  IssmDouble value;
170  bool found = false;
171 
172  /*Chase through nodes and find the node to which this SpcTransient applys: */
173  node=(Node*)nodes->GetObjectById(NULL,nodeid);
174 
175  if(node){ //in case the spc is dealing with a node on another cpu
176 
177  /*Retrieve time in parameters: */
178  parameters->FindParam(&time,TimeEnum);
179 
180  /*Now, go fetch value for this time: */
181  if (time<=times[0]){
182  value=values[0];
183  found=true;
184  }
185  else if (time>=times[nsteps-1]){
186  value=values[nsteps-1];
187  found=true;
188  }
189  else{
190  for(i=0;i<nsteps-1;i++){
191  if (times[i]<=time && time<times[i+1]){
192  alpha=(time-times[i])/(times[i+1]-times[i]);
193  value=(1-alpha)*values[i]+alpha*values[i+1];
194  found=true;
195  break;
196  }
197  }
198  }
199  if(!found)_error_("could not find time segment for constraint");
200 
201  /*Get gdof */
202  gdof = node->GetDof(dof,GsetEnum);
203  if(xIsNan<IssmDouble>(value)){
204  gdof = -1;
205  }
206  }
207  else{
208  value = NAN;
209  gdof = -1;
210  }
211 
212  /*Assign output pointers*/
213  *pdof = gdof;
214  *pvalue = value;
215 }

◆ InputUpdateFromVectorDakota()

void SpcTransient::InputUpdateFromVectorDakota ( IssmDouble *  vector,
Nodes *  nodes,
int  name,
int  type 
)
inlinevirtual

Implements Constraint.

Definition at line 44 of file SpcTransient.h.

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

◆ GetDof()

int SpcTransient::GetDof ( )

Definition at line 219 of file SpcTransient.cpp.

219  {/*{{{*/
220  return dof;
221 }

◆ GetNodeId()

int SpcTransient::GetNodeId ( )

Definition at line 223 of file SpcTransient.cpp.

223  {/*{{{*/
224 
225  return nodeid;
226 }

◆ GetValue()

IssmDouble SpcTransient::GetValue ( )

Definition at line 228 of file SpcTransient.cpp.

228  {/*{{{*/
229  return values[0];
230 }

Field Documentation

◆ id

int SpcTransient::id
private

Definition at line 16 of file SpcTransient.h.

◆ nodeid

int SpcTransient::nodeid
private

Definition at line 17 of file SpcTransient.h.

◆ dof

int SpcTransient::dof
private

Definition at line 18 of file SpcTransient.h.

◆ values

IssmDouble* SpcTransient::values
private

Definition at line 19 of file SpcTransient.h.

◆ times

IssmDouble* SpcTransient::times
private

Definition at line 20 of file SpcTransient.h.

◆ nsteps

int SpcTransient::nsteps
private

Definition at line 21 of file SpcTransient.h.

◆ analysis_type

int SpcTransient::analysis_type
private

Definition at line 22 of file SpcTransient.h.

◆ penalty

bool SpcTransient::penalty
private

Definition at line 23 of file SpcTransient.h.

The documentation for this class was generated from the following files:
SpcTransientEnum
@ SpcTransientEnum
Definition: EnumDefinitions.h:1281
SpcTransient::Echo
void Echo()
Definition: SpcTransient.cpp:61
IssmDouble
double IssmDouble
Definition: types.h:37
SpcTransient::times
IssmDouble * times
Definition: SpcTransient.h:20
DataSet::GetObjectById
Object * GetObjectById(int *poffset, int eid)
Definition: DataSet.cpp:345
SpcTransient::SpcTransient
SpcTransient()
Definition: SpcTransient.cpp:16
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
SpcTransient::analysis_type
int analysis_type
Definition: SpcTransient.h:22
SpcTransient::nsteps
int nsteps
Definition: SpcTransient.h:21
TimeEnum
@ TimeEnum
Definition: EnumDefinitions.h:427
MARSHALLING_ENUM
#define MARSHALLING_ENUM(EN)
Definition: Marshalling.h:14
SpcTransient::values
IssmDouble * values
Definition: SpcTransient.h:19
SpcTransient::dof
int dof
Definition: SpcTransient.h:18
MARSHALLING_DYNAMIC
#define MARSHALLING_DYNAMIC(FIELD, TYPE, SIZE)
Definition: Marshalling.h:61
Node::RelaxConstraint
void RelaxConstraint(int dof)
Definition: Node.cpp:813
EnumToStringx
const char * EnumToStringx(int enum_in)
Definition: EnumToStringx.cpp:15
GsetEnum
@ GsetEnum
Definition: EnumDefinitions.h:1093
alpha
IssmDouble alpha(IssmDouble x, IssmDouble y, IssmDouble z, int testid)
Definition: fsanalyticals.cpp:221
MARSHALLING
#define MARSHALLING(FIELD)
Definition: Marshalling.h:29
SpcTransient::nodeid
int nodeid
Definition: SpcTransient.h:17
Node
Definition: Node.h:23
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
Parameters::FindParam
void FindParam(bool *pinteger, int enum_type)
Definition: Parameters.cpp:262
Node::ApplyConstraint
void ApplyConstraint(int dof, IssmDouble value)
Definition: Node.cpp:646
SpcTransient::id
int id
Definition: SpcTransient.h:16
SpcTransient::penalty
bool penalty
Definition: SpcTransient.h:23
Node::GetDof
int GetDof(int dofindex, int setenum)
Definition: Node.cpp:374
Generated on Thu Jul 2 2020 08:09:30 for Ice Sheet System Model by   doxygen 1.8.19