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

Last change on this file since 16787 was 16787, checked in by Eric.Larour, 11 years ago

CHG: new Misfit output definition. Adapted ModelProcessorx and CreateOutputDefinitions accordingly.
Created enums that go with it. Also create misfit.m class to setup this specific output definition.

File size: 9.6 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 "../Update.h"
14
15class DataSet;
16class Parameters;
17class Elements;
18class Loads;
19class Node;
20class Nodes;
21class Vertices;
22class Materials;
23class Matpar;
24class Input;
25class Gauss;
26template <class doublematrix> class Matrix;
27template <class doubletype> class Vector;
28
29#include "../../toolkits/toolkits.h"
30/*}}}*/
31
32class Element: public Object,public Update{
33
34 public:
35
36 virtual ~Element(){};
37
38 virtual void Configure(Elements* elements,Loads* loads,Nodes* nodes,Vertices* vertices,Materials* materials,Parameters* parameters)=0;
39 virtual void SetCurrentConfiguration(Elements* elements,Loads* loads,Nodes* nodes,Materials* materials,Parameters* parameters)=0;
40 virtual void SetwiseNodeConnectivity(int* d_nz,int* o_nz,Node* node,bool* flags,int* flagsindices,int set1_enum,int set2_enum)=0;
41 virtual void AddBasalInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
42 virtual void AddInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
43 virtual void AddMaterialInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
44 virtual void CreateKMatrix(Matrix<IssmDouble>* Kff, Matrix<IssmDouble>* Kfs)=0;
45 virtual void CreateDVector(Vector<IssmDouble>* df)=0;
46 virtual void CreatePVector(Vector<IssmDouble>* pf)=0;
47 virtual void CreateJacobianMatrix(Matrix<IssmDouble>* Jff)=0;
48 virtual void DeleteMaterials(void)=0;
49 virtual void EnthalpyToThermal(IssmDouble* ptemperature,IssmDouble* pwaterfraction,IssmDouble enthalpy,IssmDouble pressure)=0;
50 virtual void FindParam(int* pvalue,int paramenum)=0;
51 virtual void FindParam(IssmDouble* pvalue,int paramenum)=0;
52 virtual int FiniteElement(void)=0;
53 virtual IssmDouble GetMaterialParameter(int enum_in)=0;
54 virtual void TransformSolutionCoord(IssmDouble* values,int transformenum)=0;
55 virtual void TransformSolutionCoord(IssmDouble* values,int* transformenum_list)=0;
56 virtual void TransformSolutionCoord(IssmDouble* values,int numnodes,int transformenum)=0;
57 virtual void TransformSolutionCoord(IssmDouble* values,int numnodes,int* transformenum_list)=0;
58 virtual Element* GetBasalElement(void)=0;
59 virtual void GetDofList(int** pdoflist,int approximation_enum,int setenum)=0;
60 virtual void GetDofListVelocity(int** pdoflist,int setenum)=0;
61 virtual void GetDofListPressure(int** pdoflist,int setenum)=0;
62 virtual void GetSolutionFromInputsOneDof(Vector<IssmDouble>* solution,int solutionenum)=0;
63 virtual int GetNodeIndex(Node* node)=0;
64 virtual int GetNumberOfNodes(void)=0;
65 virtual int GetNumberOfNodesVelocity(void)=0;
66 virtual int GetNumberOfNodesPressure(void)=0;
67 virtual int GetNumberOfVertices(void)=0;
68 virtual void GetNodesSidList(int* sidlist)=0;
69 virtual void GetNodesLidList(int* sidlist)=0;
70
71 virtual int Sid()=0;
72 virtual bool IsFloating()=0;
73 virtual bool IsNodeOnShelfFromFlags(IssmDouble* flags)=0;
74 virtual bool IsOnBed()=0;
75 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype)=0;
76 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
77 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype)=0;
78 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
79 virtual Input* GetInput(int inputenum)=0;
80 virtual void GetInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
81 virtual void GetInputValue(bool* pvalue,int enum_type)=0;
82 virtual void GetInputValue(int* pvalue,int enum_type)=0;
83 virtual void GetInputValue(IssmDouble* pvalue,int enum_type)=0;
84 virtual void GetVerticesCoordinates(IssmDouble** xyz_list)=0;
85 virtual void GetMaterialInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
86
87 virtual IssmDouble SurfaceArea(void)=0;
88 virtual void InputDepthAverageAtBase(int enum_type,int average_enum_type,int object_enum)=0;
89 virtual void InputChangeName(int enum_type,int enum_type_old)=0;
90 virtual void ComputeBasalStress(Vector<IssmDouble>* sigma_b)=0;
91 virtual void ComputeStrainRate(Vector<IssmDouble>* eps)=0;
92 virtual void ResultInterpolation(int* pinterpolation,int output_enum)=0;
93 virtual void ResultToVector(Vector<IssmDouble>* vector,int output_enum)=0;
94 virtual void Update(int index, IoModel* iomodel,int analysis_counter,int analysis_type,int finite_element)=0;
95 virtual void InputDuplicate(int original_enum,int new_enum)=0;
96 virtual void InputCreate(IssmDouble* vector,IoModel* iomodel,int M,int N,int vector_type,int vector_enum,int code)=0;
97 virtual void InputUpdateFromSolutionOneDofCollapsed(IssmDouble* solution,int inputenum)=0;
98 virtual void InputUpdateFromSolutionOneDof(IssmDouble* solution,int inputenum)=0;
99
100 virtual int NodalValue(IssmDouble* pvalue, int index, int natureofdataenum)=0;
101 virtual int NumberofNodesVelocity(void)=0;
102 virtual int NumberofNodesPressure(void)=0;
103 virtual Gauss* NewGauss(void)=0;
104 virtual void InputScale(int enum_type,IssmDouble scale_factor)=0;
105 virtual void GetVectorFromInputs(Vector<IssmDouble>* vector, int name_enum)=0;
106 virtual IssmDouble TimeAdapt()=0;
107 virtual void PositiveDegreeDay(IssmDouble* pdds,IssmDouble* pds,IssmDouble signorm)=0;
108 virtual void Delta18oParameterization(void)=0;
109 virtual void SmbGradients(void)=0;
110 virtual Element* SpawnBasalElement(void)=0;
111 virtual IssmDouble TMeltingPoint(IssmDouble pressure)=0;
112 virtual void ResetCoordinateSystem()=0;
113 virtual int VelocityInterpolation()=0;
114 virtual int PressureInterpolation()=0;
115
116 #ifdef _HAVE_RESPONSES_
117 virtual void AverageOntoPartition(Vector<IssmDouble>* partition_contributions,Vector<IssmDouble>* partition_areas,IssmDouble* vertex_response,IssmDouble* qmu_part)=0;
118 virtual void MinVel(IssmDouble* pminvel)=0;
119 virtual void MaxVel(IssmDouble* pmaxvel)=0;
120 virtual void MinVx(IssmDouble* pminvx)=0;
121 virtual void MaxVx(IssmDouble* pmaxvx)=0;
122 virtual void MaxAbsVx(IssmDouble* pmaxabsvx)=0;
123 virtual void MinVy(IssmDouble* pminvy)=0;
124 virtual void MaxVy(IssmDouble* pmaxvy)=0;
125 virtual void MaxAbsVy(IssmDouble* pmaxabsvy)=0;
126 virtual void MinVz(IssmDouble* pminvz)=0;
127 virtual void MaxVz(IssmDouble* pmaxvz)=0;
128 virtual void MaxAbsVz(IssmDouble* pmaxabsvz)=0;
129 virtual IssmDouble MassFlux(IssmDouble* segment)=0;
130 virtual IssmDouble MassFlux(IssmDouble x1,IssmDouble y1, IssmDouble x2, IssmDouble y2,int segment_id)=0;
131 virtual void ElementResponse(IssmDouble* presponse,int response_enum)=0;
132 virtual IssmDouble IceVolume(void)=0;
133 virtual IssmDouble IceVolumeAboveFloatation(void)=0;
134 virtual IssmDouble TotalSmb(void)=0;
135 virtual IssmDouble Misfit(int modelenum,int observationenum,int weightsenum)=0;
136 #endif
137
138 #ifdef _HAVE_GIA_
139 virtual void GiaDeflection(Vector<IssmDouble>* wg,Vector<IssmDouble>* dwgdt,IssmDouble* x,IssmDouble* y)=0;
140 #endif
141
142 #ifdef _HAVE_CONTROL_
143 virtual void Gradj(Vector<IssmDouble>* gradient,int control_type,int control_index)=0;
144 virtual IssmDouble ThicknessAbsMisfit(void)=0;
145 virtual IssmDouble SurfaceAbsVelMisfit(void)=0;
146 virtual IssmDouble SurfaceRelVelMisfit(void)=0;
147 virtual IssmDouble SurfaceLogVelMisfit(void)=0;
148 virtual IssmDouble SurfaceLogVxVyMisfit(void)=0;
149 virtual IssmDouble SurfaceAverageVelMisfit(void)=0;
150 virtual IssmDouble ThicknessAbsGradient(void)=0;
151 virtual IssmDouble ThicknessAlongGradient(void)=0;
152 virtual IssmDouble ThicknessAcrossGradient(void)=0;
153 virtual IssmDouble BalancethicknessMisfit(void)=0;
154 virtual IssmDouble RheologyBbarAbsGradient(void)=0;
155 virtual IssmDouble DragCoefficientAbsGradient(void)=0;
156 virtual void ControlInputGetGradient(Vector<IssmDouble>* gradient,int enum_type,int control_index)=0;
157 virtual void ControlInputSetGradient(IssmDouble* gradient,int enum_type,int control_index)=0;
158 virtual void ControlInputScaleGradient(int enum_type, IssmDouble scale)=0;
159 virtual void ControlToVectors(Vector<IssmPDouble>* vector_control, Vector<IssmPDouble>* vector_gradient,int control_enum)=0;
160 virtual void GetVectorFromControlInputs(Vector<IssmDouble>* gradient,int control_enum,int control_index,const char* data)=0;
161 virtual void SetControlInputsFromVector(IssmDouble* vector,int control_enum,int control_index)=0;
162 virtual void InputControlUpdate(IssmDouble scalar,bool save_parameter)=0;
163 #endif
164
165 virtual void UpdateConstraintsExtrudeFromBase(void)=0;
166 virtual void UpdateConstraintsExtrudeFromTop(void)=0;
167
168 #ifdef _HAVE_THERMAL_
169 virtual void UpdateBasalConstraintsEnthalpy(void)=0;
170 virtual void ComputeBasalMeltingrate(void)=0;
171 virtual void DrainWaterfraction(void)=0;
172 #endif
173
174 #ifdef _HAVE_HYDROLOGY_
175 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, Node* innode)=0;
176 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, int index)=0;
177 virtual void GetHydrologyTransfer(Vector<IssmDouble>* transfer)=0;
178 virtual void HydrologyEPLGetMask(Vector<IssmDouble>* mask)=0;
179 virtual void HydrologyEPLGetActive(Vector<IssmDouble>* active)=0;
180 virtual void ComputeEPLThickness(void)=0;
181 virtual void UpdateConstraintsL2ProjectionEPL(void)=0;
182 #endif
183
184 #ifdef _HAVE_GROUNDINGLINE_
185 virtual void MigrateGroundingLine(IssmDouble* sheet_ungrounding)=0;
186 virtual void PotentialUngrounding(Vector<IssmDouble>* potential_sheet_ungrounding)=0;
187 virtual int UpdatePotentialUngrounding(IssmDouble* potential_sheet_ungrounding,Vector<IssmDouble>* vec_nodes_on_iceshelf,IssmDouble* nodes_on_iceshelf)=0;
188 #endif
189
190};
191#endif
Note: See TracBrowser for help on using the repository browser.