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

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

CHG: moved more stuff from Tria to Element.cpp
File size: 15.7 KB
RevLine 
[3683]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:*/
[12365]11/*{{{*/
[15067]12#include "../../datastructures/datastructures.h"
[16789]13#include "../../toolkits/toolkits.h"
[15012]14#include "../Update.h"
[3683]15class DataSet;
16class Parameters;
[16912]17class Parameter;
[14996]18class Elements;
19class Loads;
[16912]20class Nodes;
[14996]21class Node;
22class Vertices;
[16912]23class Vertex;
[14996]24class Materials;
[16912]25class Material;
[16693]26class Matpar;
[16912]27class Inputs;
[16675]28class Input;
29class Gauss;
[16799]30class ElementVector;
[13216]31template <class doublematrix> class Matrix;
32template <class doubletype> class Vector;
[16789]33class ElementMatrix;
34class ElementVector;
[3683]35/*}}}*/
36
[4244]37class Element: public Object,public Update{
[3683]38
[16910]39 public:
[16912]40 Inputs *inputs;
41 Node **nodes;
42 Vertex **vertices;
43 Material *material;
44 Matpar *matpar;
45 Parameters *parameters;
[16910]46
[3683]47 public:
[16910]48 /*Constructors/Destructores*/
49 Element();
50 ~Element();
[13623]51
[16910]52 /*Functions*/
[16913]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();
[16915]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);
[16914]67 IssmDouble TMeltingPoint(IssmDouble pressure);
[16915]68 void ViscosityFS(IssmDouble* pviscosity,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);
[13623]75
[16910]76 /*Virtual functions*/
[16912]77 virtual void AddBasalInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
78 virtual void AddInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
79 virtual void AddMaterialInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
[16832]80 virtual IssmDouble CharacteristicLength(void)=0;
[16912]81 virtual void Configure(Elements* elements,Loads* loads,Nodes* nodes,Vertices* vertices,Materials* materials,Parameters* parameters)=0;
82 virtual void SetCurrentConfiguration(Elements* elements,Loads* loads,Nodes* nodes,Materials* materials,Parameters* parameters)=0;
83 virtual void SetwiseNodeConnectivity(int* d_nz,int* o_nz,Node* node,bool* flags,int* flagsindices,int set1_enum,int set2_enum)=0;
[16789]84 virtual ElementMatrix* CreateKMatrix(void)=0;
[16913]85 virtual ElementVector* CreatePVector(void)=0;
[14435]86 virtual void CreateDVector(Vector<IssmDouble>* df)=0;
[13216]87 virtual void CreateJacobianMatrix(Matrix<IssmDouble>* Jff)=0;
[16840]88 virtual void ElementSizes(IssmDouble* phx,IssmDouble* phy,IssmDouble* phz)=0;
[16734]89 virtual void EnthalpyToThermal(IssmDouble* ptemperature,IssmDouble* pwaterfraction,IssmDouble enthalpy,IssmDouble pressure)=0;
[16812]90 virtual IssmDouble EnthalpyDiffusionParameter(IssmDouble enthalpy,IssmDouble pressure)=0;
91 virtual IssmDouble EnthalpyDiffusionParameterVolume(int numvertices,IssmDouble* enthalpy,IssmDouble* pressure)=0;
[16675]92 virtual int FiniteElement(void)=0;
[16810]93 virtual IssmDouble MinEdgeLength(IssmDouble* xyz_list)=0;
[16799]94 virtual void NodalFunctions(IssmDouble* basis,Gauss* gauss)=0;
[16831]95 virtual void NodalFunctionsVelocity(IssmDouble* basis, Gauss* gauss)=0;
96 virtual void NodalFunctionsPressure(IssmDouble* basis, Gauss* gauss)=0;
[16810]97 virtual void NodalFunctionsDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
[16831]98 virtual void NodalFunctionsDerivativesVelocity(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
[16839]99 virtual void NormalSection(IssmDouble* normal,IssmDouble* xyz_list)=0;
[16827]100 virtual void NormalTop(IssmDouble* normal,IssmDouble* xyz_list)=0;
[16844]101 virtual void NormalBase(IssmDouble* normal,IssmDouble* xyz_list)=0;
[16813]102 virtual IssmDouble PureIceEnthalpy(IssmDouble pressure)=0;
[16799]103 virtual void TransformLoadVectorCoord(ElementVector* pe,int transformenum)=0;
104 virtual void TransformLoadVectorCoord(ElementVector* pe,int* transformenum_list)=0;
105 virtual void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int transformenum)=0;
106 virtual void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int* transformenum_list)=0;
[16693]107 virtual void TransformSolutionCoord(IssmDouble* values,int transformenum)=0;
[16715]108 virtual void TransformSolutionCoord(IssmDouble* values,int* transformenum_list)=0;
[16775]109 virtual void TransformSolutionCoord(IssmDouble* values,int numnodes,int transformenum)=0;
110 virtual void TransformSolutionCoord(IssmDouble* values,int numnodes,int* transformenum_list)=0;
[16818]111 virtual void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int transformenum)=0;
112 virtual void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int* transformenum_list)=0;
113 virtual void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int transformenum)=0;
114 virtual void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int* transformenum_list)=0;
[16907]115 virtual void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes_list,int numnodes,int* transformenum_list)=0;
[16762]116 virtual Element* GetBasalElement(void)=0;
[16675]117 virtual void GetDofList(int** pdoflist,int approximation_enum,int setenum)=0;
118 virtual void GetDofListVelocity(int** pdoflist,int setenum)=0;
119 virtual void GetDofListPressure(int** pdoflist,int setenum)=0;
[16799]120 virtual void JacobianDeterminant(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
[16850]121 virtual void JacobianDeterminantLine(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
[16838]122 virtual void JacobianDeterminantSurface(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
[16803]123 virtual void JacobianDeterminantBase(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
[16827]124 virtual void JacobianDeterminantTop(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
[16675]125 virtual void GetSolutionFromInputsOneDof(Vector<IssmDouble>* solution,int solutionenum)=0;
[5719]126 virtual int GetNodeIndex(Node* node)=0;
[13886]127 virtual int GetNumberOfNodes(void)=0;
[16715]128 virtual int GetNumberOfNodesVelocity(void)=0;
129 virtual int GetNumberOfNodesPressure(void)=0;
[16727]130 virtual int GetNumberOfVertices(void)=0;
[13892]131 virtual void GetNodesSidList(int* sidlist)=0;
[16042]132 virtual void GetNodesLidList(int* sidlist)=0;
[13892]133
[7089]134 virtual int Sid()=0;
[12471]135 virtual bool IsNodeOnShelfFromFlags(IssmDouble* flags)=0;
[5745]136 virtual bool IsOnBed()=0;
[16827]137 virtual bool IsOnSurface()=0;
[16872]138 virtual void GetGroundedPart(int* point1,IssmDouble* fraction1,IssmDouble* fraction2, bool* mainlyfloating)=0;
139 virtual IssmDouble GetGroundedPortion(IssmDouble* xyz_list)=0;
[16693]140 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype)=0;
141 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
[12471]142 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype)=0;
143 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
[16848]144 virtual Input* GetMaterialInput(int inputenum)=0;
[12471]145 virtual void GetInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
[16675]146 virtual void GetInputValue(bool* pvalue,int enum_type)=0;
147 virtual void GetInputValue(int* pvalue,int enum_type)=0;
148 virtual void GetInputValue(IssmDouble* pvalue,int enum_type)=0;
[16873]149 virtual void GetInputValue(IssmDouble* pvalue,Gauss* gauss,int enum_type)=0;
[16907]150 virtual Node* GetNode(int node_number)=0;
[16698]151 virtual void GetVerticesCoordinates(IssmDouble** xyz_list)=0;
[16803]152 virtual void GetVerticesCoordinatesBase(IssmDouble** xyz_list)=0;
[16827]153 virtual void GetVerticesCoordinatesTop(IssmDouble** xyz_list)=0;
[16839]154 virtual IssmDouble GetZcoord(Gauss* gauss)=0;
[16866]155 virtual IssmDouble GetYcoord(Gauss* gauss)=0;
[16188]156 virtual void GetMaterialInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
[13623]157
[12471]158 virtual IssmDouble SurfaceArea(void)=0;
[4931]159 virtual void InputDepthAverageAtBase(int enum_type,int average_enum_type,int object_enum)=0;
[16693]160 virtual void InputChangeName(int enum_type,int enum_type_old)=0;
[13216]161 virtual void ComputeBasalStress(Vector<IssmDouble>* sigma_b)=0;
162 virtual void ComputeStrainRate(Vector<IssmDouble>* eps)=0;
[16848]163 virtual void ComputeStressTensor(void)=0;
[16461]164 virtual void ResultInterpolation(int* pinterpolation,int output_enum)=0;
[16589]165 virtual void ResultToVector(Vector<IssmDouble>* vector,int output_enum)=0;
[15613]166 virtual void Update(int index, IoModel* iomodel,int analysis_counter,int analysis_type,int finite_element)=0;
[8967]167 virtual void InputDuplicate(int original_enum,int new_enum)=0;
[16208]168 virtual void InputCreate(IssmDouble* vector,IoModel* iomodel,int M,int N,int vector_type,int vector_enum,int code)=0;
[16715]169 virtual void InputUpdateFromSolutionOneDofCollapsed(IssmDouble* solution,int inputenum)=0;
[16717]170 virtual void InputUpdateFromSolutionOneDof(IssmDouble* solution,int inputenum)=0;
[13623]171
[15130]172 virtual int NodalValue(IssmDouble* pvalue, int index, int natureofdataenum)=0;
[16675]173 virtual int NumberofNodesVelocity(void)=0;
174 virtual int NumberofNodesPressure(void)=0;
175 virtual Gauss* NewGauss(void)=0;
[16799]176 virtual Gauss* NewGauss(int order)=0;
[16838]177 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order)=0;
[16839]178 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order_horiz,int order_vert)=0;
[16872]179 virtual Gauss* NewGauss(int point1,IssmDouble fraction1,IssmDouble fraction2,bool mainlyfloating,int order)=0;
[16803]180 virtual Gauss* NewGaussBase(int order)=0;
[16850]181 virtual Gauss* NewGaussLine(int vertex1,int vertex2,int order)=0;
[16827]182 virtual Gauss* NewGaussTop(int order)=0;
[16803]183 virtual ElementVector* NewElementVector(int approximation_enum=NoneApproximationEnum)=0;
[16818]184 virtual ElementMatrix* NewElementMatrix(int approximation_enum=NoneApproximationEnum)=0;
[12471]185 virtual void InputScale(int enum_type,IssmDouble scale_factor)=0;
[13216]186 virtual void GetVectorFromInputs(Vector<IssmDouble>* vector, int name_enum)=0;
[12471]187 virtual IssmDouble TimeAdapt()=0;
188 virtual void PositiveDegreeDay(IssmDouble* pdds,IssmDouble* pds,IssmDouble signorm)=0;
[12748]189 virtual void Delta18oParameterization(void)=0;
[16721]190 virtual void SmbGradients(void)=0;
191 virtual Element* SpawnBasalElement(void)=0;
[16789]192 virtual void ReduceMatrices(ElementMatrix* Ke,ElementVector* pe)=0;
[10440]193 virtual void ResetCoordinateSystem()=0;
[16810]194 virtual IssmDouble StabilizationParameter(IssmDouble u, IssmDouble v, IssmDouble w, IssmDouble diameter, IssmDouble kappa)=0;
[16860]195 virtual void ValueP1OnGauss(IssmDouble* pvalue,IssmDouble* values,Gauss* gauss)=0;
196 virtual void ValueP1DerivativesOnGauss(IssmDouble* dvalue,IssmDouble* values,IssmDouble* xyz_list,Gauss* gauss)=0;
[16810]197 virtual void ViscousHeating(IssmDouble* pphi,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input)=0;
[16915]198
[16675]199 virtual int VelocityInterpolation()=0;
200 virtual int PressureInterpolation()=0;
[16833]201 virtual bool IsZeroLevelset(int levelset_enum)=0;
[16838]202 virtual void ZeroLevelsetCoordinates(IssmDouble** pxyz_zero,IssmDouble* xyz_list,int levelsetenum)=0;
[9817]203
204 #ifdef _HAVE_RESPONSES_
[15387]205 virtual void AverageOntoPartition(Vector<IssmDouble>* partition_contributions,Vector<IssmDouble>* partition_areas,IssmDouble* vertex_response,IssmDouble* qmu_part)=0;
[15130]206 virtual void MinVel(IssmDouble* pminvel)=0;
207 virtual void MaxVel(IssmDouble* pmaxvel)=0;
208 virtual void MinVx(IssmDouble* pminvx)=0;
209 virtual void MaxVx(IssmDouble* pmaxvx)=0;
210 virtual void MaxAbsVx(IssmDouble* pmaxabsvx)=0;
211 virtual void MinVy(IssmDouble* pminvy)=0;
212 virtual void MaxVy(IssmDouble* pmaxvy)=0;
213 virtual void MaxAbsVy(IssmDouble* pmaxabsvy)=0;
214 virtual void MinVz(IssmDouble* pminvz)=0;
215 virtual void MaxVz(IssmDouble* pmaxvz)=0;
216 virtual void MaxAbsVz(IssmDouble* pmaxabsvz)=0;
217 virtual IssmDouble MassFlux(IssmDouble* segment)=0;
[16388]218 virtual IssmDouble MassFlux(IssmDouble x1,IssmDouble y1, IssmDouble x2, IssmDouble y2,int segment_id)=0;
[15129]219 virtual void ElementResponse(IssmDouble* presponse,int response_enum)=0;
[12471]220 virtual IssmDouble IceVolume(void)=0;
[16275]221 virtual IssmDouble IceVolumeAboveFloatation(void)=0;
[12773]222 virtual IssmDouble TotalSmb(void)=0;
[16787]223 virtual IssmDouble Misfit(int modelenum,int observationenum,int weightsenum)=0;
[16849]224 virtual int VertexConnectivity(int vertexindex)=0;
[16850]225 virtual void VerticalSegmentIndices(int** pindices,int* pnumseg)=0;
[9817]226 #endif
[4055]227
[14589]228 #ifdef _HAVE_GIA_
[14807]229 virtual void GiaDeflection(Vector<IssmDouble>* wg,Vector<IssmDouble>* dwgdt,IssmDouble* x,IssmDouble* y)=0;
[14589]230 #endif
231
[9817]232 #ifdef _HAVE_CONTROL_
[13216]233 virtual void Gradj(Vector<IssmDouble>* gradient,int control_type,int control_index)=0;
[16314]234 virtual IssmDouble ThicknessAbsMisfit(void)=0;
235 virtual IssmDouble SurfaceAbsVelMisfit(void)=0;
236 virtual IssmDouble SurfaceRelVelMisfit(void)=0;
237 virtual IssmDouble SurfaceLogVelMisfit(void)=0;
238 virtual IssmDouble SurfaceLogVxVyMisfit(void)=0;
239 virtual IssmDouble SurfaceAverageVelMisfit(void)=0;
240 virtual IssmDouble ThicknessAbsGradient(void)=0;
241 virtual IssmDouble ThicknessAlongGradient(void)=0;
242 virtual IssmDouble ThicknessAcrossGradient(void)=0;
243 virtual IssmDouble BalancethicknessMisfit(void)=0;
244 virtual IssmDouble RheologyBbarAbsGradient(void)=0;
245 virtual IssmDouble DragCoefficientAbsGradient(void)=0;
[13216]246 virtual void ControlInputGetGradient(Vector<IssmDouble>* gradient,int enum_type,int control_index)=0;
[12471]247 virtual void ControlInputSetGradient(IssmDouble* gradient,int enum_type,int control_index)=0;
248 virtual void ControlInputScaleGradient(int enum_type, IssmDouble scale)=0;
[16494]249 virtual void ControlToVectors(Vector<IssmPDouble>* vector_control, Vector<IssmPDouble>* vector_gradient,int control_enum)=0;
[13216]250 virtual void GetVectorFromControlInputs(Vector<IssmDouble>* gradient,int control_enum,int control_index,const char* data)=0;
[12471]251 virtual void SetControlInputsFromVector(IssmDouble* vector,int control_enum,int control_index)=0;
252 virtual void InputControlUpdate(IssmDouble scalar,bool save_parameter)=0;
[9817]253 #endif
[14796]254
[16442]255 virtual void UpdateConstraintsExtrudeFromBase(void)=0;
256 virtual void UpdateConstraintsExtrudeFromTop(void)=0;
257
[15853]258 #ifdef _HAVE_THERMAL_
[16272]259 virtual void UpdateBasalConstraintsEnthalpy(void)=0;
[16026]260 virtual void ComputeBasalMeltingrate(void)=0;
[16816]261 virtual void DrainWaterfraction(IssmDouble* drainrate_element)=0;
[15853]262 #endif
263
[14796]264 #ifdef _HAVE_HYDROLOGY_
[14967]265 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, Node* innode)=0;
[16761]266 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, int index)=0;
[15015]267 virtual void GetHydrologyTransfer(Vector<IssmDouble>* transfer)=0;
[15249]268 virtual void HydrologyEPLGetMask(Vector<IssmDouble>* mask)=0;
269 virtual void HydrologyEPLGetActive(Vector<IssmDouble>* active)=0;
[16600]270 virtual void ComputeEPLThickness(void)=0;
[14796]271 #endif
[15643]272
[15386]273 #ifdef _HAVE_GROUNDINGLINE_
[15962]274 virtual void MigrateGroundingLine(IssmDouble* sheet_ungrounding)=0;
[15386]275 virtual void PotentialUngrounding(Vector<IssmDouble>* potential_sheet_ungrounding)=0;
276 virtual int UpdatePotentialUngrounding(IssmDouble* potential_sheet_ungrounding,Vector<IssmDouble>* vec_nodes_on_iceshelf,IssmDouble* nodes_on_iceshelf)=0;
277 #endif
278
[3683]279};
280#endif
Note: See TracBrowser for help on using the repository browser.