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[]); 71d8f25ad8SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTPTrimmedSize(PetscInt,PetscInt,PetscInt,PetscInt*); 72d8f25ad8SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTPTrimmedEvalJet(PetscInt,PetscInt,const PetscReal[],PetscInt,PetscInt,PetscInt,PetscReal[]); 7337045ce4SJed Brown PETSC_EXTERN PetscErrorCode PetscDTGaussQuadrature(PetscInt,PetscReal,PetscReal,PetscReal*,PetscReal*); 7494e21283SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTGaussJacobiQuadrature(PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal*,PetscReal*); 7594e21283SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTGaussLobattoJacobiQuadrature(PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal*,PetscReal*); 76916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscDTGaussLobattoLegendreQuadrature(PetscInt,PetscGaussLobattoLegendreCreateType,PetscReal*,PetscReal*); 77194825f6SJed Brown PETSC_EXTERN PetscErrorCode PetscDTReconstructPoly(PetscInt,PetscInt,const PetscReal*,PetscInt,const PetscReal*,PetscReal*); 78a6b92713SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDTGaussTensorQuadrature(PetscInt,PetscInt,PetscInt,PetscReal,PetscReal,PetscQuadrature*); 79e6a796c3SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTStroudConicalQuadrature(PetscInt,PetscInt,PetscInt,PetscReal,PetscReal,PetscQuadrature*); 8037045ce4SJed Brown 81b3c0f97bSTom Klotz PETSC_EXTERN PetscErrorCode PetscDTTanhSinhTensorQuadrature(PetscInt, PetscInt, PetscReal, PetscReal, PetscQuadrature *); 82b3c0f97bSTom Klotz PETSC_EXTERN PetscErrorCode PetscDTTanhSinhIntegrate(void (*)(PetscReal, PetscReal *), PetscReal, PetscReal, PetscInt, PetscReal *); 83d525116cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDTTanhSinhIntegrateMPFR(void (*)(PetscReal, PetscReal *), PetscReal, PetscReal, PetscInt, PetscReal *); 84b3c0f97bSTom Klotz 85916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreIntegrate(PetscInt, PetscReal *, PetscReal *, const PetscReal *, PetscReal *); 86916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementLaplacianCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 87916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementLaplacianDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 88916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementGradientCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***, PetscReal ***); 89916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementGradientDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***, PetscReal ***); 90916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementAdvectionCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 91916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementAdvectionDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 92916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementMassCreate(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 93916e780bShannah_mairs PETSC_EXTERN PetscErrorCode PetscGaussLobattoLegendreElementMassDestroy(PetscInt, PetscReal *, PetscReal *, PetscReal ***); 94916e780bShannah_mairs 951a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVApply(PetscInt, PetscInt, const PetscReal *, const PetscReal *, PetscReal *); 961a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVWedge(PetscInt, PetscInt, PetscInt, const PetscReal *, const PetscReal *, PetscReal *); 971a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVWedgeMatrix(PetscInt, PetscInt, PetscInt, const PetscReal *, PetscReal *); 981a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVPullback(PetscInt, PetscInt, const PetscReal *, PetscInt, const PetscReal *, PetscReal *); 991a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVPullbackMatrix(PetscInt, PetscInt, const PetscReal *, PetscInt, PetscReal *); 1001a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVInterior(PetscInt, PetscInt, const PetscReal *, const PetscReal *, PetscReal *); 1011a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVInteriorMatrix(PetscInt, PetscInt, const PetscReal *, PetscReal *); 102dda711d0SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVInteriorPattern(PetscInt, PetscInt, PetscInt (*)[3]); 1031a989b97SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTAltVStar(PetscInt, PetscInt, PetscInt, const PetscReal *, PetscReal *); 1041a989b97SToby Isaac 105d4afb720SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTBaryToIndex(PetscInt,PetscInt,const PetscInt[],PetscInt*); 106d4afb720SToby Isaac PETSC_EXTERN PetscErrorCode PetscDTIndexToBary(PetscInt,PetscInt,PetscInt,PetscInt[]); 107fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTGradedOrderToIndex(PetscInt,const PetscInt[],PetscInt*); 108fbdc3dfeSToby Isaac PETSC_EXTERN PetscErrorCode PetscDTIndexToGradedOrder(PetscInt,PetscInt,PetscInt[]); 109d4afb720SToby Isaac 110fad4db65SToby Isaac #if defined(PETSC_USE_64BIT_INDICES) 111fad4db65SToby Isaac #define PETSC_FACTORIAL_MAX 20 112fad4db65SToby Isaac #define PETSC_BINOMIAL_MAX 61 113fad4db65SToby Isaac #else 114fad4db65SToby Isaac #define PETSC_FACTORIAL_MAX 12 115fad4db65SToby Isaac #define PETSC_BINOMIAL_MAX 29 116fad4db65SToby Isaac #endif 117fad4db65SToby Isaac 118fad4db65SToby Isaac /*MC 119fad4db65SToby Isaac PetscDTFactorial - Approximate n! as a real number 120fad4db65SToby Isaac 1214165533cSJose E. Roman Input Parameter: 122fad4db65SToby Isaac . n - a non-negative integer 123fad4db65SToby Isaac 1244165533cSJose E. Roman Output Parameter: 125fad4db65SToby Isaac . factorial - n! 126fad4db65SToby Isaac 127fad4db65SToby Isaac Level: beginner 128fad4db65SToby Isaac M*/ 129*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTFactorial(PetscInt n, PetscReal *factorial) 130fad4db65SToby Isaac { 131fad4db65SToby Isaac PetscReal f = 1.0; 132fad4db65SToby Isaac PetscInt i; 133fad4db65SToby Isaac 134fad4db65SToby Isaac PetscFunctionBegin; 135e2ab39ccSLisandro Dalcin *factorial = -1.0; 1369a202e32SJacob Faibussowitsch PetscAssert(n >= 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Factorial called with negative number %D", n); 137e2ab39ccSLisandro Dalcin for (i = 1; i < n+1; ++i) f *= (PetscReal)i; 138fad4db65SToby Isaac *factorial = f; 139fad4db65SToby Isaac PetscFunctionReturn(0); 140fad4db65SToby Isaac } 141fad4db65SToby Isaac 142fad4db65SToby Isaac /*MC 143fad4db65SToby Isaac PetscDTFactorialInt - Compute n! as an integer 144fad4db65SToby Isaac 1454165533cSJose E. Roman Input Parameter: 146fad4db65SToby Isaac . n - a non-negative integer 147fad4db65SToby Isaac 1484165533cSJose E. Roman Output Parameter: 149fad4db65SToby Isaac . factorial - n! 150fad4db65SToby Isaac 151fad4db65SToby Isaac Level: beginner 152fad4db65SToby Isaac 153fad4db65SToby 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. 154fad4db65SToby Isaac M*/ 155*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTFactorialInt(PetscInt n, PetscInt *factorial) 156fad4db65SToby Isaac { 157fad4db65SToby Isaac PetscInt facLookup[13] = {1, 1, 2, 6, 24, 120, 720, 5040, 40320, 362880, 3628800, 39916800, 479001600}; 158fad4db65SToby Isaac 15928222859SToby Isaac PetscFunctionBegin; 16028222859SToby Isaac *factorial = -1; 1619a202e32SJacob Faibussowitsch PetscAssert(n >= 0 && n <= PETSC_FACTORIAL_MAX,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Number of elements %D is not in supported range [0,%D]",n,PETSC_FACTORIAL_MAX); 162fad4db65SToby Isaac if (n <= 12) { 163fad4db65SToby Isaac *factorial = facLookup[n]; 164fad4db65SToby Isaac } else { 165fad4db65SToby Isaac PetscInt f = facLookup[12]; 166fad4db65SToby Isaac PetscInt i; 167fad4db65SToby Isaac 168fad4db65SToby Isaac for (i = 13; i < n+1; ++i) f *= i; 169fad4db65SToby Isaac *factorial = f; 170fad4db65SToby Isaac } 171fad4db65SToby Isaac PetscFunctionReturn(0); 172fad4db65SToby Isaac } 173fad4db65SToby Isaac 174fad4db65SToby Isaac /*MC 175fad4db65SToby Isaac PetscDTBinomial - Approximate the binomial coefficient "n choose k" 176fad4db65SToby Isaac 1774165533cSJose E. Roman Input Parameters: 178fad4db65SToby Isaac + n - a non-negative integer 179fad4db65SToby Isaac - k - an integer between 0 and n, inclusive 180fad4db65SToby Isaac 1814165533cSJose E. Roman Output Parameter: 182fad4db65SToby Isaac . binomial - approximation of the binomial coefficient n choose k 183fad4db65SToby Isaac 184fad4db65SToby Isaac Level: beginner 185fad4db65SToby Isaac M*/ 186*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTBinomial(PetscInt n, PetscInt k, PetscReal *binomial) 1871a989b97SToby Isaac { 1881a989b97SToby Isaac PetscFunctionBeginHot; 189e2ab39ccSLisandro Dalcin *binomial = -1.0; 1909a202e32SJacob Faibussowitsch PetscAssert(n >= 0 && k >= 0 && k <= n,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Binomial arguments (%D %D) must be non-negative, k <= n", n, k); 1911a989b97SToby Isaac if (n <= 3) { 1921a989b97SToby Isaac PetscInt binomLookup[4][4] = {{1, 0, 0, 0}, {1, 1, 0, 0}, {1, 2, 1, 0}, {1, 3, 3, 1}}; 1931a989b97SToby Isaac 194e2ab39ccSLisandro Dalcin *binomial = (PetscReal)binomLookup[n][k]; 1951a989b97SToby Isaac } else { 196e2ab39ccSLisandro Dalcin PetscReal binom = 1.0; 1971a989b97SToby Isaac PetscInt i; 1981a989b97SToby Isaac 1991a989b97SToby Isaac k = PetscMin(k, n - k); 200e2ab39ccSLisandro Dalcin for (i = 0; i < k; i++) binom = (binom * (PetscReal)(n - i)) / (PetscReal)(i + 1); 2011a989b97SToby Isaac *binomial = binom; 2021a989b97SToby Isaac } 2031a989b97SToby Isaac PetscFunctionReturn(0); 2041a989b97SToby Isaac } 2051a989b97SToby Isaac 206fad4db65SToby Isaac /*MC 207fad4db65SToby Isaac PetscDTBinomialInt - Compute the binomial coefficient "n choose k" 208fad4db65SToby Isaac 20997bb3fdcSJose E. Roman Input Parameters: 210fad4db65SToby Isaac + n - a non-negative integer 211fad4db65SToby Isaac - k - an integer between 0 and n, inclusive 212fad4db65SToby Isaac 21397bb3fdcSJose E. Roman Output Parameter: 214fad4db65SToby Isaac . binomial - the binomial coefficient n choose k 215fad4db65SToby Isaac 216fad4db65SToby Isaac Note: this is limited by integers that can be represented by PetscInt 217fad4db65SToby Isaac 218fad4db65SToby Isaac Level: beginner 219fad4db65SToby Isaac M*/ 220*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTBinomialInt(PetscInt n, PetscInt k, PetscInt *binomial) 221fad4db65SToby Isaac { 22228222859SToby Isaac PetscInt bin; 22328222859SToby Isaac 22428222859SToby Isaac PetscFunctionBegin; 22528222859SToby Isaac *binomial = -1; 2269a202e32SJacob Faibussowitsch PetscAssert(n >= 0 && k >= 0 && k <= n,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Binomial arguments (%D %D) must be non-negative, k <= n", n, k); 2279a202e32SJacob Faibussowitsch PetscAssert(n <= PETSC_BINOMIAL_MAX,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Binomial elements %D is larger than max for PetscInt, %D", n, PETSC_BINOMIAL_MAX); 228fad4db65SToby Isaac if (n <= 3) { 229fad4db65SToby Isaac PetscInt binomLookup[4][4] = {{1, 0, 0, 0}, {1, 1, 0, 0}, {1, 2, 1, 0}, {1, 3, 3, 1}}; 230fad4db65SToby Isaac 23128222859SToby Isaac bin = binomLookup[n][k]; 232fad4db65SToby Isaac } else { 233fad4db65SToby Isaac PetscInt binom = 1; 234fad4db65SToby Isaac PetscInt i; 235fad4db65SToby Isaac 236fad4db65SToby Isaac k = PetscMin(k, n - k); 237fad4db65SToby Isaac for (i = 0; i < k; i++) binom = (binom * (n - i)) / (i + 1); 23828222859SToby Isaac bin = binom; 239fad4db65SToby Isaac } 24028222859SToby Isaac *binomial = bin; 241fad4db65SToby Isaac PetscFunctionReturn(0); 242fad4db65SToby Isaac } 243fad4db65SToby Isaac 244fad4db65SToby Isaac /*MC 245fad4db65SToby Isaac PetscDTEnumPerm - Get a permutation of n integers from its encoding into the integers [0, n!) as a sequence of swaps. 246fad4db65SToby Isaac 247fad4db65SToby Isaac A permutation can be described by the operations that convert the lists [0, 1, ..., n-1] into the permutation, 248fad4db65SToby Isaac by a sequence of swaps, where the ith step swaps whatever number is in ith position with a number that is in 24928222859SToby Isaac some position j >= i. This swap is encoded as the difference (j - i). The difference d_i at step i is less than 25028222859SToby Isaac (n - i). This sequence of n-1 differences [d_0, ..., d_{n-2}] is encoded as the number 251fad4db65SToby Isaac (n-1)! * d_0 + (n-2)! * d_1 + ... + 1! * d_{n-2}. 252fad4db65SToby Isaac 2534165533cSJose E. Roman Input Parameters: 254fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 2558cd1e013SToby Isaac - k - an integer in [0, n!) 256fad4db65SToby Isaac 2574165533cSJose E. Roman Output Parameters: 258fad4db65SToby Isaac + perm - the permuted list of the integers [0, ..., n-1] 2598cd1e013SToby Isaac - isOdd - if not NULL, returns wether the permutation used an even or odd number of swaps. 260fad4db65SToby Isaac 261fad4db65SToby 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. 262fad4db65SToby Isaac 263fad4db65SToby Isaac Level: beginner 264fad4db65SToby Isaac M*/ 265*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTEnumPerm(PetscInt n, PetscInt k, PetscInt *perm, PetscBool *isOdd) 2661a989b97SToby Isaac { 2671a989b97SToby Isaac PetscInt odd = 0; 2681a989b97SToby Isaac PetscInt i; 269fad4db65SToby Isaac PetscInt work[PETSC_FACTORIAL_MAX]; 270fad4db65SToby Isaac PetscInt *w; 2711a989b97SToby Isaac 27228222859SToby Isaac PetscFunctionBegin; 27328222859SToby Isaac if (isOdd) *isOdd = PETSC_FALSE; 2749a202e32SJacob Faibussowitsch PetscAssert(n >= 0 && n <= PETSC_FACTORIAL_MAX,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Number of elements %D is not in supported range [0,%D]",n,PETSC_FACTORIAL_MAX); 275fad4db65SToby Isaac w = &work[n - 2]; 2761a989b97SToby Isaac for (i = 2; i <= n; i++) { 2771a989b97SToby Isaac *(w--) = k % i; 2781a989b97SToby Isaac k /= i; 2791a989b97SToby Isaac } 2801a989b97SToby Isaac for (i = 0; i < n; i++) perm[i] = i; 2811a989b97SToby Isaac for (i = 0; i < n - 1; i++) { 2821a989b97SToby Isaac PetscInt s = work[i]; 2831a989b97SToby Isaac PetscInt swap = perm[i]; 2841a989b97SToby Isaac 2851a989b97SToby Isaac perm[i] = perm[i + s]; 2861a989b97SToby Isaac perm[i + s] = swap; 2871a989b97SToby Isaac odd ^= (!!s); 2881a989b97SToby Isaac } 2891a989b97SToby Isaac if (isOdd) *isOdd = odd ? PETSC_TRUE : PETSC_FALSE; 2901a989b97SToby Isaac PetscFunctionReturn(0); 2911a989b97SToby Isaac } 2921a989b97SToby Isaac 293fad4db65SToby Isaac /*MC 2948cd1e013SToby Isaac PetscDTPermIndex - Encode a permutation of n into an integer in [0, n!). This inverts PetscDTEnumPerm. 2958cd1e013SToby Isaac 2964165533cSJose E. Roman Input Parameters: 2978cd1e013SToby Isaac + n - a non-negative integer (see note about limits below) 2988cd1e013SToby Isaac - perm - the permuted list of the integers [0, ..., n-1] 2998cd1e013SToby Isaac 3004165533cSJose E. Roman Output Parameters: 3018cd1e013SToby Isaac + k - an integer in [0, n!) 302f0fc11ceSJed Brown - isOdd - if not NULL, returns wether the permutation used an even or odd number of swaps. 3038cd1e013SToby Isaac 3048cd1e013SToby 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. 3058cd1e013SToby Isaac 3068cd1e013SToby Isaac Level: beginner 3078cd1e013SToby Isaac M*/ 308*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTPermIndex(PetscInt n, const PetscInt *perm, PetscInt *k, PetscBool *isOdd) 3098cd1e013SToby Isaac { 3108cd1e013SToby Isaac PetscInt odd = 0; 3118cd1e013SToby Isaac PetscInt i, idx; 3128cd1e013SToby Isaac PetscInt work[PETSC_FACTORIAL_MAX]; 3138cd1e013SToby Isaac PetscInt iwork[PETSC_FACTORIAL_MAX]; 3148cd1e013SToby Isaac 3158cd1e013SToby Isaac PetscFunctionBeginHot; 31628222859SToby Isaac *k = -1; 31728222859SToby Isaac if (isOdd) *isOdd = PETSC_FALSE; 3189a202e32SJacob Faibussowitsch PetscAssert(n >= 0 && n <= PETSC_FACTORIAL_MAX,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Number of elements %D is not in supported range [0,%D]",n,PETSC_FACTORIAL_MAX); 3198cd1e013SToby Isaac for (i = 0; i < n; i++) work[i] = i; /* partial permutation */ 3208cd1e013SToby Isaac for (i = 0; i < n; i++) iwork[i] = i; /* partial permutation inverse */ 3218cd1e013SToby Isaac for (idx = 0, i = 0; i < n - 1; i++) { 3228cd1e013SToby Isaac PetscInt j = perm[i]; 3238cd1e013SToby Isaac PetscInt icur = work[i]; 3248cd1e013SToby Isaac PetscInt jloc = iwork[j]; 3258cd1e013SToby Isaac PetscInt diff = jloc - i; 3268cd1e013SToby Isaac 3278cd1e013SToby Isaac idx = idx * (n - i) + diff; 3288cd1e013SToby Isaac /* swap (i, jloc) */ 3298cd1e013SToby Isaac work[i] = j; 3308cd1e013SToby Isaac work[jloc] = icur; 3318cd1e013SToby Isaac iwork[j] = i; 3328cd1e013SToby Isaac iwork[icur] = jloc; 3338cd1e013SToby Isaac odd ^= (!!diff); 3348cd1e013SToby Isaac } 3358cd1e013SToby Isaac *k = idx; 3368cd1e013SToby Isaac if (isOdd) *isOdd = odd ? PETSC_TRUE : PETSC_FALSE; 3378cd1e013SToby Isaac PetscFunctionReturn(0); 3388cd1e013SToby Isaac } 3398cd1e013SToby Isaac 3408cd1e013SToby Isaac /*MC 341fad4db65SToby Isaac PetscDTEnumSubset - Get an ordered subset of the integers [0, ..., n - 1] from its encoding as an integers in [0, n choose k). 342fad4db65SToby Isaac The encoding is in lexicographic order. 343fad4db65SToby Isaac 3444165533cSJose E. Roman Input Parameters: 345fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 346fad4db65SToby Isaac . k - an integer in [0, n] 347fad4db65SToby Isaac - j - an index in [0, n choose k) 348fad4db65SToby Isaac 3494165533cSJose E. Roman Output Parameter: 350fad4db65SToby Isaac . subset - the jth subset of size k of the integers [0, ..., n - 1] 351fad4db65SToby Isaac 352fad4db65SToby Isaac Note: this is limited by arguments such that n choose k can be represented by PetscInt 353fad4db65SToby Isaac 354fad4db65SToby Isaac Level: beginner 355fad4db65SToby Isaac 356fad4db65SToby Isaac .seealso: PetscDTSubsetIndex() 357fad4db65SToby Isaac M*/ 358*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTEnumSubset(PetscInt n, PetscInt k, PetscInt j, PetscInt *subset) 3591a989b97SToby Isaac { 3601a989b97SToby Isaac PetscInt Nk, i, l; 3611a989b97SToby Isaac PetscErrorCode ierr; 3621a989b97SToby Isaac 3631a989b97SToby Isaac PetscFunctionBeginHot; 364fad4db65SToby Isaac ierr = PetscDTBinomialInt(n, k, &Nk);CHKERRQ(ierr); 3651a989b97SToby Isaac for (i = 0, l = 0; i < n && l < k; i++) { 3661a989b97SToby Isaac PetscInt Nminuskminus = (Nk * (k - l)) / (n - i); 3671a989b97SToby Isaac PetscInt Nminusk = Nk - Nminuskminus; 3681a989b97SToby Isaac 3691a989b97SToby Isaac if (j < Nminuskminus) { 3701a989b97SToby Isaac subset[l++] = i; 3711a989b97SToby Isaac Nk = Nminuskminus; 3721a989b97SToby Isaac } else { 3731a989b97SToby Isaac j -= Nminuskminus; 3741a989b97SToby Isaac Nk = Nminusk; 3751a989b97SToby Isaac } 3761a989b97SToby Isaac } 3771a989b97SToby Isaac PetscFunctionReturn(0); 3781a989b97SToby Isaac } 3791a989b97SToby Isaac 380fad4db65SToby Isaac /*MC 381fad4db65SToby 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. 382fad4db65SToby Isaac 3834165533cSJose E. Roman Input Parameters: 384fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 385fad4db65SToby Isaac . k - an integer in [0, n] 386fad4db65SToby Isaac - subset - an ordered subset of the integers [0, ..., n - 1] 387fad4db65SToby Isaac 3884165533cSJose E. Roman Output Parameter: 389fad4db65SToby Isaac . index - the rank of the subset in lexicographic order 390fad4db65SToby Isaac 391fad4db65SToby Isaac Note: this is limited by arguments such that n choose k can be represented by PetscInt 392fad4db65SToby Isaac 393fad4db65SToby Isaac Level: beginner 394fad4db65SToby Isaac 395fad4db65SToby Isaac .seealso: PetscDTEnumSubset() 396fad4db65SToby Isaac M*/ 397*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTSubsetIndex(PetscInt n, PetscInt k, const PetscInt *subset, PetscInt *index) 3981a989b97SToby Isaac { 3991a989b97SToby Isaac PetscInt i, j = 0, l, Nk; 4001a989b97SToby Isaac PetscErrorCode ierr; 4011a989b97SToby Isaac 40228222859SToby Isaac PetscFunctionBegin; 40328222859SToby Isaac *index = -1; 404fad4db65SToby Isaac ierr = PetscDTBinomialInt(n, k, &Nk);CHKERRQ(ierr); 4051a989b97SToby Isaac for (i = 0, l = 0; i < n && l < k; i++) { 4061a989b97SToby Isaac PetscInt Nminuskminus = (Nk * (k - l)) / (n - i); 4071a989b97SToby Isaac PetscInt Nminusk = Nk - Nminuskminus; 4081a989b97SToby Isaac 4091a989b97SToby Isaac if (subset[l] == i) { 4101a989b97SToby Isaac l++; 4111a989b97SToby Isaac Nk = Nminuskminus; 4121a989b97SToby Isaac } else { 4131a989b97SToby Isaac j += Nminuskminus; 4141a989b97SToby Isaac Nk = Nminusk; 4151a989b97SToby Isaac } 4161a989b97SToby Isaac } 4171a989b97SToby Isaac *index = j; 4181a989b97SToby Isaac PetscFunctionReturn(0); 4191a989b97SToby Isaac } 4201a989b97SToby Isaac 421fad4db65SToby Isaac /*MC 42228222859SToby 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. 423fad4db65SToby Isaac 4244165533cSJose E. Roman Input Parameters: 425fad4db65SToby Isaac + n - a non-negative integer (see note about limits below) 426fad4db65SToby Isaac . k - an integer in [0, n] 427fad4db65SToby Isaac - j - an index in [0, n choose k) 428fad4db65SToby Isaac 4294165533cSJose E. Roman Output Parameters: 430fad4db65SToby Isaac + perm - the jth subset of size k of the integers [0, ..., n - 1], followed by its complementary set. 43128222859SToby Isaac - isOdd - if not NULL, return whether perm is an even or odd permutation. 432fad4db65SToby Isaac 433fad4db65SToby Isaac Note: this is limited by arguments such that n choose k can be represented by PetscInt 434fad4db65SToby Isaac 435fad4db65SToby Isaac Level: beginner 436fad4db65SToby Isaac 437fad4db65SToby Isaac .seealso: PetscDTEnumSubset(), PetscDTSubsetIndex() 438fad4db65SToby Isaac M*/ 439*9fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscDTEnumSplit(PetscInt n, PetscInt k, PetscInt j, PetscInt *perm, PetscBool *isOdd) 4401a989b97SToby Isaac { 4411a989b97SToby Isaac PetscInt i, l, m, *subcomp, Nk; 4421a989b97SToby Isaac PetscInt odd; 4431a989b97SToby Isaac PetscErrorCode ierr; 4441a989b97SToby Isaac 44528222859SToby Isaac PetscFunctionBegin; 44628222859SToby Isaac if (isOdd) *isOdd = PETSC_FALSE; 447fad4db65SToby Isaac ierr = PetscDTBinomialInt(n, k, &Nk);CHKERRQ(ierr); 4481a989b97SToby Isaac odd = 0; 449fad4db65SToby Isaac subcomp = &perm[k]; 4501a989b97SToby Isaac for (i = 0, l = 0, m = 0; i < n && l < k; i++) { 4511a989b97SToby Isaac PetscInt Nminuskminus = (Nk * (k - l)) / (n - i); 4521a989b97SToby Isaac PetscInt Nminusk = Nk - Nminuskminus; 4531a989b97SToby Isaac 4541a989b97SToby Isaac if (j < Nminuskminus) { 455fad4db65SToby Isaac perm[l++] = i; 4561a989b97SToby Isaac Nk = Nminuskminus; 4571a989b97SToby Isaac } else { 4581a989b97SToby Isaac subcomp[m++] = i; 4591a989b97SToby Isaac j -= Nminuskminus; 4601a989b97SToby Isaac odd ^= ((k - l) & 1); 4611a989b97SToby Isaac Nk = Nminusk; 4621a989b97SToby Isaac } 4631a989b97SToby Isaac } 4641a989b97SToby Isaac for (; i < n; i++) { 4651a989b97SToby Isaac subcomp[m++] = i; 4661a989b97SToby Isaac } 4671a989b97SToby Isaac if (isOdd) *isOdd = odd ? PETSC_TRUE : PETSC_FALSE; 4681a989b97SToby Isaac PetscFunctionReturn(0); 4691a989b97SToby Isaac } 4701a989b97SToby Isaac 471ef0bb6c7SMatthew G. Knepley struct _p_PetscTabulation { 472a5b23f4aSJose E. Roman PetscInt K; /* Indicates a k-jet, namely tabulated derivatives up to order k */ 47319815104SMartin Diehl PetscInt Nr; /* The number of tabulation replicas (often 1) */ 474ef0bb6c7SMatthew G. Knepley PetscInt Np; /* The number of tabulation points in a replica */ 475ef0bb6c7SMatthew G. Knepley PetscInt Nb; /* The number of functions tabulated */ 476ef0bb6c7SMatthew G. Knepley PetscInt Nc; /* The number of function components */ 477ef0bb6c7SMatthew G. Knepley PetscInt cdim; /* The coordinate dimension */ 478ef0bb6c7SMatthew G. Knepley PetscReal **T; /* The tabulation T[K] of functions and their derivatives 479ef0bb6c7SMatthew G. Knepley T[0] = B[Nr*Np][Nb][Nc]: The basis function values at quadrature points 480ef0bb6c7SMatthew G. Knepley T[1] = D[Nr*Np][Nb][Nc][cdim]: The basis function derivatives at quadrature points 481ef0bb6c7SMatthew G. Knepley T[2] = H[Nr*Np][Nb][Nc][cdim][cdim]: The basis function second derivatives at quadrature points */ 482ef0bb6c7SMatthew G. Knepley }; 483ef0bb6c7SMatthew G. Knepley typedef struct _p_PetscTabulation *PetscTabulation; 484ef0bb6c7SMatthew G. Knepley 48537045ce4SJed Brown #endif 486