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