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