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

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

CHG: KMatric coupling HO viscous
File size: 16.4 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 bool IsFloating();
64 void StrainRateSSA(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
65 void StrainRateHO(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
66 void StrainRateFS(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
67 IssmDouble TMeltingPoint(IssmDouble pressure);
68 void ViscosityFS(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
69 void ViscosityHO(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
70 void ViscosityL1L2(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* surf);
71 void ViscositySSA(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
72 void ViscositySSADerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
73 void ViscosityHODerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
74 void ViscosityFSDerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
75 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,int transformenum);
76 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes_list,int numnodes,int* transformenum_list);
77 void TransformLoadVectorCoord(ElementVector* pe,int transformenum);
78 void TransformLoadVectorCoord(ElementVector* pe,int* transformenum_list);
79 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int transformenum){_error_("not implemented yet");}; /*Tiling only*/
80 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int* transformenum_list){_error_("not implemented yet");}; /*Tiling only*/
81 void TransformLoadVectorCoord(ElementVector* pe,Node** nodes_list,int numnodes,int* transformenum_list);
82 void TransformSolutionCoord(IssmDouble* values,int transformenum);
83 void TransformSolutionCoord(IssmDouble* values,int* transformenum_list);
84 void TransformSolutionCoord(IssmDouble* values,int numnodes,int transformenum);
85 void TransformSolutionCoord(IssmDouble* values,int numnodes,int* transformenum_list);
86 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int transformenum);
87 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int* transformenum_list);
88 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int transformenum);
89 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int* transformenum_list){_error_("not implemented yet");}; /*Tiling only*/
90 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes_list,int numnodes,int* transformenum_list);
91
92 /*Virtual functions*/
93 virtual void AddBasalInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
94 virtual void AddInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
95 virtual void AddMaterialInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
96 virtual IssmDouble CharacteristicLength(void)=0;
97 virtual void Configure(Elements* elements,Loads* loads,Nodes* nodes,Vertices* vertices,Materials* materials,Parameters* parameters)=0;
98 virtual void SetCurrentConfiguration(Elements* elements,Loads* loads,Nodes* nodes,Materials* materials,Parameters* parameters)=0;
99 virtual void SetwiseNodeConnectivity(int* d_nz,int* o_nz,Node* node,bool* flags,int* flagsindices,int set1_enum,int set2_enum)=0;
100 virtual ElementMatrix* CreateKMatrix(void)=0;
101 virtual ElementVector* CreatePVector(void)=0;
102 virtual void CreateDVector(Vector<IssmDouble>* df)=0;
103 virtual void CreateJacobianMatrix(Matrix<IssmDouble>* Jff)=0;
104 virtual void ElementSizes(IssmDouble* phx,IssmDouble* phy,IssmDouble* phz)=0;
105 virtual void EnthalpyToThermal(IssmDouble* ptemperature,IssmDouble* pwaterfraction,IssmDouble enthalpy,IssmDouble pressure)=0;
106 virtual IssmDouble EnthalpyDiffusionParameter(IssmDouble enthalpy,IssmDouble pressure)=0;
107 virtual IssmDouble EnthalpyDiffusionParameterVolume(int numvertices,IssmDouble* enthalpy,IssmDouble* pressure)=0;
108 virtual int FiniteElement(void)=0;
109 virtual IssmDouble MinEdgeLength(IssmDouble* xyz_list)=0;
110 virtual void NodalFunctions(IssmDouble* basis,Gauss* gauss)=0;
111 virtual void NodalFunctionsP1(IssmDouble* basis,Gauss* gauss)=0;
112 virtual void NodalFunctionsVelocity(IssmDouble* basis, Gauss* gauss)=0;
113 virtual void NodalFunctionsPressure(IssmDouble* basis, Gauss* gauss)=0;
114 virtual void NodalFunctionsDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
115 virtual void NodalFunctionsP1Derivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
116 virtual void NodalFunctionsDerivativesVelocity(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
117 virtual void NormalSection(IssmDouble* normal,IssmDouble* xyz_list)=0;
118 virtual void NormalTop(IssmDouble* normal,IssmDouble* xyz_list)=0;
119 virtual void NormalBase(IssmDouble* normal,IssmDouble* xyz_list)=0;
120 virtual IssmDouble PureIceEnthalpy(IssmDouble pressure)=0;
121
122 virtual Element* GetBasalElement(void)=0;
123 virtual void GetDofList(int** pdoflist,int approximation_enum,int setenum)=0;
124 virtual void GetDofListVelocity(int** pdoflist,int setenum)=0;
125 virtual void GetDofListPressure(int** pdoflist,int setenum)=0;
126 virtual void JacobianDeterminant(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
127 virtual void JacobianDeterminantLine(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
128 virtual void JacobianDeterminantSurface(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
129 virtual void JacobianDeterminantBase(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
130 virtual void JacobianDeterminantTop(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
131 virtual void GetSolutionFromInputsOneDof(Vector<IssmDouble>* solution,int solutionenum)=0;
132 virtual int GetNodeIndex(Node* node)=0;
133 virtual int GetNumberOfNodes(void)=0;
134 virtual int GetNumberOfNodesVelocity(void)=0;
135 virtual int GetNumberOfNodesPressure(void)=0;
136 virtual int GetNumberOfVertices(void)=0;
137 virtual void GetNodesSidList(int* sidlist)=0;
138 virtual void GetNodesLidList(int* sidlist)=0;
139
140 virtual int Sid()=0;
141 virtual bool IsNodeOnShelfFromFlags(IssmDouble* flags)=0;
142 virtual bool IsOnBed()=0;
143 virtual bool IsOnSurface()=0;
144 virtual void GetGroundedPart(int* point1,IssmDouble* fraction1,IssmDouble* fraction2, bool* mainlyfloating)=0;
145 virtual IssmDouble GetGroundedPortion(IssmDouble* xyz_list)=0;
146 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype)=0;
147 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
148 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype)=0;
149 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
150 virtual Input* GetMaterialInput(int inputenum)=0;
151 virtual void GetInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
152 virtual void GetInputValue(bool* pvalue,int enum_type)=0;
153 virtual void GetInputValue(int* pvalue,int enum_type)=0;
154 virtual void GetInputValue(IssmDouble* pvalue,int enum_type)=0;
155 virtual void GetInputValue(IssmDouble* pvalue,Gauss* gauss,int enum_type)=0;
156 virtual Node* GetNode(int node_number)=0;
157 virtual void GetVerticesCoordinates(IssmDouble** xyz_list)=0;
158 virtual void GetVerticesCoordinatesBase(IssmDouble** xyz_list)=0;
159 virtual void GetVerticesCoordinatesTop(IssmDouble** xyz_list)=0;
160 virtual IssmDouble GetZcoord(Gauss* gauss)=0;
161 virtual IssmDouble GetYcoord(Gauss* gauss)=0;
162 virtual void GetMaterialInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
163
164 virtual IssmDouble SurfaceArea(void)=0;
165 virtual void InputDepthAverageAtBase(int enum_type,int average_enum_type,int object_enum)=0;
166 virtual void InputChangeName(int enum_type,int enum_type_old)=0;
167 virtual void ComputeBasalStress(Vector<IssmDouble>* sigma_b)=0;
168 virtual void ComputeStrainRate(Vector<IssmDouble>* eps)=0;
169 virtual void ComputeStressTensor(void)=0;
170 virtual void ResultInterpolation(int* pinterpolation,int output_enum)=0;
171 virtual void ResultToVector(Vector<IssmDouble>* vector,int output_enum)=0;
172 virtual void Update(int index, IoModel* iomodel,int analysis_counter,int analysis_type,int finite_element)=0;
173 virtual void InputDuplicate(int original_enum,int new_enum)=0;
174 virtual void InputCreate(IssmDouble* vector,IoModel* iomodel,int M,int N,int vector_type,int vector_enum,int code)=0;
175 virtual void InputUpdateFromSolutionOneDofCollapsed(IssmDouble* solution,int inputenum)=0;
176 virtual void InputUpdateFromSolutionOneDof(IssmDouble* solution,int inputenum)=0;
177
178 virtual int NodalValue(IssmDouble* pvalue, int index, int natureofdataenum)=0;
179 virtual int NumberofNodesVelocity(void)=0;
180 virtual int NumberofNodesPressure(void)=0;
181 virtual Gauss* NewGauss(void)=0;
182 virtual Gauss* NewGauss(int order)=0;
183 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order)=0;
184 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order_horiz,int order_vert)=0;
185 virtual Gauss* NewGauss(int point1,IssmDouble fraction1,IssmDouble fraction2,bool mainlyfloating,int order)=0;
186 virtual Gauss* NewGaussBase(int order)=0;
187 virtual Gauss* NewGaussLine(int vertex1,int vertex2,int order)=0;
188 virtual Gauss* NewGaussTop(int order)=0;
189 virtual ElementVector* NewElementVector(int approximation_enum=NoneApproximationEnum)=0;
190 virtual ElementMatrix* NewElementMatrix(int approximation_enum=NoneApproximationEnum)=0;
191 virtual void InputScale(int enum_type,IssmDouble scale_factor)=0;
192 virtual void GetVectorFromInputs(Vector<IssmDouble>* vector, int name_enum)=0;
193 virtual IssmDouble TimeAdapt()=0;
194 virtual void PositiveDegreeDay(IssmDouble* pdds,IssmDouble* pds,IssmDouble signorm)=0;
195 virtual void Delta18oParameterization(void)=0;
196 virtual void SmbGradients(void)=0;
197 virtual Element* SpawnBasalElement(void)=0;
198 virtual void ReduceMatrices(ElementMatrix* Ke,ElementVector* pe)=0;
199 virtual void ResetCoordinateSystem()=0;
200 virtual void SetTemporaryElementType(int element_type_in)=0;
201 virtual IssmDouble StabilizationParameter(IssmDouble u, IssmDouble v, IssmDouble w, IssmDouble diameter, IssmDouble kappa)=0;
202 virtual void ValueP1OnGauss(IssmDouble* pvalue,IssmDouble* values,Gauss* gauss)=0;
203 virtual void ValueP1DerivativesOnGauss(IssmDouble* dvalue,IssmDouble* values,IssmDouble* xyz_list,Gauss* gauss)=0;
204 virtual void ViscousHeating(IssmDouble* pphi,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input)=0;
205
206 virtual int VelocityInterpolation()=0;
207 virtual int PressureInterpolation()=0;
208 virtual bool IsZeroLevelset(int levelset_enum)=0;
209 virtual void ZeroLevelsetCoordinates(IssmDouble** pxyz_zero,IssmDouble* xyz_list,int levelsetenum)=0;
210
211 #ifdef _HAVE_RESPONSES_
212 virtual void AverageOntoPartition(Vector<IssmDouble>* partition_contributions,Vector<IssmDouble>* partition_areas,IssmDouble* vertex_response,IssmDouble* qmu_part)=0;
213 virtual void MinVel(IssmDouble* pminvel)=0;
214 virtual void MaxVel(IssmDouble* pmaxvel)=0;
215 virtual void MinVx(IssmDouble* pminvx)=0;
216 virtual void MaxVx(IssmDouble* pmaxvx)=0;
217 virtual void MaxAbsVx(IssmDouble* pmaxabsvx)=0;
218 virtual void MinVy(IssmDouble* pminvy)=0;
219 virtual void MaxVy(IssmDouble* pmaxvy)=0;
220 virtual void MaxAbsVy(IssmDouble* pmaxabsvy)=0;
221 virtual void MinVz(IssmDouble* pminvz)=0;
222 virtual void MaxVz(IssmDouble* pmaxvz)=0;
223 virtual void MaxAbsVz(IssmDouble* pmaxabsvz)=0;
224 virtual IssmDouble MassFlux(IssmDouble* segment)=0;
225 virtual IssmDouble MassFlux(IssmDouble x1,IssmDouble y1, IssmDouble x2, IssmDouble y2,int segment_id)=0;
226 virtual void ElementResponse(IssmDouble* presponse,int response_enum)=0;
227 virtual IssmDouble IceVolume(void)=0;
228 virtual IssmDouble IceVolumeAboveFloatation(void)=0;
229 virtual IssmDouble TotalSmb(void)=0;
230 virtual IssmDouble Misfit(int modelenum,int observationenum,int weightsenum)=0;
231 virtual int VertexConnectivity(int vertexindex)=0;
232 virtual void VerticalSegmentIndices(int** pindices,int* pnumseg)=0;
233 #endif
234
235 #ifdef _HAVE_GIA_
236 virtual void GiaDeflection(Vector<IssmDouble>* wg,Vector<IssmDouble>* dwgdt,IssmDouble* x,IssmDouble* y)=0;
237 #endif
238
239 #ifdef _HAVE_CONTROL_
240 virtual void Gradj(Vector<IssmDouble>* gradient,int control_type,int control_index)=0;
241 virtual IssmDouble ThicknessAbsMisfit(void)=0;
242 virtual IssmDouble SurfaceAbsVelMisfit(void)=0;
243 virtual IssmDouble SurfaceRelVelMisfit(void)=0;
244 virtual IssmDouble SurfaceLogVelMisfit(void)=0;
245 virtual IssmDouble SurfaceLogVxVyMisfit(void)=0;
246 virtual IssmDouble SurfaceAverageVelMisfit(void)=0;
247 virtual IssmDouble ThicknessAbsGradient(void)=0;
248 virtual IssmDouble ThicknessAlongGradient(void)=0;
249 virtual IssmDouble ThicknessAcrossGradient(void)=0;
250 virtual IssmDouble BalancethicknessMisfit(void)=0;
251 virtual IssmDouble RheologyBbarAbsGradient(void)=0;
252 virtual IssmDouble DragCoefficientAbsGradient(void)=0;
253 virtual void ControlInputGetGradient(Vector<IssmDouble>* gradient,int enum_type,int control_index)=0;
254 virtual void ControlInputSetGradient(IssmDouble* gradient,int enum_type,int control_index)=0;
255 virtual void ControlInputScaleGradient(int enum_type, IssmDouble scale)=0;
256 virtual void ControlToVectors(Vector<IssmPDouble>* vector_control, Vector<IssmPDouble>* vector_gradient,int control_enum)=0;
257 virtual void GetVectorFromControlInputs(Vector<IssmDouble>* gradient,int control_enum,int control_index,const char* data)=0;
258 virtual void SetControlInputsFromVector(IssmDouble* vector,int control_enum,int control_index)=0;
259 virtual void InputControlUpdate(IssmDouble scalar,bool save_parameter)=0;
260 #endif
261
262 virtual void UpdateConstraintsExtrudeFromBase(void)=0;
263 virtual void UpdateConstraintsExtrudeFromTop(void)=0;
264
265 #ifdef _HAVE_THERMAL_
266 virtual void UpdateBasalConstraintsEnthalpy(void)=0;
267 virtual void ComputeBasalMeltingrate(void)=0;
268 virtual void DrainWaterfraction(IssmDouble* drainrate_element)=0;
269 #endif
270
271 #ifdef _HAVE_HYDROLOGY_
272 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, Node* innode)=0;
273 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, int index)=0;
274 virtual void GetHydrologyTransfer(Vector<IssmDouble>* transfer)=0;
275 virtual void HydrologyEPLGetMask(Vector<IssmDouble>* mask)=0;
276 virtual void HydrologyEPLGetActive(Vector<IssmDouble>* active)=0;
277 virtual void ComputeEPLThickness(void)=0;
278 #endif
279
280 #ifdef _HAVE_GROUNDINGLINE_
281 virtual void MigrateGroundingLine(IssmDouble* sheet_ungrounding)=0;
282 virtual void PotentialUngrounding(Vector<IssmDouble>* potential_sheet_ungrounding)=0;
283 virtual int UpdatePotentialUngrounding(IssmDouble* potential_sheet_ungrounding,Vector<IssmDouble>* vec_nodes_on_iceshelf,IssmDouble* nodes_on_iceshelf)=0;
284 #endif
285
286};
287#endif
Note: See TracBrowser for help on using the repository browser.