SpcStatic Class Reference

#include <SpcStatic.h>

Inheritance diagram for SpcStatic:

Public Member Functions
	SpcStatic ()
	SpcStatic (int id, int nodeid, int dof, IssmDouble value, int analysis_type)
	~SpcStatic ()
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	value
int	analysis_type
bool	penalty

Detailed Description

Definition at line 13 of file SpcStatic.h.

Constructor & Destructor Documentation

SpcStatic() [1/2]

SpcStatic::SpcStatic

(

)

Definition at line 16 of file SpcStatic.cpp.

                    {/*{{{*/
   return;
}

SpcStatic() [2/2]

SpcStatic::SpcStatic	(	int	id,
		int	nodeid,
		int	dof,
		IssmDouble	value,
		int	analysis_type
	)

Definition at line 20 of file SpcStatic.cpp.

                                                                                                     {/*{{{*/
 
   id           = spc_id;
   nodeid        = spc_nodeid;
   dof           = spc_dof;
   value         = spc_value;
   analysis_type = spc_analysis_type;
   penalty       = false;
 
   return;
}

~SpcStatic()

SpcStatic::~SpcStatic

(

)

Definition at line 32 of file SpcStatic.cpp.

                     {/*{{{*/
   return;
}

Member Function Documentation

copy()

Object * SpcStatic::copy ( void  )

virtual

Implements Object.

Definition at line 38 of file SpcStatic.cpp.

                        {/*{{{*/
 
   SpcStatic* spcstat = new SpcStatic(*this); 
 
   spcstat->id=this->id;
   spcstat->nodeid=this->nodeid;
   spcstat->dof=this->dof;
   spcstat->value=this->value;
   spcstat->analysis_type=this->analysis_type;
 
   return (Object*) spcstat;
}

DeepEcho()

void SpcStatic::DeepEcho ( void  )

virtual

Implements Object.

Definition at line 51 of file SpcStatic.cpp.

                               {/*{{{*/
 
   _printf_("SpcStatic:\n");
   _printf_("   id: " << id << "\n");
   _printf_("   nodeid: " << nodeid << "\n");
   _printf_("   dof: " << dof << "\n");
   _printf_("   value: " << value << "\n");
   _printf_("   analysis_type: " << EnumToStringx(analysis_type) << "\n");
   return;
}     

Echo()

void SpcStatic::Echo ( void  )

virtual

Implements Object.

Definition at line 62 of file SpcStatic.cpp.

                           {/*{{{*/
 
   _printf_("SpcStatic:\n");
   _printf_("   id: " << id << "\n");
   _printf_("   nodeid: " << nodeid << "\n");
   _printf_("   dof: " << dof << "\n");
   _printf_("   value: " << value << "\n");
   _printf_("   analysis_type: " << EnumToStringx(analysis_type) << "\n");
   return;
}

Id()

int SpcStatic::Id ( void  )

virtual

Implements Object.

Definition at line 73 of file SpcStatic.cpp.

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

Marshall()

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

virtual

Implements Object.

Definition at line 75 of file SpcStatic.cpp.

                                                                                                     { /*{{{*/
 
   MARSHALLING_ENUM(SpcStaticEnum);
 
   MARSHALLING(id);
   MARSHALLING(nodeid);
   MARSHALLING(dof);
   MARSHALLING(value);
   MARSHALLING(analysis_type);
   MARSHALLING(penalty);
 
}

ObjectEnum()

int SpcStatic::ObjectEnum ( void  )

virtual

Implements Object.

Definition at line 88 of file SpcStatic.cpp.

                                 {/*{{{*/
 
   return SpcStaticEnum;
 
}

ActivatePenaltyMethod()

void SpcStatic::ActivatePenaltyMethod ( void  )

virtual

Implements Constraint.

Definition at line 96 of file SpcStatic.cpp.

                                         {/*{{{*/
      this->penalty = true;
}

ConstrainNode()

void SpcStatic::ConstrainNode ( Nodes *  nodes, Parameters *  parameters  )

virtual

Implements Constraint.

Definition at line 100 of file SpcStatic.cpp.

                                                                {/*{{{*/
 
   /*Chase through nodes and find the node to which this SpcStatic applys: */
   Node* node=(Node*)nodes->GetObjectById(NULL,nodeid);
 
   /*Apply constraint: */
   if(!this->penalty && node){ //in case the spc is dealing with a node on another cpu
      node->ApplyConstraint(dof,value);
   }
}

PenaltyDofAndValue()

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

virtual

Implements Constraint.

Definition at line 127 of file SpcStatic.cpp.

                                                                                                  {/*{{{*/
 
   if(!this->penalty) _error_("cannot return dof and value for non penalty constraint");
 
   IssmDouble value_out = this->value;
   int gdof;
 
   /*Chase through nodes and find the node to which this SpcTransient applys: */
   Node* node=(Node*)nodes->GetObjectById(NULL,nodeid);
 
   if(node){ //in case the spc is dealing with a node on another cpu
 
      /*Get gdof */
      gdof = node->GetDof(dof,GsetEnum);
      if(xIsNan<IssmDouble>(value_out)) gdof = -1;
   }
   else{
      value_out = NAN;
      gdof = -1;
   }
 
   /*Assign output pointers*/
   *pdof   = gdof;
   *pvalue = value_out;
}

InputUpdateFromVectorDakota()

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

virtual

Implements Constraint.

Definition at line 111 of file SpcStatic.cpp.

                                                                                            {/*{{{*/
 
   /*Only update if this is a constraint parameter*/
   if(name != BalancethicknessSpcthicknessEnum) return;
 
   /*Chase through nodes and find the node to which this SpcStatic applies: */
   Node* node=(Node*)nodes->GetObjectById(NULL,nodeid);
 
   /*Apply constraint: */
   if(node){ //in case the spc is dealing with a node on another cpu
      int sid = node->Sid();
      this->value = vector[sid];
      _assert_(!xIsNan<IssmDouble>(this->value)); 
   }
}

GetDof()

int SpcStatic::GetDof

(

)

Definition at line 155 of file SpcStatic.cpp.

                            {/*{{{*/
   return dof;
}

GetNodeId()

int SpcStatic::GetNodeId

(

)

Definition at line 159 of file SpcStatic.cpp.

                               {/*{{{*/
 
   return nodeid;
}

GetValue()

IssmDouble SpcStatic::GetValue

(

)

Definition at line 164 of file SpcStatic.cpp.

                              {/*{{{*/
   _assert_(!xIsNan<IssmDouble>(value));
   return value;
}

Field Documentation

id

int SpcStatic::id

private

Definition at line 16 of file SpcStatic.h.

nodeid

int SpcStatic::nodeid

private

id, to track it

Definition at line 17 of file SpcStatic.h.

dof

int SpcStatic::dof

private

node id

Definition at line 18 of file SpcStatic.h.

value

IssmDouble SpcStatic::value

private

component

Definition at line 19 of file SpcStatic.h.

analysis_type

int SpcStatic::analysis_type

private

Definition at line 20 of file SpcStatic.h.

penalty

bool SpcStatic::penalty

private

Definition at line 21 of file SpcStatic.h.

---

The documentation for this class was generated from the following files:

• src/c/classes/Constraints/SpcStatic.h
• src/c/classes/Constraints/SpcStatic.cpp