xref: /libCEED/include/ceed-impl.h (revision 854cbf70de37174a9b5ec5333ac9ee11a403059f)
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 /// @file
18 /// Private header for frontend components of libCEED
19 #ifndef _ceed_impl_h
20 #define _ceed_impl_h
21 
22 #include <ceed.h>
23 #include <ceed-backend.h>
24 #include <stdbool.h>
25 
26 #define CEED_EPSILON 1E-16
27 
28 // Lookup table field for backend functions
29 typedef struct {
30   const char *fname;
31   size_t offset;
32 } foffset;
33 
34 // Lookup table field for object delegates
35 typedef struct {
36   char *objname;
37   Ceed delegate;
38 } objdelegate;
39 
40 struct Ceed_private {
41   const char *resource;
42   Ceed delegate;
43   Ceed parent;
44   objdelegate *objdelegates;
45   int objdelegatecount;
46   Ceed opfallbackceed, opfallbackparent;
47   const char *opfallbackresource;
48   int (*Error)(Ceed, const char *, int, const char *, int, const char *,
49                va_list);
50   int (*GetPreferredMemType)(CeedMemType *);
51   int (*Destroy)(Ceed);
52   int (*VectorCreate)(CeedInt, CeedVector);
53   int (*ElemRestrictionCreate)(CeedMemType, CeedCopyMode,
54                                const CeedInt *, CeedElemRestriction);
55   int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode,
56                                       const CeedInt *, CeedElemRestriction);
57   int (*BasisCreateTensorH1)(CeedInt, CeedInt, CeedInt, const CeedScalar *,
58                              const CeedScalar *, const CeedScalar *,
59                              const CeedScalar *, CeedBasis);
60   int (*BasisCreateH1)(CeedElemTopology, CeedInt, CeedInt, CeedInt,
61                        const CeedScalar *,
62                        const CeedScalar *, const CeedScalar *,
63                        const CeedScalar *, CeedBasis);
64   int (*TensorContractCreate)(CeedBasis, CeedTensorContract);
65   int (*QFunctionCreate)(CeedQFunction);
66   int (*OperatorCreate)(CeedOperator);
67   int (*CompositeOperatorCreate)(CeedOperator);
68   int refcount;
69   void *data;
70   foffset *foffsets;
71 };
72 
73 struct CeedVector_private {
74   Ceed ceed;
75   int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *);
76   int (*SetValue)(CeedVector, CeedScalar);
77   int (*SyncArray)(CeedVector, CeedMemType);
78   int (*GetArray)(CeedVector, CeedMemType, CeedScalar **);
79   int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **);
80   int (*RestoreArray)(CeedVector);
81   int (*RestoreArrayRead)(CeedVector);
82   int (*Destroy)(CeedVector);
83   int refcount;
84   CeedInt length;
85   uint64_t state;
86   uint64_t numreaders;
87   void *data;
88 };
89 
90 struct CeedElemRestriction_private {
91   Ceed ceed;
92   int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedTransposeMode,
93                CeedVector, CeedVector, CeedRequest *);
94   int (*ApplyBlock)(CeedElemRestriction, CeedInt, CeedTransposeMode,
95                     CeedTransposeMode, CeedVector, CeedVector, CeedRequest *);
96   int (*Destroy)(CeedElemRestriction);
97   int refcount;
98   CeedInt nelem;    /* number of elements */
99   CeedInt elemsize; /* number of nodes per element */
100   CeedInt nnodes;   /* size of the L-vector, can be used for checking for
101                       correct vector sizes */
102   CeedInt ncomp;    /* number of components */
103   CeedInt blksize;  /* number of elements in a batch */
104   CeedInt nblk;     /* number of blocks of elements */
105   void *data;       /* place for the backend to store any data */
106 };
107 
108 struct CeedBasis_private {
109   Ceed ceed;
110   int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode,
111                CeedVector, CeedVector);
112   int (*Destroy)(CeedBasis);
113   int refcount;
114   bool tensorbasis;      /* flag for tensor basis */
115   CeedInt dim;           /* topological dimension */
116   CeedInt ncomp;         /* number of field components (1 for scalar fields) */
117   CeedInt P1d;           /* number of nodes in one dimension */
118   CeedInt Q1d;           /* number of quadrature points in one dimension */
119   CeedInt P;             /* total number of nodes */
120   CeedInt Q;             /* total number of quadrature points */
121   CeedScalar *qref1d;    /* Array of length Q1d holding the locations of
122                             quadrature points on the 1D reference element [-1, 1] */
123   CeedScalar *qweight1d; /* array of length Q1d holding the quadrature weights on
124                             the reference element */
125   CeedScalar
126   *interp1d;  /* row-major matrix of shape [Q1d, P1d] expressing the values of
127                             nodal basis functions at quadrature points */
128   CeedScalar
129   *grad1d;    /* row-major matrix of shape [Q1d, P1d] matrix expressing derivatives of
130                             nodal basis functions at quadrature points */
131   CeedTensorContract contract; /* tensor contraction object */
132   void *data;            /* place for the backend to store any data */
133 };
134 
135 struct CeedTensorContract_private {
136   Ceed ceed;
137   int (*Apply)(CeedTensorContract, CeedInt, CeedInt, CeedInt, CeedInt,
138                const CeedScalar *restrict, CeedTransposeMode, const CeedInt,
139                const CeedScalar *restrict, CeedScalar *restrict);
140   int (*Destroy)(CeedTensorContract);
141   int refcount;
142   void *data;
143 };
144 
145 struct CeedQFunctionField_private {
146   const char *fieldname;
147   CeedInt size;
148   CeedEvalMode emode;
149 };
150 
151 struct CeedQFunction_private {
152   Ceed ceed;
153   int (*Apply)(CeedQFunction, CeedInt, CeedVector *, CeedVector *);
154   int (*Destroy)(CeedQFunction);
155   int refcount;
156   CeedInt vlength;    // Number of quadrature points must be padded to a multiple of vlength
157   CeedQFunctionField *inputfields;
158   CeedQFunctionField *outputfields;
159   CeedInt numinputfields, numoutputfields;
160   CeedQFunctionUser function;
161   const char *sourcepath;
162   const char *qfname;
163   bool fortranstatus;
164   bool identity;
165   void *ctx;      /* user context for function */
166   size_t ctxsize; /* size of user context; may be used to copy to a device */
167   void *data;     /* backend data */
168 };
169 
170 /// Struct to handle the context data to use the Fortran QFunction stub
171 /// @ingroup CeedQFunction
172 typedef struct {
173   CeedScalar *innerctx;
174   size_t innerctxsize;
175   void (*f)(void *ctx, int *nq,
176             const CeedScalar *u,const CeedScalar *u1,
177             const CeedScalar *u2,const CeedScalar *u3,
178             const CeedScalar *u4,const CeedScalar *u5,
179             const CeedScalar *u6,const CeedScalar *u7,
180             const CeedScalar *u8,const CeedScalar *u9,
181             const CeedScalar *u10,const CeedScalar *u11,
182             const CeedScalar *u12,const CeedScalar *u13,
183             const CeedScalar *u14,const CeedScalar *u15,
184             CeedScalar *v,CeedScalar *v1,CeedScalar *v2,
185             CeedScalar *v3,CeedScalar *v4,CeedScalar *v5,
186             CeedScalar *v6,CeedScalar *v7,CeedScalar *v8,
187             CeedScalar *v9, CeedScalar *v10,CeedScalar *v11,
188             CeedScalar *v12,CeedScalar *v13,CeedScalar *v14,
189             CeedScalar *v15, int *err);
190 } fContext;
191 
192 struct CeedOperatorField_private {
193   CeedElemRestriction Erestrict; /// Restriction from L-vector or NULL if identity
194   CeedTransposeMode lmode;       /// Transpose mode for lvector ordering
195   CeedBasis basis;               /// Basis or NULL for collocated fields
196   CeedVector
197   vec;                /// State vector for passive fields, NULL for active fields
198 };
199 
200 struct CeedOperator_private {
201   Ceed ceed;
202   CeedOperator opfallback;
203   CeedQFunction qffallback;
204   int refcount;
205   int (*AssembleLinearQFunction)(CeedOperator, CeedVector *,
206                                  CeedElemRestriction *, CeedRequest *);
207   int (*AssembleLinearDiagonal)(CeedOperator, CeedVector *, CeedRequest *);
208   int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *);
209   int (*ApplyComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *);
210   int (*ApplyAdd)(CeedOperator, CeedVector, CeedVector, CeedRequest *);
211   int (*ApplyAddComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *);
212   int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector,
213                        CeedVector, CeedRequest *);
214   int (*Destroy)(CeedOperator);
215   CeedOperatorField *inputfields;
216   CeedOperatorField *outputfields;
217   CeedInt numelements; /// Number of elements
218   CeedInt numqpoints;  /// Number of quadrature points over all elements
219   CeedInt nfields;     /// Number of fields that have been set
220   CeedQFunction qf;
221   CeedQFunction dqf;
222   CeedQFunction dqfT;
223   bool setupdone;
224   bool composite;
225   bool hasrestriction;
226   CeedOperator *suboperators;
227   CeedInt numsub;
228   void *data;
229 };
230 
231 CEED_INTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int,
232                                 const char *, va_list);
233 CEED_INTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int,
234                                const char *, va_list);
235 CEED_INTERN int CeedErrorExit(Ceed, const char *, int, const char *, int,
236                               const char *, va_list);
237 CEED_INTERN int CeedSetErrorHandler(Ceed ceed,
238                                     int (eh)(Ceed, const char *, int,
239                                         const char *, int, const char *,
240                                         va_list));
241 
242 CEED_INTERN int CeedMatrixMultiply(Ceed ceed, CeedScalar *matA,
243                                    CeedScalar *matB, CeedScalar *matC,
244                                    CeedInt m, CeedInt n, CeedInt kk);
245 
246 #endif
247