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

Last change on this file since 18093 was 18093, checked in by seroussi, 11 years ago

BEW: adding new class for floating ice melt rate

File size: 17.2 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 int id;
41 int sid;
42 Inputs *inputs;
43 Node **nodes;
44 Vertex **vertices;
45 Material *material;
46 Matpar *matpar;
47 Parameters *parameters;
48
49 int* element_type_list;
50 int element_type;
51
52 public:
53 /*Constructors/Destructores*/
54 Element();
55 ~Element();
56
57 /*Functions*/
58 void AddInput(Input* input_in);
59 /* bool AllActive(void); */
60 /* bool AnyActive(void); */
61 void CoordinateSystemTransform(IssmDouble** ptransform,Node** nodes,int numnodes,int* cs_array);
62 void Echo();
63 void DeepEcho();
64 void DeleteMaterials(void);
65 void dViscositydBSSA(IssmDouble* pdmudB,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
66 void dViscositydDSSA(IssmDouble* pdmudB,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
67 IssmDouble Divergence(void);
68 void ThermalToEnthalpy(IssmDouble* penthalpy,IssmDouble temperature,IssmDouble waterfraction,IssmDouble pressure);
69 void EnthalpyToThermal(IssmDouble* ptemperature,IssmDouble* pwaterfraction,IssmDouble enthalpy,IssmDouble pressure);
70 IssmDouble EnthalpyDiffusionParameter(IssmDouble enthalpy,IssmDouble pressure);
71 IssmDouble EnthalpyDiffusionParameterVolume(int numvertices,IssmDouble* enthalpy,IssmDouble* pressure);
72 void FindParam(bool* pvalue,int paramenum);
73 void FindParam(int* pvalue,int paramenum);
74 void FindParam(IssmDouble* pvalue,int paramenum);
75 void FindParam(int** pvalues,int* psize,int paramenum);
76 void GetDofList(int** pdoflist,int approximation_enum,int setenum);
77 void GetDofListVelocity(int** pdoflist,int setenum);
78 void GetDofListPressure(int** pdoflist,int setenum);
79 Input* GetInput(int inputenum);
80 void GetInputListOnNodes(IssmDouble* pvalue,int enumtype);
81 void GetInputListOnNodes(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue);
82 void GetInputListOnNodesVelocity(IssmDouble* pvalue,int enumtype);
83 void GetInputListOnVertices(IssmDouble* pvalue,int enumtype);
84 void GetInputListOnVertices(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue);
85 void GetInputValue(bool* pvalue,int enum_type);
86 void GetInputValue(int* pvalue,int enum_type);
87 void GetInputValue(IssmDouble* pvalue,int enum_type);
88 void GetInputValue(IssmDouble* pvalue,Gauss* gauss,int enum_type);
89 IssmDouble GetMaterialParameter(int enum_in);
90 void GetNodesSidList(int* sidlist);
91 void GetNodesLidList(int* lidlist);
92 void GetPhi(IssmDouble* phi, IssmDouble* epsilon, IssmDouble viscosity);
93 void GetVectorFromInputs(Vector<IssmDouble>* vector, int name_enum);
94 void GetVertexPidList(int* pidlist);
95 void GetVerticesCoordinates(IssmDouble** xyz_list);
96 void GetVerticesSidList(int* sidlist);
97 void GetVerticesConnectivityList(int* connectivitylist);
98 IssmDouble GetXcoord(IssmDouble* xyz_list,Gauss* gauss);
99 IssmDouble GetYcoord(IssmDouble* xyz_list,Gauss* gauss);
100 IssmDouble GetZcoord(IssmDouble* xyz_list,Gauss* gauss);
101 void GradientIndexing(int* indexing,int control_index);
102 bool HasNodeOnBase();
103 bool HasNodeOnSurface();
104 int Id();
105 int Sid();
106 void InputChangeName(int enum_type,int enum_type_old);
107 void InputCreate(IssmDouble* vector,IoModel* iomodel,int M,int N,int vector_type,int vector_enum,int code);
108 void InputDuplicate(int original_enum,int new_enum);
109 void InputUpdateFromConstant(IssmDouble constant, int name);
110 void InputUpdateFromConstant(int constant, int name);
111 void InputUpdateFromConstant(bool constant, int name);
112 bool IsIceInElement();
113 bool IsInput(int name);
114 bool IsFloating();
115 void LinearFloatingiceMeltingRate();
116 ElementVector* NewElementVector(int approximation_enum=NoneApproximationEnum);
117 ElementMatrix* NewElementMatrix(int approximation_enum=NoneApproximationEnum);
118 ElementMatrix* NewElementMatrixCoupling(int number_nodes,int approximation_enum=NoneApproximationEnum);
119 IssmDouble PureIceEnthalpy(IssmDouble pressure);
120 void ResultInterpolation(int* pinterpolation,int*nodesperelement,int output_enum);
121 void ResultToVector(Vector<IssmDouble>* vector,int output_enum);
122 void ResultToPatch(IssmDouble* values,int nodesperelement,int output_enum);
123 void SetwiseNodeConnectivity(int* d_nz,int* o_nz,Node* node,bool* flags,int* flagsindices,int set1_enum,int set2_enum);
124 void StrainRateSSA(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
125 void StrainRateSSA1d(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input);
126 void StrainRateHO(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
127 void StrainRateHO2dvertical(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
128 void StrainRateFS(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
129 IssmDouble TMeltingPoint(IssmDouble pressure);
130 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,int cs_enum);
131 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int cs_enum);
132 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int* cs_array);
133 void TransformLoadVectorCoord(ElementVector* pe,int cs_enum);
134 void TransformLoadVectorCoord(ElementVector* pe,int* cs_array);
135 void TransformLoadVectorCoord(ElementVector* pe,Node** nodes,int numnodes,int cs_enum);
136 void TransformLoadVectorCoord(ElementVector* pe,Node** nodes,int numnodes,int* cs_array);
137 void TransformSolutionCoord(IssmDouble* solution,int cs_enum);
138 void TransformSolutionCoord(IssmDouble* solution,int* cs_array);
139 void TransformSolutionCoord(IssmDouble* solution,int numnodes,int cs_enum);
140 void TransformSolutionCoord(IssmDouble* solution,int numnodes,int* cs_array);
141 void TransformSolutionCoord(IssmDouble* solution,Node** nodes,int numnodes,int cs_enum);
142 void TransformSolutionCoord(IssmDouble* solution,Node** nodes,int numnodes,int* cs_array);
143 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int cs_enum);
144 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int* cs_array);
145 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int cs_enum);
146 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int* cs_array);
147 void ViscousHeatingCreateInput(void);
148 void ViscosityFS(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
149 void ViscosityHO(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
150 void ViscosityL1L2(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* surf);
151 void ViscositySSA(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
152 void ViscositySSADerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
153 void ViscosityHODerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
154 void ViscosityFSDerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
155 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int transformenum){_error_("not implemented yet");};/*Tiling only*/
156 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int* transformenum_list){_error_("not implemented yet");};/*Tiling only*/
157 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int* transformenum_list){_error_("not implemented yet");};/*Tiling only*/
158
159 /*Virtual functions*/
160 virtual void AddBasalInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
161 virtual void AddInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
162 virtual IssmDouble CharacteristicLength(void)=0;
163 virtual void Configure(Elements* elements,Loads* loads,Nodes* nodes,Vertices* vertices,Materials* materials,Parameters* parameters)=0;
164 virtual void SetCurrentConfiguration(Elements* elements,Loads* loads,Nodes* nodes,Materials* materials,Parameters* parameters)=0;
165 virtual void ElementSizes(IssmDouble* phx,IssmDouble* phy,IssmDouble* phz)=0;
166
167 virtual int FiniteElement(void)=0;
168 virtual IssmDouble MinEdgeLength(IssmDouble* xyz_list)=0;
169 virtual void NodalFunctions(IssmDouble* basis,Gauss* gauss)=0;
170 virtual void NodalFunctionsP1(IssmDouble* basis,Gauss* gauss)=0;
171 virtual void NodalFunctionsVelocity(IssmDouble* basis, Gauss* gauss)=0;
172 virtual void NodalFunctionsPressure(IssmDouble* basis, Gauss* gauss)=0;
173 virtual void NodalFunctionsTensor(IssmDouble* basis, Gauss* gauss)=0;
174 virtual void NodalFunctionsDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
175 virtual void NodalFunctionsP1Derivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
176 virtual void NodalFunctionsMINIDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
177 virtual void NodalFunctionsDerivativesVelocity(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
178 virtual void NormalSection(IssmDouble* normal,IssmDouble* xyz_list)=0;
179 virtual void NormalTop(IssmDouble* normal,IssmDouble* xyz_list)=0;
180 virtual void NormalBase(IssmDouble* normal,IssmDouble* xyz_list)=0;
181
182 virtual Element* GetUpperElement(void)=0;
183 virtual Element* GetBasalElement(void)=0;
184
185 virtual void JacobianDeterminant(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
186 virtual void JacobianDeterminantLine(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
187 virtual void JacobianDeterminantSurface(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
188 virtual void JacobianDeterminantBase(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
189 virtual void JacobianDeterminantTop(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
190 virtual void GetSolutionFromInputsOneDof(Vector<IssmDouble>* solution,int solutionenum)=0;
191 virtual int GetNodeIndex(Node* node)=0;
192 virtual int GetNumberOfNodes(void)=0;
193 virtual int GetNumberOfVertices(void)=0;
194
195 virtual bool IsNodeOnShelfFromFlags(IssmDouble* flags)=0;
196 virtual bool IsOnBase()=0;
197 virtual bool IsOnSurface()=0;
198 virtual void GetGroundedPart(int* point1,IssmDouble* fraction1,IssmDouble* fraction2, bool* mainlyfloating)=0;
199 virtual IssmDouble GetGroundedPortion(IssmDouble* xyz_list)=0;
200 virtual void GetInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
201 virtual Node* GetNode(int node_number)=0;
202 virtual void GetVerticesCoordinatesBase(IssmDouble** xyz_list)=0;
203 virtual void GetVerticesCoordinatesTop(IssmDouble** xyz_list)=0;
204
205 virtual int GetElementType(void)=0;
206
207 virtual IssmDouble SurfaceArea(void)=0;
208 virtual void InputDepthAverageAtBase(int enum_type,int average_enum_type)=0;
209 virtual void ComputeSigmaNN(void)=0;
210 virtual void ComputeBasalStress(Vector<IssmDouble>* sigma_b)=0;
211 virtual void ComputeStrainRate()=0;
212 virtual void ComputeStrainRate(Vector<IssmDouble>* eps)=0;
213 virtual void ComputeStressTensor(void)=0;
214 virtual void ComputeDeviatoricStressTensor(void)=0;
215
216 virtual void Update(int index, IoModel* iomodel,int analysis_counter,int analysis_type,int finite_element)=0;
217 virtual void InputExtrude(int input_enum)=0;
218 virtual void InputUpdateFromSolutionOneDofCollapsed(IssmDouble* solution,int inputenum)=0;
219 virtual void InputUpdateFromSolutionOneDof(IssmDouble* solution,int inputenum)=0;
220
221 virtual int NodalValue(IssmDouble* pvalue, int index, int natureofdataenum)=0;
222 virtual int NumberofNodesVelocity(void)=0;
223 virtual int NumberofNodesPressure(void)=0;
224 virtual Gauss* NewGauss(void)=0;
225 virtual Gauss* NewGauss(int order)=0;
226 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order)=0;
227 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order_horiz,int order_vert)=0;
228 virtual Gauss* NewGauss(int point1,IssmDouble fraction1,IssmDouble fraction2,bool mainlyfloating,int order)=0;
229 virtual Gauss* NewGaussBase(int order)=0;
230 virtual Gauss* NewGaussLine(int vertex1,int vertex2,int order)=0;
231 virtual Gauss* NewGaussTop(int order)=0;
232
233 virtual void InputScale(int enum_type,IssmDouble scale_factor)=0;
234 virtual IssmDouble TimeAdapt()=0;
235 virtual void PositiveDegreeDay(IssmDouble* pdds,IssmDouble* pds,IssmDouble signorm)=0;
236 virtual void Delta18oParameterization(void)=0;
237 virtual Element* SpawnBasalElement(void)=0;
238 virtual Element* SpawnTopElement(void)=0;
239 virtual void ReduceMatrices(ElementMatrix* Ke,ElementVector* pe)=0;
240 virtual void ResetFSBasalBoundaryCondition()=0;
241 virtual void SetTemporaryElementType(int element_type_in)=0;
242 virtual IssmDouble StabilizationParameter(IssmDouble u, IssmDouble v, IssmDouble w, IssmDouble diameter, IssmDouble kappa)=0;
243 virtual void ValueP1OnGauss(IssmDouble* pvalue,IssmDouble* values,Gauss* gauss)=0;
244 virtual void ValueP1DerivativesOnGauss(IssmDouble* dvalue,IssmDouble* values,IssmDouble* xyz_list,Gauss* gauss)=0;
245 virtual void ViscousHeating(IssmDouble* pphi,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input)=0;
246
247 virtual int VelocityInterpolation()=0;
248 virtual int PressureInterpolation()=0;
249 virtual int TensorInterpolation()=0;
250 virtual bool IsZeroLevelset(int levelset_enum)=0;
251 virtual bool IsIcefront(void)=0;
252 virtual bool IsFaceOnBoundary(void)=0;
253 virtual void ZeroLevelsetCoordinates(IssmDouble** pxyz_zero,IssmDouble* xyz_list,int levelsetenum)=0;
254 virtual void GetIcefrontCoordinates(IssmDouble** pxyz_front,IssmDouble* xyz_list,int levelsetenum)=0;
255
256 virtual void AverageOntoPartition(Vector<IssmDouble>* partition_contributions,Vector<IssmDouble>* partition_areas,IssmDouble* vertex_response,IssmDouble* qmu_part)=0;
257 virtual void MinVel(IssmDouble* pminvel)=0;
258 virtual void MaxVel(IssmDouble* pmaxvel)=0;
259 virtual void MinVx(IssmDouble* pminvx)=0;
260 virtual void MaxVx(IssmDouble* pmaxvx)=0;
261 virtual void MaxAbsVx(IssmDouble* pmaxabsvx)=0;
262 virtual void MinVy(IssmDouble* pminvy)=0;
263 virtual void MaxVy(IssmDouble* pmaxvy)=0;
264 virtual void MaxAbsVy(IssmDouble* pmaxabsvy)=0;
265 virtual void MinVz(IssmDouble* pminvz)=0;
266 virtual void MaxVz(IssmDouble* pmaxvz)=0;
267 virtual void MaxAbsVz(IssmDouble* pmaxabsvz)=0;
268 virtual IssmDouble MassFlux(IssmDouble* segment)=0;
269 virtual IssmDouble MassFlux(IssmDouble x1,IssmDouble y1, IssmDouble x2, IssmDouble y2,int segment_id)=0;
270 virtual void ElementResponse(IssmDouble* presponse,int response_enum)=0;
271 virtual IssmDouble IceVolume(void)=0;
272 virtual IssmDouble IceVolumeAboveFloatation(void)=0;
273 virtual IssmDouble TotalSmb(void)=0;
274 virtual IssmDouble Misfit(int modelenum,int observationenum,int weightsenum)=0;
275 virtual IssmDouble MisfitArea(int weightsenum)=0;
276 virtual int VertexConnectivity(int vertexindex)=0;
277 virtual void VerticalSegmentIndices(int** pindices,int* pnumseg)=0;
278
279 #ifdef _HAVE_GIA_
280 virtual void GiaDeflection(Vector<IssmDouble>* wg,Vector<IssmDouble>* dwgdt,IssmDouble* x,IssmDouble* y)=0;
281 #endif
282
283 virtual void ControlInputGetGradient(Vector<IssmDouble>* gradient,int enum_type,int control_index)=0;
284 virtual void ControlInputSetGradient(IssmDouble* gradient,int enum_type,int control_index)=0;
285 virtual void ControlInputScaleGradient(int enum_type, IssmDouble scale)=0;
286 virtual void ControlToVectors(Vector<IssmPDouble>* vector_control, Vector<IssmPDouble>* vector_gradient,int control_enum)=0;
287 virtual void GetVectorFromControlInputs(Vector<IssmDouble>* gradient,int control_enum,int control_index,const char* data)=0;
288 virtual void SetControlInputsFromVector(IssmDouble* vector,int control_enum,int control_index)=0;
289 virtual void InputControlUpdate(IssmDouble scalar,bool save_parameter)=0;
290
291 virtual void UpdateConstraintsExtrudeFromBase(void)=0;
292 virtual void UpdateConstraintsExtrudeFromTop(void)=0;
293
294 virtual void MigrateGroundingLine(IssmDouble* sheet_ungrounding)=0;
295 virtual void FSContactMigration(Vector<IssmDouble>* vertexgrounded,Vector<IssmDouble>* vertexfloating)=0;
296 virtual void PotentialUngrounding(Vector<IssmDouble>* potential_sheet_ungrounding)=0;
297 virtual int UpdatePotentialUngrounding(IssmDouble* potential_sheet_ungrounding,Vector<IssmDouble>* vec_nodes_on_iceshelf,IssmDouble* nodes_on_iceshelf)=0;
298
299};
300#endif
Note: See TracBrowser for help on using the repository browser.