BasisFunctions.h

Go to the documentation of this file.

/*******************************************************
*
* Copyright (c) 2003-2010 by University of Queensland
* Earth Systems Science Computational Center (ESSCC)
* http://www.uq.edu.au/esscc
*
* Primary Business: Queensland, Australia
* Licensed under the Open Software License version 3.0
* http://www.opensource.org/licenses/osl-3.0.php
*
*******************************************************/


/**************************************************************/

/*   Finley: Reference elements */

/**************************************************************/

#ifndef INC_FINLEY_REFERENCEELEMENTS
#define INC_FINLEY_REFERENCEELEMENTS


/**************************************************************/

#include "Finley.h"
#include "ShapeFunctions.h"
#include "Quadrature.h"

/**************************************************************/

/*     The ids of the allowed reference elements: */

#define MAX_numNodes 64

typedef enum {
  Point1,
  Line2,
  Line3,
  Line4,
  Tri3,
  Tri6,
  Tri9,
  Tri10,
  Rec4,
  Rec8,
  Rec9,
  Rec12,
  Rec16,
  Tet4,
  Tet10,
  Tet16,
  Hex8,
  Hex20,
  Hex27,
  Hex32,
  Line2Face,
  Line3Face,
  Line4Face,
  Tri3Face,
  Tri6Face,
  Tri9Face,
  Tri10Face,
  Rec4Face,
  Rec8Face,
  Rec9Face,
  Rec12Face,
  Rec16Face,
  Tet4Face, 
  Tet10Face, 
  Tet16Face,
  Hex8Face,
  Hex20Face, 
  Hex27Face, 
  Hex32Face, 
  Point1_Contact,
  Line2_Contact,
  Line3_Contact,
  Line4_Contact,
  Tri3_Contact,
  Tri6_Contact,
  Tri9_Contact,
  Tri10_Contact,
  Rec4_Contact,
  Rec8_Contact,
  Rec9_Contact,
  Rec12_Contact,
  Rec16_Contact,
  Line2Face_Contact,
  Line3Face_Contact,
  Line4Face_Contact,
  Tri3Face_Contact,
  Tri6Face_Contact,
  Tri9Face_Contact,
  Tri10Face_Contact,
  Rec4Face_Contact,
  Rec8Face_Contact,
  Rec9Face_Contact,
  Rec12Face_Contact,
  Rec16Face_Contact,
  Tet4Face_Contact, 
  Tet10Face_Contact, 
  Tet16Face_Contact,
  Hex8Face_Contact,
  Hex20Face_Contact,
  Hex27Face_Contact, 
  Hex32Face_Contact, 
  Line3Macro, 
  Tri6Macro, 
  Rec9Macro,
  Tet10Macro,
  Hex27Macro,

  NoType   /* marks end of list */
} ElementTypeId;

/**************************************************************/

/*  this struct holds the definition of the reference element: */

typedef struct Finley_ReferenceElementInfo {
  ElementTypeId TypeId;                      /* the id */
  char* Name;                                /* the name in text form e.g. Line1,Rec12,... */
  dim_t numLocalDim;                         /* local dimension of the element */
  dim_t numDim;                              /* dimension of the element */
  dim_t numNodes;                            /* number of nodes defining the element*/
  dim_t numShapes;                           /* number of shape functions, typically = numNodes*/
  dim_t numOrder;                            /* order of the shape functions */
  dim_t numVertices;                         /* number of vertices of the element */
  ElementTypeId LinearTypeId;                /* id of the linear version of the element */
  index_t linearNodes[MAX_numNodes];         /* gives the list of nodes defining the linear or macro element, typically it is linearNodes[i]=i */
  Finley_Shape_Function* getValues;          /* function to evaluate the shape functions at a set of points */
  Finley_Quad_getNodes* getQuadNodes;        /* function to set the quadrature points */
  Finley_Quad_getNumNodes* getNumQuadNodes;  /* function selects the number of quadrature nodes for a given accuracy order */
  
/*********************************************************************************************************************************** */  
  dim_t numRelevantGeoNodes;                 /* number of nodes used to describe the geometry of the geometrically relevant part of the element
                                                typically this is numNodes but for 'Face' elements where the quadrature points are defined on face of the element 
                        this is the number of nodes on the particular face. */
  index_t relevantGeoNodes[MAX_numNodes];    /* list to gather the geometrically relevant nodes (length used is numRelevantGeoNodes)
                                                this list is used for the VTK interface */
  
  dim_t numNodesOnFace;                       /* if the element is allowed as a face element, numNodesOnFace defines the number of nodes defining the face */
                                              /* the following lists are only used for face elements defined by numNodesOnFace>0 */
  index_t faceNodes[MAX_numNodes];             /* list of the nodes defining the face */
  index_t shiftNodes[MAX_numNodes];           /* defines a permutation of the nodes which rotates the nodes on the face */
  index_t reverseNodes[MAX_numNodes];         /* reverses the order of the nodes on a face. The permutation has to keep 0 fixed. */
                                              /* shiftNodes={-1} or reverseNodes={-1} are ignored. */
}  Finley_ReferenceElementInfo;

/**************************************************************/

/*  this struct holds the realization of a reference element */

typedef struct Finley_ReferenceElement {
  Finley_ReferenceElementInfo* Type;     /* type of the reference element */
  int numQuadNodes;                /* number of quadrature points */
  double *QuadNodes;               /* coordinates of quadrature nodes */
  double *QuadWeights;             /* weights of the quadrature scheme */
  double *S;                       /* shape functions at quadrature nodes */
  double *dSdv;                    /* derivative of the shape functions at quadrature nodes */
}  Finley_ReferenceElement;

/**************************************************************/

/*    interfaces: */

Finley_ReferenceElement* Finley_ReferenceElement_alloc(ElementTypeId,int);
void Finley_ReferenceElement_dealloc(Finley_ReferenceElement*);
ElementTypeId Finley_ReferenceElement_getTypeId(char*);

#endif /* #ifndef INC_FINLEY_REFERENCEELEMENTS */