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

Last change on this file since 16956 was 16956, checked in by seroussi, 11 years ago

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