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

Last change on this file since 17257 was 17257, checked in by jbondzio, 11 years ago

ADD: bool Element::IsIceFront(), minor bugs
File size: 17.5 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);
[17255]56 void CoordinateSystemTransform(IssmDouble** ptransform,Node** nodes,int numnodes,int* cs_array);
[16913]57 void DeleteMaterials(void);
58 void FindParam(bool* pvalue,int paramenum);
59 void FindParam(int* pvalue,int paramenum);
60 void FindParam(IssmDouble* pvalue,int paramenum);
61 void FindParam(int** pvalues,int* psize,int paramenum);
62 Input* GetInput(int inputenum);
63 IssmDouble GetMaterialParameter(int enum_in);
[16947]64 void GetPhi(IssmDouble* phi, IssmDouble* epsilon, IssmDouble viscosity);
65 void GetVerticesSidList(int* sidlist);
66 void GetVerticesConnectivityList(int* connectivitylist);
[16913]67 bool IsFloating();
[17100]68 void ResultInterpolation(int* pinterpolation,int*nodesperelement,int output_enum);
[16947]69 void ResultToVector(Vector<IssmDouble>* vector,int output_enum);
[17100]70 void ResultToPatch(IssmDouble* values,int nodesperelement,int output_enum);
[16915]71 void StrainRateSSA(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
72 void StrainRateHO(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
[17242]73 void StrainRateHO2dvertical(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
[16915]74 void StrainRateFS(IssmDouble* epsilon,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
[16914]75 IssmDouble TMeltingPoint(IssmDouble pressure);
[17255]76 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,int cs_enum);
77 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int cs_enum);
78 void TransformInvStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int* cs_array);
79 void TransformLoadVectorCoord(ElementVector* pe,int cs_enum);
80 void TransformLoadVectorCoord(ElementVector* pe,int* cs_array);
81 void TransformLoadVectorCoord(ElementVector* pe,Node** nodes,int numnodes,int cs_enum);
82 void TransformLoadVectorCoord(ElementVector* pe,Node** nodes,int numnodes,int* cs_array);
83 void TransformSolutionCoord(IssmDouble* solution,int cs_enum);
84 void TransformSolutionCoord(IssmDouble* solution,int* cs_array);
85 void TransformSolutionCoord(IssmDouble* solution,int numnodes,int cs_enum);
86 void TransformSolutionCoord(IssmDouble* solution,int numnodes,int* cs_array);
87 void TransformSolutionCoord(IssmDouble* solution,Node** nodes,int numnodes,int cs_enum);
88 void TransformSolutionCoord(IssmDouble* solution,Node** nodes,int numnodes,int* cs_array);
89 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int cs_enum);
90 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int* cs_array);
91 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int cs_enum);
92 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,Node** nodes,int numnodes,int* cs_array);
[16947]93 void ViscousHeatingCreateInput(void);
[16922]94 void ViscosityFS(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input);
[17242]95 void ViscosityHO(IssmDouble* pviscosity,int dim,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
[16915]96 void ViscosityL1L2(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* surf);
97 void ViscositySSA(IssmDouble* pviscosity,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input);
98 void ViscositySSADerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
99 void ViscosityHODerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
100 void ViscosityFSDerivativeEpsSquare(IssmDouble* pmu_prime,IssmDouble* epsilon);
[16947]101 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int transformenum){_error_("not implemented yet");};/*Tiling only*/
102 void TransformLoadVectorCoord(ElementVector* pe,int numnodes,int* transformenum_list){_error_("not implemented yet");};/*Tiling only*/
103 void TransformStiffnessMatrixCoord(ElementMatrix* Ke,int numnodes,int* transformenum_list){_error_("not implemented yet");};/*Tiling only*/
[13623]104
[16910]105 /*Virtual functions*/
[16912]106 virtual void AddBasalInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
107 virtual void AddInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
108 virtual void AddMaterialInput(int input_enum, IssmDouble* values, int interpolation_enum)=0;
[16832]109 virtual IssmDouble CharacteristicLength(void)=0;
[16912]110 virtual void Configure(Elements* elements,Loads* loads,Nodes* nodes,Vertices* vertices,Materials* materials,Parameters* parameters)=0;
111 virtual void SetCurrentConfiguration(Elements* elements,Loads* loads,Nodes* nodes,Materials* materials,Parameters* parameters)=0;
112 virtual void SetwiseNodeConnectivity(int* d_nz,int* o_nz,Node* node,bool* flags,int* flagsindices,int set1_enum,int set2_enum)=0;
[16840]113 virtual void ElementSizes(IssmDouble* phx,IssmDouble* phy,IssmDouble* phz)=0;
[17014]114 virtual void ThermalToEnthalpy(IssmDouble* penthalpy,IssmDouble temperature,IssmDouble waterfraction,IssmDouble pressure)=0;
[16734]115 virtual void EnthalpyToThermal(IssmDouble* ptemperature,IssmDouble* pwaterfraction,IssmDouble enthalpy,IssmDouble pressure)=0;
[16812]116 virtual IssmDouble EnthalpyDiffusionParameter(IssmDouble enthalpy,IssmDouble pressure)=0;
117 virtual IssmDouble EnthalpyDiffusionParameterVolume(int numvertices,IssmDouble* enthalpy,IssmDouble* pressure)=0;
[16675]118 virtual int FiniteElement(void)=0;
[16810]119 virtual IssmDouble MinEdgeLength(IssmDouble* xyz_list)=0;
[16799]120 virtual void NodalFunctions(IssmDouble* basis,Gauss* gauss)=0;
[16926]121 virtual void NodalFunctionsP1(IssmDouble* basis,Gauss* gauss)=0;
[16831]122 virtual void NodalFunctionsVelocity(IssmDouble* basis, Gauss* gauss)=0;
123 virtual void NodalFunctionsPressure(IssmDouble* basis, Gauss* gauss)=0;
[16810]124 virtual void NodalFunctionsDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
[16926]125 virtual void NodalFunctionsP1Derivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
[16949]126 virtual void NodalFunctionsMINIDerivatives(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
[16831]127 virtual void NodalFunctionsDerivativesVelocity(IssmDouble* dbasis,IssmDouble* xyz_list,Gauss* gauss)=0;
[16839]128 virtual void NormalSection(IssmDouble* normal,IssmDouble* xyz_list)=0;
[16827]129 virtual void NormalTop(IssmDouble* normal,IssmDouble* xyz_list)=0;
[16844]130 virtual void NormalBase(IssmDouble* normal,IssmDouble* xyz_list)=0;
[16813]131 virtual IssmDouble PureIceEnthalpy(IssmDouble pressure)=0;
[16916]132
[17014]133 virtual Element* GetUpperElement(void)=0;
134 virtual Element* GetLowerElement(void)=0;
135 virtual Element* GetSurfaceElement(void)=0;
[16762]136 virtual Element* GetBasalElement(void)=0;
[16675]137 virtual void GetDofList(int** pdoflist,int approximation_enum,int setenum)=0;
138 virtual void GetDofListVelocity(int** pdoflist,int setenum)=0;
139 virtual void GetDofListPressure(int** pdoflist,int setenum)=0;
[16799]140 virtual void JacobianDeterminant(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
[16850]141 virtual void JacobianDeterminantLine(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
[16838]142 virtual void JacobianDeterminantSurface(IssmDouble* Jdet, IssmDouble* xyz_list,Gauss* gauss)=0;
[16803]143 virtual void JacobianDeterminantBase(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
[16827]144 virtual void JacobianDeterminantTop(IssmDouble* Jdet,IssmDouble* xyz_list_base,Gauss* gauss)=0;
[16675]145 virtual void GetSolutionFromInputsOneDof(Vector<IssmDouble>* solution,int solutionenum)=0;
[5719]146 virtual int GetNodeIndex(Node* node)=0;
[13886]147 virtual int GetNumberOfNodes(void)=0;
[16715]148 virtual int GetNumberOfNodesVelocity(void)=0;
149 virtual int GetNumberOfNodesPressure(void)=0;
[16727]150 virtual int GetNumberOfVertices(void)=0;
[13892]151 virtual void GetNodesSidList(int* sidlist)=0;
[16042]152 virtual void GetNodesLidList(int* sidlist)=0;
[13892]153
[17114]154 virtual int Id()=0;
[7089]155 virtual int Sid()=0;
[12471]156 virtual bool IsNodeOnShelfFromFlags(IssmDouble* flags)=0;
[5745]157 virtual bool IsOnBed()=0;
[16827]158 virtual bool IsOnSurface()=0;
[17118]159 virtual bool IsIceInElement()=0;
[16872]160 virtual void GetGroundedPart(int* point1,IssmDouble* fraction1,IssmDouble* fraction2, bool* mainlyfloating)=0;
161 virtual IssmDouble GetGroundedPortion(IssmDouble* xyz_list)=0;
[16693]162 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype)=0;
163 virtual void GetInputListOnNodes(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
[12471]164 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype)=0;
165 virtual void GetInputListOnVertices(IssmDouble* pvalue,int enumtype,IssmDouble defaultvalue)=0;
[16848]166 virtual Input* GetMaterialInput(int inputenum)=0;
[12471]167 virtual void GetInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
[16675]168 virtual void GetInputValue(bool* pvalue,int enum_type)=0;
169 virtual void GetInputValue(int* pvalue,int enum_type)=0;
170 virtual void GetInputValue(IssmDouble* pvalue,int enum_type)=0;
[16873]171 virtual void GetInputValue(IssmDouble* pvalue,Gauss* gauss,int enum_type)=0;
[16907]172 virtual Node* GetNode(int node_number)=0;
[16698]173 virtual void GetVerticesCoordinates(IssmDouble** xyz_list)=0;
[16803]174 virtual void GetVerticesCoordinatesBase(IssmDouble** xyz_list)=0;
[16827]175 virtual void GetVerticesCoordinatesTop(IssmDouble** xyz_list)=0;
[17109]176 virtual IssmDouble GetXcoord(Gauss* gauss)=0;
177 virtual IssmDouble GetYcoord(Gauss* gauss)=0;
[16839]178 virtual IssmDouble GetZcoord(Gauss* gauss)=0;
[16188]179 virtual void GetMaterialInputValue(IssmDouble* pvalue,Node* node,int enumtype)=0;
[17027]180 virtual int GetElementType(void)=0;
[13623]181
[12471]182 virtual IssmDouble SurfaceArea(void)=0;
[4931]183 virtual void InputDepthAverageAtBase(int enum_type,int average_enum_type,int object_enum)=0;
[16693]184 virtual void InputChangeName(int enum_type,int enum_type_old)=0;
[13216]185 virtual void ComputeBasalStress(Vector<IssmDouble>* sigma_b)=0;
186 virtual void ComputeStrainRate(Vector<IssmDouble>* eps)=0;
[16848]187 virtual void ComputeStressTensor(void)=0;
[16947]188
[15613]189 virtual void Update(int index, IoModel* iomodel,int analysis_counter,int analysis_type,int finite_element)=0;
[8967]190 virtual void InputDuplicate(int original_enum,int new_enum)=0;
[16208]191 virtual void InputCreate(IssmDouble* vector,IoModel* iomodel,int M,int N,int vector_type,int vector_enum,int code)=0;
[16715]192 virtual void InputUpdateFromSolutionOneDofCollapsed(IssmDouble* solution,int inputenum)=0;
[16717]193 virtual void InputUpdateFromSolutionOneDof(IssmDouble* solution,int inputenum)=0;
[13623]194
[15130]195 virtual int NodalValue(IssmDouble* pvalue, int index, int natureofdataenum)=0;
[16675]196 virtual int NumberofNodesVelocity(void)=0;
197 virtual int NumberofNodesPressure(void)=0;
198 virtual Gauss* NewGauss(void)=0;
[16799]199 virtual Gauss* NewGauss(int order)=0;
[16838]200 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order)=0;
[16839]201 virtual Gauss* NewGauss(IssmDouble* xyz_list, IssmDouble* xyz_list_front,int order_horiz,int order_vert)=0;
[16872]202 virtual Gauss* NewGauss(int point1,IssmDouble fraction1,IssmDouble fraction2,bool mainlyfloating,int order)=0;
[16803]203 virtual Gauss* NewGaussBase(int order)=0;
[16850]204 virtual Gauss* NewGaussLine(int vertex1,int vertex2,int order)=0;
[16827]205 virtual Gauss* NewGaussTop(int order)=0;
[16803]206 virtual ElementVector* NewElementVector(int approximation_enum=NoneApproximationEnum)=0;
[16818]207 virtual ElementMatrix* NewElementMatrix(int approximation_enum=NoneApproximationEnum)=0;
[16956]208 virtual ElementMatrix* NewElementMatrixCoupling(int number_nodes,int approximation_enum=NoneApproximationEnum)=0;
[12471]209 virtual void InputScale(int enum_type,IssmDouble scale_factor)=0;
[13216]210 virtual void GetVectorFromInputs(Vector<IssmDouble>* vector, int name_enum)=0;
[12471]211 virtual IssmDouble TimeAdapt()=0;
212 virtual void PositiveDegreeDay(IssmDouble* pdds,IssmDouble* pds,IssmDouble signorm)=0;
[12748]213 virtual void Delta18oParameterization(void)=0;
[16721]214 virtual void SmbGradients(void)=0;
215 virtual Element* SpawnBasalElement(void)=0;
[17172]216 virtual Element* SpawnTopElement(void)=0;
[16789]217 virtual void ReduceMatrices(ElementMatrix* Ke,ElementVector* pe)=0;
[10440]218 virtual void ResetCoordinateSystem()=0;
[16926]219 virtual void SetTemporaryElementType(int element_type_in)=0;
[16810]220 virtual IssmDouble StabilizationParameter(IssmDouble u, IssmDouble v, IssmDouble w, IssmDouble diameter, IssmDouble kappa)=0;
[16860]221 virtual void ValueP1OnGauss(IssmDouble* pvalue,IssmDouble* values,Gauss* gauss)=0;
222 virtual void ValueP1DerivativesOnGauss(IssmDouble* dvalue,IssmDouble* values,IssmDouble* xyz_list,Gauss* gauss)=0;
[16810]223 virtual void ViscousHeating(IssmDouble* pphi,IssmDouble* xyz_list,Gauss* gauss,Input* vx_input,Input* vy_input,Input* vz_input)=0;
[16915]224
[16675]225 virtual int VelocityInterpolation()=0;
226 virtual int PressureInterpolation()=0;
[16833]227 virtual bool IsZeroLevelset(int levelset_enum)=0;
[17257]228 virtual bool IsIcefront(void)=0;
[16838]229 virtual void ZeroLevelsetCoordinates(IssmDouble** pxyz_zero,IssmDouble* xyz_list,int levelsetenum)=0;
[17194]230 virtual void GetIcefrontCoordinates(IssmDouble** pxyz_front,IssmDouble* xyz_list,int levelsetenum)=0;
231 virtual void GetNormalFromLSF(IssmDouble *pnormal)=0;
[9817]232
[15387]233 virtual void AverageOntoPartition(Vector<IssmDouble>* partition_contributions,Vector<IssmDouble>* partition_areas,IssmDouble* vertex_response,IssmDouble* qmu_part)=0;
[15130]234 virtual void MinVel(IssmDouble* pminvel)=0;
235 virtual void MaxVel(IssmDouble* pmaxvel)=0;
236 virtual void MinVx(IssmDouble* pminvx)=0;
237 virtual void MaxVx(IssmDouble* pmaxvx)=0;
238 virtual void MaxAbsVx(IssmDouble* pmaxabsvx)=0;
239 virtual void MinVy(IssmDouble* pminvy)=0;
240 virtual void MaxVy(IssmDouble* pmaxvy)=0;
241 virtual void MaxAbsVy(IssmDouble* pmaxabsvy)=0;
242 virtual void MinVz(IssmDouble* pminvz)=0;
243 virtual void MaxVz(IssmDouble* pmaxvz)=0;
244 virtual void MaxAbsVz(IssmDouble* pmaxabsvz)=0;
245 virtual IssmDouble MassFlux(IssmDouble* segment)=0;
[16388]246 virtual IssmDouble MassFlux(IssmDouble x1,IssmDouble y1, IssmDouble x2, IssmDouble y2,int segment_id)=0;
[15129]247 virtual void ElementResponse(IssmDouble* presponse,int response_enum)=0;
[12471]248 virtual IssmDouble IceVolume(void)=0;
[16275]249 virtual IssmDouble IceVolumeAboveFloatation(void)=0;
[12773]250 virtual IssmDouble TotalSmb(void)=0;
[16787]251 virtual IssmDouble Misfit(int modelenum,int observationenum,int weightsenum)=0;
[17047]252 virtual IssmDouble MisfitArea(int weightsenum)=0;
[16849]253 virtual int VertexConnectivity(int vertexindex)=0;
[16850]254 virtual void VerticalSegmentIndices(int** pindices,int* pnumseg)=0;
[4055]255
[14589]256 #ifdef _HAVE_GIA_
[14807]257 virtual void GiaDeflection(Vector<IssmDouble>* wg,Vector<IssmDouble>* dwgdt,IssmDouble* x,IssmDouble* y)=0;
[14589]258 #endif
259
[13216]260 virtual void Gradj(Vector<IssmDouble>* gradient,int control_type,int control_index)=0;
[16314]261 virtual IssmDouble ThicknessAbsMisfit(void)=0;
262 virtual IssmDouble SurfaceAbsVelMisfit(void)=0;
263 virtual IssmDouble SurfaceRelVelMisfit(void)=0;
264 virtual IssmDouble SurfaceLogVelMisfit(void)=0;
265 virtual IssmDouble SurfaceLogVxVyMisfit(void)=0;
266 virtual IssmDouble SurfaceAverageVelMisfit(void)=0;
267 virtual IssmDouble ThicknessAbsGradient(void)=0;
268 virtual IssmDouble ThicknessAlongGradient(void)=0;
269 virtual IssmDouble ThicknessAcrossGradient(void)=0;
270 virtual IssmDouble BalancethicknessMisfit(void)=0;
271 virtual IssmDouble RheologyBbarAbsGradient(void)=0;
272 virtual IssmDouble DragCoefficientAbsGradient(void)=0;
[13216]273 virtual void ControlInputGetGradient(Vector<IssmDouble>* gradient,int enum_type,int control_index)=0;
[12471]274 virtual void ControlInputSetGradient(IssmDouble* gradient,int enum_type,int control_index)=0;
275 virtual void ControlInputScaleGradient(int enum_type, IssmDouble scale)=0;
[16494]276 virtual void ControlToVectors(Vector<IssmPDouble>* vector_control, Vector<IssmPDouble>* vector_gradient,int control_enum)=0;
[13216]277 virtual void GetVectorFromControlInputs(Vector<IssmDouble>* gradient,int control_enum,int control_index,const char* data)=0;
[12471]278 virtual void SetControlInputsFromVector(IssmDouble* vector,int control_enum,int control_index)=0;
279 virtual void InputControlUpdate(IssmDouble scalar,bool save_parameter)=0;
[14796]280
[16442]281 virtual void UpdateConstraintsExtrudeFromBase(void)=0;
282 virtual void UpdateConstraintsExtrudeFromTop(void)=0;
283
[16954]284 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max,int index)=0;
[14967]285 virtual void GetHydrologyDCInefficientHmax(IssmDouble* ph_max, Node* innode)=0;
[15015]286 virtual void GetHydrologyTransfer(Vector<IssmDouble>* transfer)=0;
[15249]287 virtual void HydrologyEPLGetMask(Vector<IssmDouble>* mask)=0;
288 virtual void HydrologyEPLGetActive(Vector<IssmDouble>* active)=0;
[16600]289 virtual void ComputeEPLThickness(void)=0;
[15643]290
[15962]291 virtual void MigrateGroundingLine(IssmDouble* sheet_ungrounding)=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.