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

Last change on this file since 17975 was 17975, checked in by Mathieu Morlighem, 11 years ago

CHG: moving misfits to modules

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