xref: /libCEED/include/ceed-impl.h (revision 973cf5951173c35f1fa3c0f7abe77bac163b658b)
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);
43 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
44 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
45 CEED_INTERN int CeedFree(void *p);
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)
52 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
53 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
54 
55 struct CeedVector_private {
56   Ceed ceed;
57   int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *);
58   int (*GetArray)(CeedVector, CeedMemType, CeedScalar **);
59   int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **);
60   int (*RestoreArray)(CeedVector, CeedScalar **);
61   int (*RestoreArrayRead)(CeedVector, const CeedScalar **);
62   int (*Destroy)(CeedVector);
63   CeedInt length;
64   void *data;
65 };
66 
67 struct CeedElemRestriction_private {
68   Ceed ceed;
69   int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedInt, CeedTransposeMode,
70                CeedVector, CeedVector, CeedRequest *);
71   int (*Destroy)(CeedElemRestriction);
72   CeedInt nelem;    /* number of elements */
73   CeedInt elemsize; /* number of dofs per element */
74   CeedInt ndof;     /* size of the L-vector, can be used for checking for
75                        correct vector sizes */
76   void *data;       /* place for the backend to store any data */
77 };
78 
79 struct CeedBasis_private {
80   Ceed ceed;
81   int (*Apply)(CeedBasis, CeedTransposeMode, CeedEvalMode, const CeedScalar *,
82                CeedScalar *);
83   int (*Destroy)(CeedBasis);
84   CeedInt dim;
85   CeedInt ndof;
86   CeedInt P1d;
87   CeedInt Q1d;
88   CeedScalar *qref1d;
89   CeedScalar *qweight1d;
90   CeedScalar *interp1d;
91   CeedScalar *grad1d;
92   void *data;       /* place for the backend to store any data */
93 };
94 
95 /* FIXME: The number of in-fields and out-fields may be different? */
96 /* FIXME: Shouldn't inmode and outmode be per-in-field and per-out-field,
97    respectively? */
98 struct CeedQFunction_private {
99   Ceed ceed;
100   int (*Apply)(CeedQFunction, void *, CeedInt, const CeedScalar *const *,
101                CeedScalar *const *);
102   int (*Destroy)(CeedQFunction);
103   CeedInt vlength;    // Number of quadrature points must be padded to a multiple of vlength
104   CeedInt nfields;
105   size_t qdatasize;   // Number of bytes of qdata per quadrature point
106   CeedEvalMode inmode, outmode;
107   int (*function)(void *, void *, CeedInt, const CeedScalar *const *,
108                   CeedScalar *const *);
109   const char *focca;
110   void *ctx;      /* user context for function */
111   size_t ctxsize; /* size of user context; may be used to copy to a device */
112   void *data;     /* backend data */
113 };
114 
115 struct CeedOperator_private {
116   Ceed ceed;
117   int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedRequest *);
118   int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector,
119                        CeedVector, CeedRequest *);
120   int (*GetQData)(CeedOperator, CeedVector *);
121   int (*Destroy)(CeedOperator);
122   CeedElemRestriction Erestrict;
123   CeedBasis basis;
124   CeedQFunction qf;
125   CeedQFunction dqf;
126   CeedQFunction dqfT;
127   void *data;
128 };
129 
130 #endif
131