xref: /libCEED/include/ceed-impl.h (revision c01dd7302e322b6c64baa03361e1a40d97bd5622)
16ea7c6c1SJed Brown // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at
26ea7c6c1SJed Brown // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights
36ea7c6c1SJed Brown // reserved. See files LICENSE and NOTICE for details.
46ea7c6c1SJed Brown //
56ea7c6c1SJed Brown // This file is part of CEED, a collection of benchmarks, miniapps, software
66ea7c6c1SJed Brown // libraries and APIs for efficient high-order finite element and spectral
76ea7c6c1SJed Brown // element discretizations for exascale applications. For more information and
86ea7c6c1SJed Brown // source code availability see http://github.com/ceed.
96ea7c6c1SJed Brown //
106ea7c6c1SJed Brown // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC,
116ea7c6c1SJed Brown // a collaborative effort of two U.S. Department of Energy organizations (Office
126ea7c6c1SJed Brown // of Science and the National Nuclear Security Administration) responsible for
136ea7c6c1SJed Brown // the planning and preparation of a capable exascale ecosystem, including
146ea7c6c1SJed Brown // software, applications, hardware, advanced system engineering and early
156ea7c6c1SJed Brown // testbed platforms, in support of the nation's exascale computing imperative.
166ea7c6c1SJed Brown 
176ea7c6c1SJed Brown #ifndef _ceed_impl_h
186ea7c6c1SJed Brown #define _ceed_impl_h
196ea7c6c1SJed Brown 
206ea7c6c1SJed Brown #include <ceed.h>
216ea7c6c1SJed Brown 
226ea7c6c1SJed Brown #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden")))
236ea7c6c1SJed Brown 
246ea7c6c1SJed Brown #define CEED_MAX_RESOURCE_LEN 1024
256ea7c6c1SJed Brown #define CEED_ALIGN 64
266ea7c6c1SJed Brown 
276ea7c6c1SJed Brown struct Ceed_private {
286ea7c6c1SJed Brown   int (*Error)(Ceed, const char *, int, const char *, int, const char *, va_list);
296ea7c6c1SJed Brown   int (*Destroy)(Ceed);
306ea7c6c1SJed Brown   int (*VecCreate)(Ceed, CeedInt, CeedVector);
316ea7c6c1SJed Brown   int (*ElemRestrictionCreate)(CeedElemRestriction, CeedMemType, CeedCopyMode,
326ea7c6c1SJed Brown                                const CeedInt *);
336ea7c6c1SJed Brown   int (*BasisCreateTensorH1)(Ceed, CeedInt, CeedInt, CeedInt, const CeedScalar *,
346ea7c6c1SJed Brown                              const CeedScalar *, const CeedScalar *, const CeedScalar *, CeedBasis);
356ea7c6c1SJed Brown   int (*QFunctionCreate)(CeedQFunction);
366ea7c6c1SJed Brown   int (*OperatorCreate)(CeedOperator);
376ea7c6c1SJed Brown   void *data;
386ea7c6c1SJed Brown };
396ea7c6c1SJed Brown 
406ea7c6c1SJed Brown /* In the next 3 functions, p has to be the address of a pointer type, i.e. p
416ea7c6c1SJed Brown    has to be a pointer to a pointer. */
42c7c22b02Scamierjs CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p);
43c7c22b02Scamierjs CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
44c7c22b02Scamierjs CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
45c7c22b02Scamierjs CEED_INTERN int CeedFree(void *p);
466ea7c6c1SJed Brown 
476ea7c6c1SJed Brown #define CeedChk(ierr) do { if (ierr) return ierr; } while (0)
486ea7c6c1SJed Brown /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with
496ea7c6c1SJed Brown    different memory alignments: CeedMalloc returns pointers aligned at
506ea7c6c1SJed Brown    CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
51c7c22b02Scamierjs #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p)
52c7c22b02Scamierjs #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
53c7c22b02Scamierjs #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
546ea7c6c1SJed Brown 
556ea7c6c1SJed Brown void CeedDebug(const char *,...);
566ea7c6c1SJed Brown 
576ea7c6c1SJed Brown struct CeedVector_private {
586ea7c6c1SJed Brown   Ceed ceed;
596ea7c6c1SJed Brown   int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *);
606ea7c6c1SJed Brown   int (*GetArray)(CeedVector, CeedMemType, CeedScalar **);
616ea7c6c1SJed Brown   int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **);
626ea7c6c1SJed Brown   int (*RestoreArray)(CeedVector, CeedScalar **);
636ea7c6c1SJed Brown   int (*RestoreArrayRead)(CeedVector, const CeedScalar **);
646ea7c6c1SJed Brown   int (*Destroy)(CeedVector);
656ea7c6c1SJed Brown   CeedInt length;
666ea7c6c1SJed Brown   void *data;
676ea7c6c1SJed Brown };
686ea7c6c1SJed Brown 
696ea7c6c1SJed Brown struct CeedElemRestriction_private {
706ea7c6c1SJed Brown   Ceed ceed;
716ea7c6c1SJed Brown   int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedInt, CeedTransposeMode,
726ea7c6c1SJed Brown                CeedVector, CeedVector, CeedRequest *);
736ea7c6c1SJed Brown   int (*Destroy)(CeedElemRestriction);
746ea7c6c1SJed Brown   CeedInt nelem;    /* number of elements */
756ea7c6c1SJed Brown   CeedInt elemsize; /* number of dofs per element */
766ea7c6c1SJed Brown   CeedInt ndof;     /* size of the L-vector, can be used for checking for
776ea7c6c1SJed Brown                        correct vector sizes */
786ea7c6c1SJed Brown   void *data;       /* place for the backend to store any data */
796ea7c6c1SJed Brown };
806ea7c6c1SJed Brown 
816ea7c6c1SJed Brown struct CeedBasis_private {
826ea7c6c1SJed Brown   Ceed ceed;
836ea7c6c1SJed Brown   int (*Apply)(CeedBasis, CeedTransposeMode, CeedEvalMode, const CeedScalar *,
846ea7c6c1SJed Brown                CeedScalar *);
856ea7c6c1SJed Brown   int (*Destroy)(CeedBasis);
866ea7c6c1SJed Brown   CeedInt dim;
876ea7c6c1SJed Brown   CeedInt ndof;
886ea7c6c1SJed Brown   CeedInt P1d;
896ea7c6c1SJed Brown   CeedInt Q1d;
906ea7c6c1SJed Brown   CeedScalar *qref1d;
916ea7c6c1SJed Brown   CeedScalar *qweight1d;
926ea7c6c1SJed Brown   CeedScalar *interp1d;
936ea7c6c1SJed Brown   CeedScalar *grad1d;
94*c01dd730Scamierjs   void *data;       /* place for the backend to store any data */
956ea7c6c1SJed Brown };
966ea7c6c1SJed Brown 
976ea7c6c1SJed Brown /* FIXME: The number of in-fields and out-fields may be different? */
986ea7c6c1SJed Brown /* FIXME: Shouldn't inmode and outmode be per-in-field and per-out-field,
996ea7c6c1SJed Brown    respectively? */
1006ea7c6c1SJed Brown struct CeedQFunction_private {
1016ea7c6c1SJed Brown   Ceed ceed;
1026ea7c6c1SJed Brown   int (*Apply)(CeedQFunction, void *, CeedInt, const CeedScalar *const *,
1036ea7c6c1SJed Brown                CeedScalar *const *);
1046ea7c6c1SJed Brown   int (*Destroy)(CeedQFunction);
1056ea7c6c1SJed Brown   CeedInt vlength;    // Number of quadrature points must be padded to a multiple of vlength
1066ea7c6c1SJed Brown   CeedInt nfields;
1076ea7c6c1SJed Brown   size_t qdatasize;   // Number of bytes of qdata per quadrature point
1086ea7c6c1SJed Brown   CeedEvalMode inmode, outmode;
1096ea7c6c1SJed Brown   int (*function)(void *, void *, CeedInt, const CeedScalar *const *,
1106ea7c6c1SJed Brown                   CeedScalar *const *);
1116ea7c6c1SJed Brown   const char *focca;
1126ea7c6c1SJed Brown   void *ctx;      /* user context for function */
1136ea7c6c1SJed Brown   size_t ctxsize; /* size of user context; may be used to copy to a device */
1146ea7c6c1SJed Brown   void *data;     /* backend data */
1156ea7c6c1SJed Brown };
1166ea7c6c1SJed Brown 
1176ea7c6c1SJed Brown struct CeedOperator_private {
1186ea7c6c1SJed Brown   Ceed ceed;
1196ea7c6c1SJed Brown   int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedRequest *);
1206ea7c6c1SJed Brown   int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector,
1216ea7c6c1SJed Brown                        CeedVector, CeedRequest *);
1226ea7c6c1SJed Brown   int (*GetQData)(CeedOperator, CeedVector *);
1236ea7c6c1SJed Brown   int (*Destroy)(CeedOperator);
1246ea7c6c1SJed Brown   CeedElemRestriction Erestrict;
1256ea7c6c1SJed Brown   CeedBasis basis;
1266ea7c6c1SJed Brown   CeedQFunction qf;
1276ea7c6c1SJed Brown   CeedQFunction dqf;
1286ea7c6c1SJed Brown   CeedQFunction dqfT;
1296ea7c6c1SJed Brown   void *data;
1306ea7c6c1SJed Brown };
1316ea7c6c1SJed Brown 
1326ea7c6c1SJed Brown #endif
133