source: issm/trunk-jpl/src/c/classes/Elements/Element.h@ 17118

Last change on this file since 17118 was 17118, checked in by jbondzio, 11 years ago

CHG: Negative sign of md.mask.ice_levelset represents existence of ice. This way the normal computed by the level-set function points out of the ice domain.
File size: 16.9 KB
Line 
1/*!\file: Element.h
2 * \brief abstract class for Element object
3 * This class is a place holder for the Tria and the Penta elements.
4 * It is derived from Element, so DataSets can contain them.
5 */
6
7#ifndef _ELEMENT_H_
8#define _ELEMENT_H_
9
10/*Headers:*/
11/*{{{*/
12#include "../../datastructures/datastructures.h"
13#include "../../toolkits/toolkits.h"
14#include "../Update.h"
15class DataSet;
16class Parameters;
17class Parameter;
18class Elements;
19class Loads;
20class Nodes;
21class Node;
22class Vertices;
23class Vertex;
24class Materials;
25class Material;
26class Matpar;
27class Inputs;
28class Input;
29class Gauss;
30class ElementVector;
31template <class doublematrix> class Matrix;
32template <class doubletype> class Vector;
33class ElementMatrix;
34class ElementVector;
35/*}}}*/
36
37class Element: public Object,public Update{
38
39 public:
40 Inputs *inputs;
41 Node **nodes;
42 Vertex **vertices;
43 Material *material;
44 Matpar *matpar;
45 Parameters *parameters;
46
47 public:
48 /*Constructors/Destructores*/
49 Element();
50 ~Element();
51
52 /*Functions*/
53 void AddInput(Input* input_in);
54 bool AllActive(void);
55 bool AnyActive(void);
56 void DeleteMaterials(void);
57 void FindParam(bool* pvalue,int paramenum);
58 void FindParam(int* pvalue,int paramenum);
59 void FindParam(IssmDouble* pvalue,int paramenum);
60 void FindParam(int** pvalues,int* psize,int paramenum);
61 Input* GetInput(int inputenum);
62 IssmDouble GetMaterialParameter(int enum_in);
63 void GetPhi(IssmDouble* phi, IssmDouble* epsilon, IssmDouble viscosity);
64 void GetVerticesSidList(int* sidlist);
65 void GetVerticesConnectivityList(int* connectivitylist);
66 bool IsFloating();
67 void ResultInterpolation(int* pinterpolation,int*nodesperelement,int output_enum);
68 void ResultToVector(Vector<IssmDouble>* vector,int output_enum);
69 void ResultToPatch(IssmDouble* values,int nodesperelement,int output_enum);
70 void StrainRateSSA(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
71 void StrainRateHO(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
72 void StrainRateFS(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
73 IssmDouble TMeltingPoint(IssmDouble pressure);
74 void ViscousHeatingCreateInput(void);
75 void ViscosityFS(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
76 void ViscosityHO(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
77 void ViscosityL1L2(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* surf);
78 void ViscositySSA(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
79 void ViscositySSADerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
80 void ViscosityHODerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
81 void ViscosityFSDerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
82 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,int transformenum);
83 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes_list,int numnodes,int* transformenum_list);
84 void TransformLoadVectorCoord(ElementVector* pe,int transformenum);
85 void TransformLoadVectorCoord(ElementVector* pe,int* transformenum_list);
86 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int transformenum){_error_("not implemented yet");};/*Tiling only*/
87 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int* transformenum_list){_error_("not implemented yet");};/*Tiling only*/
88 void TransformLoadVectorCoord(ElementVector* pe,Node** nodes_list,int numnodes,int* transformenum_list);
89 void TransformSolutionCoord(IssmDouble* values,int transformenum);
90 void TransformSolutionCoord(IssmDouble* values,int* transformenum_list);
91 void TransformSolutionCoord(IssmDouble* values,int numnodes,int transformenum);
92 void TransformSolutionCoord(IssmDouble* values,int numnodes,int* transformenum_list);
93 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int transformenum);
94 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int* transformenum_list);
95 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int transformenum);
96 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int* transformenum_list){_error_("not implemented yet");};/*Tiling only*/
97 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes_list,int numnodes,int* transformenum_list);
98
99 /*Virtual functions*/
100 virtual void AddBasalInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
101 virtual void AddInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
102 virtual void AddMaterialInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
103 virtual IssmDouble CharacteristicLength(void)=0;
104 virtual void Configure(Elements* elements,Loads* loads,Nodes* nodes,Vertices* vertices,Materials* materials,Parameters* parameters)=0;
105 virtual void SetCurrentConfiguration(Elements* elements,Loads* loads,Nodes* nodes,Materials* materials,Parameters* parameters)=0;
106 virtual void SetwiseNodeConnectivity(int* d_nz,int* o_nz,Node* node,bool* flags,int* flagsindices,int set1_enum,int set2_enum)=0;
107 virtual void ElementSizes(IssmDouble* phx,IssmDouble* phy,IssmDouble* phz)=0;
108 virtual void ThermalToEnthalpy(IssmDouble* penthalpy,IssmDouble temperature,IssmDouble waterfraction,IssmDouble pressure)=0;
109 virtual void EnthalpyToThermal(IssmDouble* ptemperature,IssmDouble* pwaterfraction,IssmDouble enthalpy,IssmDouble pressure)=0;
110 virtual IssmDouble EnthalpyDiffusionParameter(IssmDouble enthalpy,IssmDouble pressure)=0;
111 virtual IssmDouble EnthalpyDiffusionParameterVolume(int numvertices,IssmDouble* enthalpy,IssmDouble* pressure)=0;
112 virtual int FiniteElement(void)=0;
113 virtual IssmDouble MinEdgeLength(IssmDouble* xyz_list)=0;
114 virtual void NodalFunctions(IssmDouble* basis,Gauss* gauss)=0;
115 virtual void NodalFunctionsP1(IssmDouble* basis,Gauss* gauss)=0;
116 virtual void NodalFunctionsVelocity(IssmDouble* basis, Gauss* gauss)=0;
117 virtual void NodalFunctionsPressure(IssmDouble* basis, Gauss* gauss)=0;
118 virtual void NodalFunctionsDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
119 virtual void NodalFunctionsP1Derivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
120 virtual void NodalFunctionsMINIDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
121 virtual void NodalFunctionsDerivativesVelocity(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
122 virtual void NormalSection(IssmDouble* normal,IssmDouble* xyz_list)=0;
123 virtual void NormalTop(IssmDouble* normal,IssmDouble* xyz_list)=0;
124 virtual void NormalBase(IssmDouble* normal,IssmDouble* xyz_list)=0;
125 virtual IssmDouble PureIceEnthalpy(IssmDouble pressure)=0;
126
127 virtual Element* GetUpperElement(void)=0;
128 virtual Element* GetLowerElement(void)=0;
129 virtual Element* GetSurfaceElement(void)=0;
130 virtual Element* GetBasalElement(void)=0;
131 virtual void GetDofList(int** pdoflist,int approximation_enum,int setenum)=0;
132 virtual void GetDofListVelocity(int** pdoflist,int setenum)=0;
133 virtual void GetDofListPressure(int** pdoflist,int setenum)=0;
134 virtual void JacobianDeterminant(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
135 virtual void JacobianDeterminantLine(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
136 virtual void JacobianDeterminantSurface(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
137 virtual void JacobianDeterminantBase(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
138 virtual void JacobianDeterminantTop(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
139 virtual void GetSolutionFromInputsOneDof(Vector<IssmDouble>* solution,int solutionenum)=0;
140 virtual int GetNodeIndex(Node* node)=0;
141 virtual int GetNumberOfNodes(void)=0;
142 virtual int GetNumberOfNodesVelocity(void)=0;
143 virtual int GetNumberOfNodesPressure(void)=0;
144 virtual int GetNumberOfVertices(void)=0;
145 virtual void GetNodesSidList(int* sidlist)=0;
146 virtual void GetNodesLidList(int* sidlist)=0;
147
148 virtual int Id()=0;
149 virtual int Sid()=0;
150 virtual bool IsNodeOnShelfFromFlags(IssmDouble* flags)=0;
151 virtual bool IsOnBed()=0;
152 virtual bool IsOnSurface()=0;
153 virtual bool IsIceInElement()=0;
154 virtual void GetGroundedPart(int* point1,IssmDouble* fraction1,IssmDouble* fraction2, bool* mainlyfloating)=0;
155 virtual IssmDouble GetGroundedPortion(IssmDouble* xyz_list)=0;
156 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype)=0;
157 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
158 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype)=0;
159 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
160 virtual Input* GetMaterialInput(int inputenum)=0;
161 virtual void GetInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
162 virtual void GetInputValue(bool* pvalue,int enum_type)=0;
163 virtual void GetInputValue(int* pvalue,int enum_type)=0;
164 virtual void GetInputValue(IssmDouble* pvalue,int enum_type)=0;
165 virtual void GetInputValue(IssmDouble* pvalue,Gauss* gauss,int enum_type)=0;
166 virtual Node* GetNode(int node_number)=0;
167 virtual void GetVerticesCoordinates(IssmDouble** xyz_list)=0;
168 virtual void GetVerticesCoordinatesBase(IssmDouble** xyz_list)=0;
169 virtual void GetVerticesCoordinatesTop(IssmDouble** xyz_list)=0;
170 virtual IssmDouble GetXcoord(Gauss* gauss)=0;
171 virtual IssmDouble GetYcoord(Gauss* gauss)=0;
172 virtual IssmDouble GetZcoord(Gauss* gauss)=0;
173 virtual void GetMaterialInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
174 virtual int GetElementType(void)=0;
175
176 virtual IssmDouble SurfaceArea(void)=0;
177 virtual void InputDepthAverageAtBase(int enum_type,int average_enum_type,int object_enum)=0;
178 virtual void InputChangeName(int enum_type,int enum_type_old)=0;
179 virtual void ComputeBasalStress(Vector<IssmDouble>* sigma_b)=0;
180 virtual void ComputeStrainRate(Vector<IssmDouble>* eps)=0;
181 virtual void ComputeStressTensor(void)=0;
182
183 virtual void Update(int index, IoModel* iomodel,int analysis_counter,int analysis_type,int finite_element)=0;
184 virtual void InputDuplicate(int original_enum,int new_enum)=0;
185 virtual void InputCreate(IssmDouble* vector,IoModel* iomodel,int M,int N,int vector_type,int vector_enum,int code)=0;
186 virtual void InputUpdateFromSolutionOneDofCollapsed(IssmDouble* solution,int inputenum)=0;
187 virtual void InputUpdateFromSolutionOneDof(IssmDouble* solution,int inputenum)=0;
188
189 virtual int NodalValue(IssmDouble* pvalue, int index, int natureofdataenum)=0;
190 virtual int NumberofNodesVelocity(void)=0;
191 virtual int NumberofNodesPressure(void)=0;
192 virtual Gauss* NewGauss(void)=0;
193 virtual Gauss* NewGauss(int order)=0;
194 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order)=0;
195 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order_horiz,int order_vert)=0;
196 virtual Gauss* NewGauss(int point1,IssmDouble fraction1,IssmDouble fraction2,bool mainlyfloating,int order)=0;
197 virtual Gauss* NewGaussBase(int order)=0;
198 virtual Gauss* NewGaussLine(int vertex1,int vertex2,int order)=0;
199 virtual Gauss* NewGaussTop(int order)=0;
200 virtual ElementVector* NewElementVector(int approximation_enum=NoneApproximationEnum)=0;
201 virtual ElementMatrix* NewElementMatrix(int approximation_enum=NoneApproximationEnum)=0;
202 virtual ElementMatrix* NewElementMatrixCoupling(int number_nodes,int approximation_enum=NoneApproximationEnum)=0;
203 virtual void InputScale(int enum_type,IssmDouble scale_factor)=0;
204 virtual void GetVectorFromInputs(Vector<IssmDouble>* vector, int name_enum)=0;
205 virtual IssmDouble TimeAdapt()=0;
206 virtual void PositiveDegreeDay(IssmDouble* pdds,IssmDouble* pds,IssmDouble signorm)=0;
207 virtual void Delta18oParameterization(void)=0;
208 virtual void SmbGradients(void)=0;
209 virtual Element* SpawnBasalElement(void)=0;
210 virtual void ReduceMatrices(ElementMatrix* Ke,ElementVector* pe)=0;
211 virtual void ResetCoordinateSystem()=0;
212 virtual void SetTemporaryElementType(int element_type_in)=0;
213 virtual IssmDouble StabilizationParameter(IssmDouble u, IssmDouble v, IssmDouble w, IssmDouble diameter, IssmDouble kappa)=0;
214 virtual void ValueP1OnGauss(IssmDouble* pvalue,IssmDouble* values,Gauss* gauss)=0;
215 virtual void ValueP1DerivativesOnGauss(IssmDouble* dvalue,IssmDouble* values,IssmDouble* xyz_list,Gauss* gauss)=0;
216 virtual void ViscousHeating(IssmDouble* pphi,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input)=0;
217
218 virtual int VelocityInterpolation()=0;
219 virtual int PressureInterpolation()=0;
220 virtual bool IsZeroLevelset(int levelset_enum)=0;
221 virtual void ZeroLevelsetCoordinates(IssmDouble** pxyz_zero,IssmDouble* xyz_list,int levelsetenum)=0;
222
223 #ifdef _HAVE_RESPONSES_
224 virtual void AverageOntoPartition(Vector<IssmDouble>* partition_contributions,Vector<IssmDouble>* partition_areas,IssmDouble* vertex_response,IssmDouble* qmu_part)=0;
225 virtual void MinVel(IssmDouble* pminvel)=0;
226 virtual void MaxVel(IssmDouble* pmaxvel)=0;
227 virtual void MinVx(IssmDouble* pminvx)=0;
228 virtual void MaxVx(IssmDouble* pmaxvx)=0;
229 virtual void MaxAbsVx(IssmDouble* pmaxabsvx)=0;
230 virtual void MinVy(IssmDouble* pminvy)=0;
231 virtual void MaxVy(IssmDouble* pmaxvy)=0;
232 virtual void MaxAbsVy(IssmDouble* pmaxabsvy)=0;
233 virtual void MinVz(IssmDouble* pminvz)=0;
234 virtual void MaxVz(IssmDouble* pmaxvz)=0;
235 virtual void MaxAbsVz(IssmDouble* pmaxabsvz)=0;
236 virtual IssmDouble MassFlux(IssmDouble* segment)=0;
237 virtual IssmDouble MassFlux(IssmDouble x1,IssmDouble y1, IssmDouble x2, IssmDouble y2,int segment_id)=0;
238 virtual void ElementResponse(IssmDouble* presponse,int response_enum)=0;
239 virtual IssmDouble IceVolume(void)=0;
240 virtual IssmDouble IceVolumeAboveFloatation(void)=0;
241 virtual IssmDouble TotalSmb(void)=0;
242 virtual IssmDouble Misfit(int modelenum,int observationenum,int weightsenum)=0;
243 virtual IssmDouble MisfitArea(int weightsenum)=0;
244 virtual int VertexConnectivity(int vertexindex)=0;
245 virtual void VerticalSegmentIndices(int** pindices,int* pnumseg)=0;
246 #endif
247
248 #ifdef _HAVE_GIA_
249 virtual void GiaDeflection(Vector<IssmDouble>* wg,Vector<IssmDouble>* dwgdt,IssmDouble* x,IssmDouble* y)=0;
250 #endif
251
252 #ifdef _HAVE_CONTROL_
253 virtual void Gradj(Vector<IssmDouble>* gradient,int control_type,int control_index)=0;
254 virtual IssmDouble ThicknessAbsMisfit(void)=0;
255 virtual IssmDouble SurfaceAbsVelMisfit(void)=0;
256 virtual IssmDouble SurfaceRelVelMisfit(void)=0;
257 virtual IssmDouble SurfaceLogVelMisfit(void)=0;
258 virtual IssmDouble SurfaceLogVxVyMisfit(void)=0;
259 virtual IssmDouble SurfaceAverageVelMisfit(void)=0;
260 virtual IssmDouble ThicknessAbsGradient(void)=0;
261 virtual IssmDouble ThicknessAlongGradient(void)=0;
262 virtual IssmDouble ThicknessAcrossGradient(void)=0;
263 virtual IssmDouble BalancethicknessMisfit(void)=0;
264 virtual IssmDouble RheologyBbarAbsGradient(void)=0;
265 virtual IssmDouble DragCoefficientAbsGradient(void)=0;
266 virtual void ControlInputGetGradient(Vector<IssmDouble>* gradient,int enum_type,int control_index)=0;
267 virtual void ControlInputSetGradient(IssmDouble* gradient,int enum_type,int control_index)=0;
268 virtual void ControlInputScaleGradient(int enum_type, IssmDouble scale)=0;
269 virtual void ControlToVectors(Vector<IssmPDouble>* vector_control, Vector<IssmPDouble>* vector_gradient,int control_enum)=0;
270 virtual void GetVectorFromControlInputs(Vector<IssmDouble>* gradient,int control_enum,int control_index,const char* data)=0;
271 virtual void SetControlInputsFromVector(IssmDouble* vector,int control_enum,int control_index)=0;
272 virtual void InputControlUpdate(IssmDouble scalar,bool save_parameter)=0;
273 #endif
274
275 virtual void UpdateConstraintsExtrudeFromBase(void)=0;
276 virtual void UpdateConstraintsExtrudeFromTop(void)=0;
277
278 #ifdef _HAVE_HYDROLOGY_
279 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max,int index)=0;
280 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, Node* innode)=0;
281 virtual void GetHydrologyTransfer(Vector<IssmDouble>* transfer)=0;
282 virtual void HydrologyEPLGetMask(Vector<IssmDouble>* mask)=0;
283 virtual void HydrologyEPLGetActive(Vector<IssmDouble>* active)=0;
284 virtual void ComputeEPLThickness(void)=0;
285 #endif
286
287 #ifdef _HAVE_GROUNDINGLINE_
288 virtual void MigrateGroundingLine(IssmDouble* sheet_ungrounding)=0;
289 virtual void PotentialUngrounding(Vector<IssmDouble>* potential_sheet_ungrounding)=0;
290 virtual int UpdatePotentialUngrounding(IssmDouble* potential_sheet_ungrounding,Vector<IssmDouble>* vec_nodes_on_iceshelf,IssmDouble* nodes_on_iceshelf)=0;
291 #endif
292
293};
294#endif
Note: See TracBrowser for help on using the repository browser.