137045ce4SJed Brown /* 237045ce4SJed Brown Common tools for constructing discretizations 337045ce4SJed Brown */ 426bd1501SBarry Smith #if !defined(PETSCDT_H) 526bd1501SBarry Smith #define PETSCDT_H 637045ce4SJed Brown 737045ce4SJed Brown #include <petscsys.h> 837045ce4SJed Brown 92cd22861SMatthew G. Knepley PETSC_EXTERN PetscClassId PETSCQUADRATURE_CLASSID; 102cd22861SMatthew G. Knepley 1121454ff5SMatthew G. Knepley /*S 1221454ff5SMatthew G. Knepley PetscQuadrature - Quadrature rule for integration. 1321454ff5SMatthew G. Knepley 14329bbf4eSMatthew G. Knepley Level: beginner 1521454ff5SMatthew G. Knepley 1621454ff5SMatthew G. Knepley .seealso: PetscQuadratureCreate(), PetscQuadratureDestroy() 1721454ff5SMatthew G. Knepley S*/ 1821454ff5SMatthew G. Knepley typedef struct _p_PetscQuadrature *PetscQuadrature; 1921454ff5SMatthew G. Knepley 208272889dSSatish Balay /*E 21916e780bShannah_mairs PetscGaussLobattoLegendreCreateType - algorithm used to compute the Gauss-Lobatto-Legendre nodes and weights 228272889dSSatish Balay 238272889dSSatish Balay Level: intermediate 248272889dSSatish Balay 25f2e8fe4dShannah_mairs $ PETSCGAUSSLOBATTOLEGENDRE_VIA_LINEAR_ALGEBRA - compute the nodes via linear algebra 26d410ae54Shannah_mairs $ PETSCGAUSSLOBATTOLEGENDRE_VIA_NEWTON - compute the nodes by solving a nonlinear equation with Newton's method 278272889dSSatish Balay 288272889dSSatish Balay E*/ 29f2e8fe4dShannah_mairs typedef enum {PETSCGAUSSLOBATTOLEGENDRE_VIA_LINEAR_ALGEBRA,PETSCGAUSSLOBATTOLEGENDRE_VIA_NEWTON} PetscGaussLobattoLegendreCreateType; 308272889dSSatish Balay 31d4afb720SToby Isaac /*E 32d4afb720SToby Isaac PetscDTNodeType - A description of strategies for generating nodes (both 33d4afb720SToby Isaac quadrature nodes and nodes for Lagrange polynomials) 34d4afb720SToby Isaac 35d4afb720SToby Isaac Level: intermediate 36d4afb720SToby Isaac 37d4afb720SToby Isaac $ PETSCDTNODES_DEFAULT - Nodes chosen by PETSc 38d4afb720SToby Isaac $ PETSCDTNODES_GAUSSJACOBI - Nodes at either Gauss-Jacobi or Gauss-Lobatto-Jacobi quadrature points 39d4afb720SToby Isaac $ PETSCDTNODES_EQUISPACED - Nodes equispaced either including the endpoints or excluding them 40d4afb720SToby Isaac $ PETSCDTNODES_TANHSINH - Nodes at Tanh-Sinh quadrature points 41d4afb720SToby Isaac 42d4afb720SToby Isaac Note: a PetscDTNodeType can be paired with a PetscBool to indicate whether 43d4afb720SToby Isaac the nodes include endpoints or not, and in the case of PETSCDT_GAUSSJACOBI 44d4afb720SToby Isaac with exponents for the weight function. 45d4afb720SToby Isaac 46d4afb720SToby Isaac E*/ 47d4afb720SToby Isaac typedef enum {PETSCDTNODES_DEFAULT=-1, PETSCDTNODES_GAUSSJACOBI, PETSCDTNODES_EQUISPACED, PETSCDTNODES_TANHSINH} PetscDTNodeType; 48d4afb720SToby Isaac 49d4afb720SToby Isaac PETSC_EXTERN const char *const PetscDTNodeTypes[]; 50d4afb720SToby Isaac 5121454ff5SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureCreate(MPI_Comm, PetscQuadrature *); 52c9638911SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureDuplicate(PetscQuadrature, PetscQuadrature *); 53bcede257SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureGetOrder(PetscQuadrature, PetscInt*); 54bcede257SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureSetOrder(PetscQuadrature, PetscInt); 55a6b92713SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureGetNumComponents(PetscQuadrature, PetscInt*); 56a6b92713SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureSetNumComponents(PetscQuadrature, PetscInt); 57a6b92713SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureGetData(PetscQuadrature, PetscInt*, PetscInt*, PetscInt*, const PetscReal *[], const PetscReal *[]); 58a6b92713SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureSetData(PetscQuadrature, PetscInt, PetscInt, PetscInt, const PetscReal [], const PetscReal []); 5921454ff5SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureView(PetscQuadrature, PetscViewer); 6021454ff5SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureDestroy(PetscQuadrature *); 61a0845e3aSMatthew G. Knepley 6289710940SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscQuadratureExpandComposite(PetscQuadrature, PetscInt, const PetscReal[], const PetscReal[], PetscQuadrature *); 6389710940SMatthew G. Knepley 64907761f8SToby Isaac PETSC_EXTERN PetscErrorCode PetscQuadraturePushForward(PetscQuadrature, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, PetscQuadrature *); 65907761f8SToby Isaac 6637045ce4SJed Brown PETSC_EXTERN PetscErrorCode PetscDTLegendreEval(PetscInt,const PetscReal*,PetscInt,const PetscInt*,PetscReal*,PetscReal*,PetscReal*); 67fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTJacobiNorm(PetscReal,PetscReal,PetscInt,PetscReal *); 6894e21283SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTJacobiEval(PetscInt,PetscReal,PetscReal,const PetscReal*,PetscInt,const PetscInt*,PetscReal*,PetscReal*,PetscReal*); 69fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTJacobiEvalJet(PetscReal,PetscReal,PetscInt,const PetscReal[],PetscInt,PetscInt,PetscReal[]); 70fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTPKDEvalJet(PetscInt,PetscInt,const PetscReal[],PetscInt,PetscInt,PetscReal[]); 7137045ce4SJed Brown PETSC_EXTERN PetscErrorCode PetscDTGaussQuadrature(PetscInt,PetscReal,PetscReal,PetscReal*,PetscReal*); 7294e21283SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTGaussJacobiQuadrature(PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal*,PetscReal*); 7394e21283SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTGaussLobattoJacobiQuadrature(PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal*,PetscReal*); 74916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscDTGaussLobattoLegendreQuadrature(PetscInt,PetscGaussLobattoLegendreCreateType,PetscReal*,PetscReal*); 75194825f6SJed Brown PETSC_EXTERN PetscErrorCode PetscDTReconstructPoly(PetscInt,PetscInt,const PetscReal*,PetscInt,const PetscReal*,PetscReal*); 76a6b92713SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDTGaussTensorQuadrature(PetscInt,PetscInt,PetscInt,PetscReal,PetscReal,PetscQuadrature*); 77e6a796c3SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTStroudConicalQuadrature(PetscInt,PetscInt,PetscInt,PetscReal,PetscReal,PetscQuadrature*); 7837045ce4SJed Brown 79b3c0f97bSTom Klotz PETSC_EXTERN PetscErrorCode PetscDTTanhSinhTensorQuadrature(PetscInt, PetscInt, PetscReal, PetscReal, PetscQuadrature *); 80b3c0f97bSTom Klotz PETSC_EXTERN PetscErrorCode PetscDTTanhSinhIntegrate(void (*)(PetscReal, PetscReal *), PetscReal, PetscReal, PetscInt, PetscReal *); 81d525116cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDTTanhSinhIntegrateMPFR(void (*)(PetscReal, PetscReal *), PetscReal, PetscReal, PetscInt, PetscReal *); 82b3c0f97bSTom Klotz 83916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreIntegrate(PetscInt, PetscReal *, PetscReal *, const PetscReal *, PetscReal *); 84916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementLaplacianCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 85916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementLaplacianDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 86916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementGradientCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***, PetscReal ***); 87916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementGradientDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***, PetscReal ***); 88916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementAdvectionCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 89916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementAdvectionDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 90916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementMassCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 91916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementMassDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 92916e780bShannah_mairs 931a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVApply(PetscInt, PetscInt, const PetscReal *, const PetscReal *, PetscReal *); 941a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVWedge(PetscInt, PetscInt, PetscInt, const PetscReal *, const PetscReal *, PetscReal *); 951a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVWedgeMatrix(PetscInt, PetscInt, PetscInt, const PetscReal *, PetscReal *); 961a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVPullback(PetscInt, PetscInt, const PetscReal *, PetscInt, const PetscReal *, PetscReal *); 971a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVPullbackMatrix(PetscInt, PetscInt, const PetscReal *, PetscInt, PetscReal *); 981a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVInterior(PetscInt, PetscInt, const PetscReal *, const PetscReal *, PetscReal *); 991a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVInteriorMatrix(PetscInt, PetscInt, const PetscReal *, PetscReal *); 100dda711d0SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVInteriorPattern(PetscInt, PetscInt, PetscInt (*)[3]); 1011a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVStar(PetscInt, PetscInt, PetscInt, const PetscReal *, PetscReal *); 1021a989b97SToby Isaac 103d4afb720SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTBaryToIndex(PetscInt,PetscInt,const PetscInt[],PetscInt*); 104d4afb720SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTIndexToBary(PetscInt,PetscInt,PetscInt,PetscInt[]); 105fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTGradedOrderToIndex(PetscInt,const PetscInt[],PetscInt*); 106fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTIndexToGradedOrder(PetscInt,PetscInt,PetscInt[]); 107d4afb720SToby Isaac 108fad4db65SToby Isaac #if defined(PETSC_USE_64BIT_INDICES) 109fad4db65SToby Isaac #define PETSC_FACTORIAL_MAX 20 110fad4db65SToby Isaac #define PETSC_BINOMIAL_MAX 61 111fad4db65SToby Isaac #else 112fad4db65SToby Isaac #define PETSC_FACTORIAL_MAX 12 113fad4db65SToby Isaac #define PETSC_BINOMIAL_MAX 29 114fad4db65SToby Isaac #endif 115fad4db65SToby Isaac 116fad4db65SToby Isaac /*MC 117fad4db65SToby Isaac PetscDTFactorial - Approximate n! as a real number 118fad4db65SToby Isaac 119*4165533cSJose E. Roman Input Parameter: 120fad4db65SToby Isaac . n - a non-negative integer 121fad4db65SToby Isaac 122*4165533cSJose E. Roman Output Parameter: 123fad4db65SToby Isaac . factorial - n! 124fad4db65SToby Isaac 125fad4db65SToby Isaac Level: beginner 126fad4db65SToby Isaac M*/ 127fad4db65SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTFactorial(PetscInt n, PetscReal *factorial) 128fad4db65SToby Isaac { 129fad4db65SToby Isaac PetscReal f = 1.0; 130fad4db65SToby Isaac PetscInt i; 131fad4db65SToby Isaac 132fad4db65SToby Isaac PetscFunctionBegin; 133e2ab39ccSLisandro Dalcin *factorial = -1.0; 13428222859SToby Isaac if (n < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Factorial called with negative number %D\n", n); 135e2ab39ccSLisandro Dalcin for (i = 1; i < n+1; ++i) f *= (PetscReal)i; 136fad4db65SToby Isaac *factorial = f; 137fad4db65SToby Isaac PetscFunctionReturn(0); 138fad4db65SToby Isaac } 139fad4db65SToby Isaac 140fad4db65SToby Isaac /*MC 141fad4db65SToby Isaac PetscDTFactorialInt - Compute n! as an integer 142fad4db65SToby Isaac 143*4165533cSJose E. Roman Input Parameter: 144fad4db65SToby Isaac . n - a non-negative integer 145fad4db65SToby Isaac 146*4165533cSJose E. Roman Output Parameter: 147fad4db65SToby Isaac . factorial - n! 148fad4db65SToby Isaac 149fad4db65SToby Isaac Level: beginner 150fad4db65SToby Isaac 151fad4db65SToby Isaac Note: this is limited to n such that n! can be represented by PetscInt, which is 12 if PetscInt is a signed 32-bit integer and 20 if PetscInt is a signed 64-bit integer. 152fad4db65SToby Isaac M*/ 153fad4db65SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTFactorialInt(PetscInt n, PetscInt *factorial) 154fad4db65SToby Isaac { 155fad4db65SToby Isaac PetscInt facLookup[13] = {1, 1, 2, 6, 24, 120, 720, 5040, 40320, 362880, 3628800, 39916800, 479001600}; 156fad4db65SToby Isaac 15728222859SToby Isaac PetscFunctionBegin; 15828222859SToby Isaac *factorial = -1; 159fad4db65SToby Isaac if (n < 0 || n > PETSC_FACTORIAL_MAX) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Number of elements %D is not in supported range [0,%D]\n",n,PETSC_FACTORIAL_MAX); 160fad4db65SToby Isaac if (n <= 12) { 161fad4db65SToby Isaac *factorial = facLookup[n]; 162fad4db65SToby Isaac } else { 163fad4db65SToby Isaac PetscInt f = facLookup[12]; 164fad4db65SToby Isaac PetscInt i; 165fad4db65SToby Isaac 166fad4db65SToby Isaac for (i = 13; i < n+1; ++i) f *= i; 167fad4db65SToby Isaac *factorial = f; 168fad4db65SToby Isaac } 169fad4db65SToby Isaac PetscFunctionReturn(0); 170fad4db65SToby Isaac } 171fad4db65SToby Isaac 172fad4db65SToby Isaac /*MC 173fad4db65SToby Isaac PetscDTBinomial - Approximate the binomial coefficient "n choose k" 174fad4db65SToby Isaac 175*4165533cSJose E. Roman Input Parameters: 176fad4db65SToby Isaac + n - a non-negative integer 177fad4db65SToby Isaac - k - an integer between 0 and n, inclusive 178fad4db65SToby Isaac 179*4165533cSJose E. Roman Output Parameter: 180fad4db65SToby Isaac . binomial - approximation of the binomial coefficient n choose k 181fad4db65SToby Isaac 182fad4db65SToby Isaac Level: beginner 183fad4db65SToby Isaac M*/ 184fad4db65SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTBinomial(PetscInt n, PetscInt k, PetscReal *binomial) 1851a989b97SToby Isaac { 1861a989b97SToby Isaac PetscFunctionBeginHot; 187e2ab39ccSLisandro Dalcin *binomial = -1.0; 188fad4db65SToby Isaac if (n < 0 || k < 0 || k > n) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Binomial arguments (%D %D) must be non-negative, k <= n\n", n, k); 1891a989b97SToby Isaac if (n <= 3) { 1901a989b97SToby Isaac PetscInt binomLookup[4][4] = {{1, 0, 0, 0}, {1, 1, 0, 0}, {1, 2, 1, 0}, {1, 3, 3, 1}}; 1911a989b97SToby Isaac 192e2ab39ccSLisandro Dalcin *binomial = (PetscReal)binomLookup[n][k]; 1931a989b97SToby Isaac } else { 194e2ab39ccSLisandro Dalcin PetscReal binom = 1.0; 1951a989b97SToby Isaac PetscInt i; 1961a989b97SToby Isaac 1971a989b97SToby Isaac k = PetscMin(k, n - k); 198e2ab39ccSLisandro Dalcin for (i = 0; i < k; i++) binom = (binom * (PetscReal)(n - i)) / (PetscReal)(i + 1); 1991a989b97SToby Isaac *binomial = binom; 2001a989b97SToby Isaac } 2011a989b97SToby Isaac PetscFunctionReturn(0); 2021a989b97SToby Isaac } 2031a989b97SToby Isaac 204fad4db65SToby Isaac /*MC 205fad4db65SToby Isaac PetscDTBinomialInt - Compute the binomial coefficient "n choose k" 206fad4db65SToby Isaac 207*4165533cSJose E. Roman Input Parameter: 208fad4db65SToby Isaac + n - a non-negative integer 209fad4db65SToby Isaac - k - an integer between 0 and n, inclusive 210fad4db65SToby Isaac 211*4165533cSJose E. Roman Output Parameters: 212fad4db65SToby Isaac . binomial - the binomial coefficient n choose k 213fad4db65SToby Isaac 214fad4db65SToby Isaac Note: this is limited by integers that can be represented by PetscInt 215fad4db65SToby Isaac 216fad4db65SToby Isaac Level: beginner 217fad4db65SToby Isaac M*/ 218fad4db65SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTBinomialInt(PetscInt n, PetscInt k, PetscInt *binomial) 219fad4db65SToby Isaac { 22028222859SToby Isaac PetscInt bin; 22128222859SToby Isaac 22228222859SToby Isaac PetscFunctionBegin; 22328222859SToby Isaac *binomial = -1; 224fad4db65SToby Isaac if (n < 0 || k < 0 || k > n) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Binomial arguments (%D %D) must be non-negative, k <= n\n", n, k); 225fad4db65SToby Isaac if (n > PETSC_BINOMIAL_MAX) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Binomial elements %D is larger than max for PetscInt, %D\n", n, PETSC_BINOMIAL_MAX); 226fad4db65SToby Isaac if (n <= 3) { 227fad4db65SToby Isaac PetscInt binomLookup[4][4] = {{1, 0, 0, 0}, {1, 1, 0, 0}, {1, 2, 1, 0}, {1, 3, 3, 1}}; 228fad4db65SToby Isaac 22928222859SToby Isaac bin = binomLookup[n][k]; 230fad4db65SToby Isaac } else { 231fad4db65SToby Isaac PetscInt binom = 1; 232fad4db65SToby Isaac PetscInt i; 233fad4db65SToby Isaac 234fad4db65SToby Isaac k = PetscMin(k, n - k); 235fad4db65SToby Isaac for (i = 0; i < k; i++) binom = (binom * (n - i)) / (i + 1); 23628222859SToby Isaac bin = binom; 237fad4db65SToby Isaac } 23828222859SToby Isaac *binomial = bin; 239fad4db65SToby Isaac PetscFunctionReturn(0); 240fad4db65SToby Isaac } 241fad4db65SToby Isaac 242fad4db65SToby Isaac /*MC 243fad4db65SToby Isaac PetscDTEnumPerm - Get a permutation of n integers from its encoding into the integers [0, n!) as a sequence of swaps. 244fad4db65SToby Isaac 245fad4db65SToby Isaac A permutation can be described by the operations that convert the lists [0, 1, ..., n-1] into the permutation, 246fad4db65SToby Isaac by a sequence of swaps, where the ith step swaps whatever number is in ith position with a number that is in 24728222859SToby Isaac some position j >= i. This swap is encoded as the difference (j - i). The difference d_i at step i is less than 24828222859SToby Isaac (n - i). This sequence of n-1 differences [d_0, ..., d_{n-2}] is encoded as the number 249fad4db65SToby Isaac (n-1)! * d_0 + (n-2)! * d_1 + ... + 1! * d_{n-2}. 250fad4db65SToby Isaac 251*4165533cSJose E. Roman Input Parameters: 252fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 2538cd1e013SToby Isaac - k - an integer in [0, n!) 254fad4db65SToby Isaac 255*4165533cSJose E. Roman Output Parameters: 256fad4db65SToby Isaac + perm - the permuted list of the integers [0, ..., n-1] 2578cd1e013SToby Isaac - isOdd - if not NULL, returns wether the permutation used an even or odd number of swaps. 258fad4db65SToby Isaac 259fad4db65SToby Isaac Note: this is limited to n such that n! can be represented by PetscInt, which is 12 if PetscInt is a signed 32-bit integer and 20 if PetscInt is a signed 64-bit integer. 260fad4db65SToby Isaac 261fad4db65SToby Isaac Level: beginner 262fad4db65SToby Isaac M*/ 263fad4db65SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTEnumPerm(PetscInt n, PetscInt k, PetscInt *perm, PetscBool *isOdd) 2641a989b97SToby Isaac { 2651a989b97SToby Isaac PetscInt odd = 0; 2661a989b97SToby Isaac PetscInt i; 267fad4db65SToby Isaac PetscInt work[PETSC_FACTORIAL_MAX]; 268fad4db65SToby Isaac PetscInt *w; 2691a989b97SToby Isaac 27028222859SToby Isaac PetscFunctionBegin; 27128222859SToby Isaac if (isOdd) *isOdd = PETSC_FALSE; 272fad4db65SToby Isaac if (n < 0 || n > PETSC_FACTORIAL_MAX) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Number of elements %D is not in supported range [0,%D]\n",n,PETSC_FACTORIAL_MAX); 273fad4db65SToby Isaac w = &work[n - 2]; 2741a989b97SToby Isaac for (i = 2; i <= n; i++) { 2751a989b97SToby Isaac *(w--) = k % i; 2761a989b97SToby Isaac k /= i; 2771a989b97SToby Isaac } 2781a989b97SToby Isaac for (i = 0; i < n; i++) perm[i] = i; 2791a989b97SToby Isaac for (i = 0; i < n - 1; i++) { 2801a989b97SToby Isaac PetscInt s = work[i]; 2811a989b97SToby Isaac PetscInt swap = perm[i]; 2821a989b97SToby Isaac 2831a989b97SToby Isaac perm[i] = perm[i + s]; 2841a989b97SToby Isaac perm[i + s] = swap; 2851a989b97SToby Isaac odd ^= (!!s); 2861a989b97SToby Isaac } 2871a989b97SToby Isaac if (isOdd) *isOdd = odd ? PETSC_TRUE : PETSC_FALSE; 2881a989b97SToby Isaac PetscFunctionReturn(0); 2891a989b97SToby Isaac } 2901a989b97SToby Isaac 291fad4db65SToby Isaac /*MC 2928cd1e013SToby Isaac PetscDTPermIndex - Encode a permutation of n into an integer in [0, n!). This inverts PetscDTEnumPerm. 2938cd1e013SToby Isaac 294*4165533cSJose E. Roman Input Parameters: 2958cd1e013SToby Isaac + n - a non-negative integer (see note about limits below) 2968cd1e013SToby Isaac - perm - the permuted list of the integers [0, ..., n-1] 2978cd1e013SToby Isaac 298*4165533cSJose E. Roman Output Parameters: 2998cd1e013SToby Isaac + k - an integer in [0, n!) 300f0fc11ceSJed Brown - isOdd - if not NULL, returns wether the permutation used an even or odd number of swaps. 3018cd1e013SToby Isaac 3028cd1e013SToby Isaac Note: this is limited to n such that n! can be represented by PetscInt, which is 12 if PetscInt is a signed 32-bit integer and 20 if PetscInt is a signed 64-bit integer. 3038cd1e013SToby Isaac 3048cd1e013SToby Isaac Level: beginner 3058cd1e013SToby Isaac M*/ 3068cd1e013SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTPermIndex(PetscInt n, const PetscInt *perm, PetscInt *k, PetscBool *isOdd) 3078cd1e013SToby Isaac { 3088cd1e013SToby Isaac PetscInt odd = 0; 3098cd1e013SToby Isaac PetscInt i, idx; 3108cd1e013SToby Isaac PetscInt work[PETSC_FACTORIAL_MAX]; 3118cd1e013SToby Isaac PetscInt iwork[PETSC_FACTORIAL_MAX]; 3128cd1e013SToby Isaac 3138cd1e013SToby Isaac PetscFunctionBeginHot; 31428222859SToby Isaac *k = -1; 31528222859SToby Isaac if (isOdd) *isOdd = PETSC_FALSE; 3168cd1e013SToby Isaac if (n < 0 || n > PETSC_FACTORIAL_MAX) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Number of elements %D is not in supported range [0,%D]\n",n,PETSC_FACTORIAL_MAX); 3178cd1e013SToby Isaac for (i = 0; i < n; i++) work[i] = i; /* partial permutation */ 3188cd1e013SToby Isaac for (i = 0; i < n; i++) iwork[i] = i; /* partial permutation inverse */ 3198cd1e013SToby Isaac for (idx = 0, i = 0; i < n - 1; i++) { 3208cd1e013SToby Isaac PetscInt j = perm[i]; 3218cd1e013SToby Isaac PetscInt icur = work[i]; 3228cd1e013SToby Isaac PetscInt jloc = iwork[j]; 3238cd1e013SToby Isaac PetscInt diff = jloc - i; 3248cd1e013SToby Isaac 3258cd1e013SToby Isaac idx = idx * (n - i) + diff; 3268cd1e013SToby Isaac /* swap (i, jloc) */ 3278cd1e013SToby Isaac work[i] = j; 3288cd1e013SToby Isaac work[jloc] = icur; 3298cd1e013SToby Isaac iwork[j] = i; 3308cd1e013SToby Isaac iwork[icur] = jloc; 3318cd1e013SToby Isaac odd ^= (!!diff); 3328cd1e013SToby Isaac } 3338cd1e013SToby Isaac *k = idx; 3348cd1e013SToby Isaac if (isOdd) *isOdd = odd ? PETSC_TRUE : PETSC_FALSE; 3358cd1e013SToby Isaac PetscFunctionReturn(0); 3368cd1e013SToby Isaac } 3378cd1e013SToby Isaac 3388cd1e013SToby Isaac /*MC 339fad4db65SToby Isaac PetscDTEnumSubset - Get an ordered subset of the integers [0, ..., n - 1] from its encoding as an integers in [0, n choose k). 340fad4db65SToby Isaac The encoding is in lexicographic order. 341fad4db65SToby Isaac 342*4165533cSJose E. Roman Input Parameters: 343fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 344fad4db65SToby Isaac . k - an integer in [0, n] 345fad4db65SToby Isaac - j - an index in [0, n choose k) 346fad4db65SToby Isaac 347*4165533cSJose E. Roman Output Parameter: 348fad4db65SToby Isaac . subset - the jth subset of size k of the integers [0, ..., n - 1] 349fad4db65SToby Isaac 350fad4db65SToby Isaac Note: this is limited by arguments such that n choose k can be represented by PetscInt 351fad4db65SToby Isaac 352fad4db65SToby Isaac Level: beginner 353fad4db65SToby Isaac 354fad4db65SToby Isaac .seealso: PetscDTSubsetIndex() 355fad4db65SToby Isaac M*/ 3561a989b97SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTEnumSubset(PetscInt n, PetscInt k, PetscInt j, PetscInt *subset) 3571a989b97SToby Isaac { 3581a989b97SToby Isaac PetscInt Nk, i, l; 3591a989b97SToby Isaac PetscErrorCode ierr; 3601a989b97SToby Isaac 3611a989b97SToby Isaac PetscFunctionBeginHot; 362fad4db65SToby Isaac ierr = PetscDTBinomialInt(n, k, &Nk);CHKERRQ(ierr); 3631a989b97SToby Isaac for (i = 0, l = 0; i < n && l < k; i++) { 3641a989b97SToby Isaac PetscInt Nminuskminus = (Nk * (k - l)) / (n - i); 3651a989b97SToby Isaac PetscInt Nminusk = Nk - Nminuskminus; 3661a989b97SToby Isaac 3671a989b97SToby Isaac if (j < Nminuskminus) { 3681a989b97SToby Isaac subset[l++] = i; 3691a989b97SToby Isaac Nk = Nminuskminus; 3701a989b97SToby Isaac } else { 3711a989b97SToby Isaac j -= Nminuskminus; 3721a989b97SToby Isaac Nk = Nminusk; 3731a989b97SToby Isaac } 3741a989b97SToby Isaac } 3751a989b97SToby Isaac PetscFunctionReturn(0); 3761a989b97SToby Isaac } 3771a989b97SToby Isaac 378fad4db65SToby Isaac /*MC 379fad4db65SToby Isaac PetscDTSubsetIndex - Convert an ordered subset of k integers from the set [0, ..., n - 1] to its encoding as an integers in [0, n choose k) in lexicographic order. This is the inverse of PetscDTEnumSubset. 380fad4db65SToby Isaac 381*4165533cSJose E. Roman Input Parameters: 382fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 383fad4db65SToby Isaac . k - an integer in [0, n] 384fad4db65SToby Isaac - subset - an ordered subset of the integers [0, ..., n - 1] 385fad4db65SToby Isaac 386*4165533cSJose E. Roman Output Parameter: 387fad4db65SToby Isaac . index - the rank of the subset in lexicographic order 388fad4db65SToby Isaac 389fad4db65SToby Isaac Note: this is limited by arguments such that n choose k can be represented by PetscInt 390fad4db65SToby Isaac 391fad4db65SToby Isaac Level: beginner 392fad4db65SToby Isaac 393fad4db65SToby Isaac .seealso: PetscDTEnumSubset() 394fad4db65SToby Isaac M*/ 3951a989b97SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTSubsetIndex(PetscInt n, PetscInt k, const PetscInt *subset, PetscInt *index) 3961a989b97SToby Isaac { 3971a989b97SToby Isaac PetscInt i, j = 0, l, Nk; 3981a989b97SToby Isaac PetscErrorCode ierr; 3991a989b97SToby Isaac 40028222859SToby Isaac PetscFunctionBegin; 40128222859SToby Isaac *index = -1; 402fad4db65SToby Isaac ierr = PetscDTBinomialInt(n, k, &Nk);CHKERRQ(ierr); 4031a989b97SToby Isaac for (i = 0, l = 0; i < n && l < k; i++) { 4041a989b97SToby Isaac PetscInt Nminuskminus = (Nk * (k - l)) / (n - i); 4051a989b97SToby Isaac PetscInt Nminusk = Nk - Nminuskminus; 4061a989b97SToby Isaac 4071a989b97SToby Isaac if (subset[l] == i) { 4081a989b97SToby Isaac l++; 4091a989b97SToby Isaac Nk = Nminuskminus; 4101a989b97SToby Isaac } else { 4111a989b97SToby Isaac j += Nminuskminus; 4121a989b97SToby Isaac Nk = Nminusk; 4131a989b97SToby Isaac } 4141a989b97SToby Isaac } 4151a989b97SToby Isaac *index = j; 4161a989b97SToby Isaac PetscFunctionReturn(0); 4171a989b97SToby Isaac } 4181a989b97SToby Isaac 419fad4db65SToby Isaac /*MC 42028222859SToby Isaac PetscDTEnumSubset - Split the integers [0, ..., n - 1] into two complementary ordered subsets, the first subset of size k and being the jth subset of that size in lexicographic order. 421fad4db65SToby Isaac 422*4165533cSJose E. Roman Input Parameters: 423fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 424fad4db65SToby Isaac . k - an integer in [0, n] 425fad4db65SToby Isaac - j - an index in [0, n choose k) 426fad4db65SToby Isaac 427*4165533cSJose E. Roman Output Parameters: 428fad4db65SToby Isaac + perm - the jth subset of size k of the integers [0, ..., n - 1], followed by its complementary set. 42928222859SToby Isaac - isOdd - if not NULL, return whether perm is an even or odd permutation. 430fad4db65SToby Isaac 431fad4db65SToby Isaac Note: this is limited by arguments such that n choose k can be represented by PetscInt 432fad4db65SToby Isaac 433fad4db65SToby Isaac Level: beginner 434fad4db65SToby Isaac 435fad4db65SToby Isaac .seealso: PetscDTEnumSubset(), PetscDTSubsetIndex() 436fad4db65SToby Isaac M*/ 437fad4db65SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscDTEnumSplit(PetscInt n, PetscInt k, PetscInt j, PetscInt *perm, PetscBool *isOdd) 4381a989b97SToby Isaac { 4391a989b97SToby Isaac PetscInt i, l, m, *subcomp, Nk; 4401a989b97SToby Isaac PetscInt odd; 4411a989b97SToby Isaac PetscErrorCode ierr; 4421a989b97SToby Isaac 44328222859SToby Isaac PetscFunctionBegin; 44428222859SToby Isaac if (isOdd) *isOdd = PETSC_FALSE; 445fad4db65SToby Isaac ierr = PetscDTBinomialInt(n, k, &Nk);CHKERRQ(ierr); 4461a989b97SToby Isaac odd = 0; 447fad4db65SToby Isaac subcomp = &perm[k]; 4481a989b97SToby Isaac for (i = 0, l = 0, m = 0; i < n && l < k; i++) { 4491a989b97SToby Isaac PetscInt Nminuskminus = (Nk * (k - l)) / (n - i); 4501a989b97SToby Isaac PetscInt Nminusk = Nk - Nminuskminus; 4511a989b97SToby Isaac 4521a989b97SToby Isaac if (j < Nminuskminus) { 453fad4db65SToby Isaac perm[l++] = i; 4541a989b97SToby Isaac Nk = Nminuskminus; 4551a989b97SToby Isaac } else { 4561a989b97SToby Isaac subcomp[m++] = i; 4571a989b97SToby Isaac j -= Nminuskminus; 4581a989b97SToby Isaac odd ^= ((k - l) & 1); 4591a989b97SToby Isaac Nk = Nminusk; 4601a989b97SToby Isaac } 4611a989b97SToby Isaac } 4621a989b97SToby Isaac for (; i < n; i++) { 4631a989b97SToby Isaac subcomp[m++] = i; 4641a989b97SToby Isaac } 4651a989b97SToby Isaac if (isOdd) *isOdd = odd ? PETSC_TRUE : PETSC_FALSE; 4661a989b97SToby Isaac PetscFunctionReturn(0); 4671a989b97SToby Isaac } 4681a989b97SToby Isaac 469ef0bb6c7SMatthew G. Knepley struct _p_PetscTabulation { 470a5b23f4aSJose E. Roman PetscInt K; /* Indicates a k-jet, namely tabulated derivatives up to order k */ 47119815104SMartin Diehl PetscInt Nr; /* The number of tabulation replicas (often 1) */ 472ef0bb6c7SMatthew G. Knepley PetscInt Np; /* The number of tabulation points in a replica */ 473ef0bb6c7SMatthew G. Knepley PetscInt Nb; /* The number of functions tabulated */ 474ef0bb6c7SMatthew G. Knepley PetscInt Nc; /* The number of function components */ 475ef0bb6c7SMatthew G. Knepley PetscInt cdim; /* The coordinate dimension */ 476ef0bb6c7SMatthew G. Knepley PetscReal **T; /* The tabulation T[K] of functions and their derivatives 477ef0bb6c7SMatthew G. Knepley T[0] = B[Nr*Np][Nb][Nc]: The basis function values at quadrature points 478ef0bb6c7SMatthew G. Knepley T[1] = D[Nr*Np][Nb][Nc][cdim]: The basis function derivatives at quadrature points 479ef0bb6c7SMatthew G. Knepley T[2] = H[Nr*Np][Nb][Nc][cdim][cdim]: The basis function second derivatives at quadrature points */ 480ef0bb6c7SMatthew G. Knepley }; 481ef0bb6c7SMatthew G. Knepley typedef struct _p_PetscTabulation *PetscTabulation; 482ef0bb6c7SMatthew G. Knepley 48337045ce4SJed Brown #endif 484