xref: /libCEED/include/ceed-impl.h (revision e36deacd66b8a396a30ce35a93f58a1debb05da0)
1 // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at
2 // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights
3 // reserved. See files LICENSE and NOTICE for details.
4 //
5 // This file is part of CEED, a collection of benchmarks, miniapps, software
6 // libraries and APIs for efficient high-order finite element and spectral
7 // element discretizations for exascale applications. For more information and
8 // source code availability see http://github.com/ceed.
9 //
10 // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC,
11 // a collaborative effort of two U.S. Department of Energy organizations (Office
12 // of Science and the National Nuclear Security Administration) responsible for
13 // the planning and preparation of a capable exascale ecosystem, including
14 // software, applications, hardware, advanced system engineering and early
15 // testbed platforms, in support of the nation's exascale computing imperative.
16 
17 #ifndef _ceed_impl_h
18 #define _ceed_impl_h
19 
20 #include <ceed.h>
21 
22 #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden")))
23 
24 #define CEED_MAX_RESOURCE_LEN 1024
25 #define CEED_ALIGN 64
26 
27 struct Ceed_private {
28   int (*Error)(Ceed, const char *, int, const char *, int, const char *, va_list);
29   int (*Destroy)(Ceed);
30   int (*VecCreate)(Ceed, CeedInt, CeedVector);
31   int (*ElemRestrictionCreate)(CeedElemRestriction, CeedMemType, CeedCopyMode,
32                                const CeedInt *);
33   int (*BasisCreateTensorH1)(Ceed, CeedInt, CeedInt, CeedInt, const CeedScalar *,
34                              const CeedScalar *, const CeedScalar *, const CeedScalar *, CeedBasis);
35   int (*QFunctionCreate)(CeedQFunction);
36   int (*OperatorCreate)(CeedOperator);
37   void *data;
38 };
39 
40 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p
41    has to be a pointer to a pointer. */
42 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p, char*, int);
43 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p, char*, int);
44 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p, char*, int);
45 CEED_INTERN int CeedFreeImpl(void *p, char*, int);
46 
47 #define CeedChk(ierr) do { if (ierr) return ierr; } while (0)
48 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with
49    different memory alignments: CeedMalloc returns pointers aligned at
50    CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
51 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p,__FILE__,__LINE__)
52 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p,__FILE__,__LINE__)
53 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p,__FILE__,__LINE__)
54 #define CeedFree(p) CeedFreeImpl(p,__FILE__,__LINE__)
55 
56 void CeedDebug(const char *,...);
57 
58 struct CeedVector_private {
59   Ceed ceed;
60   int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *);
61   int (*GetArray)(CeedVector, CeedMemType, CeedScalar **);
62   int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **);
63   int (*RestoreArray)(CeedVector, CeedScalar **);
64   int (*RestoreArrayRead)(CeedVector, const CeedScalar **);
65   int (*Destroy)(CeedVector);
66   CeedInt length;
67   void *data;
68 };
69 
70 struct CeedElemRestriction_private {
71   Ceed ceed;
72   int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedInt, CeedTransposeMode,
73                CeedVector, CeedVector, CeedRequest *);
74   int (*Destroy)(CeedElemRestriction);
75   CeedInt nelem;    /* number of elements */
76   CeedInt elemsize; /* number of dofs per element */
77   CeedInt ndof;     /* size of the L-vector, can be used for checking for
78                        correct vector sizes */
79   void *data;       /* place for the backend to store any data */
80 };
81 
82 struct CeedBasis_private {
83   Ceed ceed;
84   int (*Apply)(CeedBasis, CeedTransposeMode, CeedEvalMode, const CeedScalar *,
85                CeedScalar *);
86   int (*Destroy)(CeedBasis);
87   CeedInt dim;
88   CeedInt ndof;
89   CeedInt P1d;
90   CeedInt Q1d;
91   CeedScalar *qref1d;
92   CeedScalar *qweight1d;
93   CeedScalar *interp1d;
94   CeedScalar *grad1d;
95 };
96 
97 /* FIXME: The number of in-fields and out-fields may be different? */
98 /* FIXME: Shouldn't inmode and outmode be per-in-field and per-out-field,
99    respectively? */
100 struct CeedQFunction_private {
101   Ceed ceed;
102   int (*Apply)(CeedQFunction, void *, CeedInt, const CeedScalar *const *,
103                CeedScalar *const *);
104   int (*Destroy)(CeedQFunction);
105   CeedInt vlength;    // Number of quadrature points must be padded to a multiple of vlength
106   CeedInt nfields;
107   size_t qdatasize;   // Number of bytes of qdata per quadrature point
108   CeedEvalMode inmode, outmode;
109   int (*function)(void *, void *, CeedInt, const CeedScalar *const *,
110                   CeedScalar *const *);
111   const char *focca;
112   void *ctx;      /* user context for function */
113   size_t ctxsize; /* size of user context; may be used to copy to a device */
114   void *data;     /* backend data */
115 };
116 
117 struct CeedOperator_private {
118   Ceed ceed;
119   int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedRequest *);
120   int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector,
121                        CeedVector, CeedRequest *);
122   int (*GetQData)(CeedOperator, CeedVector *);
123   int (*Destroy)(CeedOperator);
124   CeedElemRestriction Erestrict;
125   CeedBasis basis;
126   CeedQFunction qf;
127   CeedQFunction dqf;
128   CeedQFunction dqfT;
129   void *data;
130 };
131 
132 #endif
133