xref: /libCEED/doc/sphinx/source/api/index.rst (revision 5f67fade47e323fa44018f277580acfe24400ad4) 
1**************************************
2API Documentation
3**************************************
4
5This section contains the code documentation. The subsections represent
6the different API objects, typedefs, and enumerations.
7
8
9Public API
10======================================
11
12These objects and functions are intended to be used by general users of libCEED
13and can generally be found in `ceed.h`.
14
15
16.. only:: html
17
18   .. mermaid::
19
20      graph TD
21      U -->|wrap data| V
22      U(High-level user code) -->|apply| O
23      subgraph Ceed
24      O(CeedOperator) --> E(CeedElemRestriction)
25      O --> B(CeedBasis)
26      O --> Q(CeedQFunction)
27      B --> V(CeedVector)
28      O --> V
29      E --> V
30      Q --> V
31      end
32      Q --> UQ(User's physics)
33
34.. toctree::
35   :maxdepth: 4
36
37   Ceed
38   CeedVector
39   CeedElemRestriction
40   CeedBasis
41   CeedQFunction
42   CeedOperator
43
44
45Backend API
46======================================
47
48These functions are intended to be used by backend developers of libCEED and can
49generally be found in `ceed-backend.h`.
50
51.. toctree::
52
53   backend/Ceed
54   backend/CeedVector
55   backend/CeedElemRestriction
56   backend/CeedBasis
57   backend/CeedQFunction
58   backend/CeedOperator
59
60
61Internal Functions
62======================================
63
64These functions are intended to be used by library developers of libCEED and can
65generally be found in `ceed-impl.h`.
66
67.. toctree::
68
69   internal/Ceed
70   internal/CeedVector
71   internal/CeedElemRestriction
72   internal/CeedBasis
73   internal/CeedQFunction
74   internal/CeedOperator
75