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

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

DEL: removed all gradients of elements, now done by adjoint

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