xref: /libCEED/doc/sphinx/source/releasenotes.md (revision 70a7ffb32f2ac8f6de27898459ba6016395fdb67)
1bcb2dfaeSJed Brown# Changes/Release Notes
2bcb2dfaeSJed Brown
3bcb2dfaeSJed BrownOn this page we provide a summary of the main API changes, new features and examples
4bcb2dfaeSJed Brownfor each release of libCEED.
5bcb2dfaeSJed Brown
6bcb2dfaeSJed Brown(main)=
7bcb2dfaeSJed Brown
8bcb2dfaeSJed Brown## Current `main` branch
9bcb2dfaeSJed Brown
107e7773b5SJeremy L Thompson### Interface changes
117e7773b5SJeremy L Thompson
127e7773b5SJeremy L Thompson- Update {c:func} `CeedQFunctionGetFields` and {c:func} `CeedOperatorGetFields` to include number of fields.
13ce4822f6SJeremy L Thompson- Promote to the public API: QFunction and Operator field objects, `CeedQFunctionField` and `CeedOperatorField`, and associated getters, {c:func}`CeedQFunctionGetFields`; {c:func}`CeedQFunctionFieldGetName`; {c:func}`CeedQFunctionFieldGetSize`; {c:func}`CeedQFunctionFieldGetEvalMode`; {c:func}`CeedOperatorGetFields`; {c:func}`CeedOperatorFieldGetElemRestriction`; {c:func}`CeedOperatorFieldGetBasis`; and {c:func}`CeedOperatorFieldGetVector`.
14f04ea552SJeremy L Thompson- Clarify and document conditions where `CeedQFunction` and `CeedOperator` become immutable and no further fields or suboperators can be added.
15*70a7ffb3SJeremy L Thompson- Add {c:func} `CeedOperatorLinearAssembleQFunctionBuildOrUpdate` to reduce object creation overhead in assembly of CeedOperator preconditioning ingredients.
167e7773b5SJeremy L Thompson
17f479eb23SJeremy L Thompson### New features
18f479eb23SJeremy L Thompson
19f479eb23SJeremy L Thompson- `CeedScalar` can now be set as `float` or `double` at compile time.
20f479eb23SJeremy L Thompson
21bcb2dfaeSJed Brown### Maintainability
22bcb2dfaeSJed Brown
23bcb2dfaeSJed Brown- Refactored preconditioner support internally to facilitate future development and improve GPU completeness/test coverage.
24bcb2dfaeSJed Brown
25bcb2dfaeSJed Brown(v0-9)=
26bcb2dfaeSJed Brown
27bcb2dfaeSJed Brown## v0.9 (Jul 6, 2021)
28bcb2dfaeSJed Brown
29bcb2dfaeSJed Brown### Interface changes
30bcb2dfaeSJed Brown
31bcb2dfaeSJed Brown- Minor modification in error handling macro to silence pedantic warnings when compiling with Clang, but no functional impact.
32bcb2dfaeSJed Brown
33bcb2dfaeSJed Brown### New features
34bcb2dfaeSJed Brown
35bcb2dfaeSJed Brown- Add {c:func}`CeedVectorAXPY` and {c:func}`CeedVectorPointwiseMult` as a convenience for stand-alone testing and internal use.
36bcb2dfaeSJed Brown- Add `CEED_QFUNCTION_HELPER` macro to properly annotate QFunction helper functions for code generation backends.
37bcb2dfaeSJed Brown- Add `CeedPragmaOptimizeOff` macro for code that is sensitive to floating point errors from fast math optimizations.
38bcb2dfaeSJed Brown- Rust support: split `libceed-sys` crate out of `libceed` and [publish both on crates.io](https://crates.io/crates/libceed).
39bcb2dfaeSJed Brown
40bcb2dfaeSJed Brown### Performance improvements
41bcb2dfaeSJed Brown
42bcb2dfaeSJed Brown### Examples
43bcb2dfaeSJed Brown
44bcb2dfaeSJed Brown- Solid mechanics mini-app updated to explore the performance impacts of various formulations in the initial and current configurations.
45bcb2dfaeSJed Brown- Fluid mechanics example adds GPU support and improves modularity.
46bcb2dfaeSJed Brown
47bcb2dfaeSJed Brown### Deprecated backends
48bcb2dfaeSJed Brown
49bcb2dfaeSJed Brown- The `/cpu/self/tmpl` and `/cpu/self/tmpl/sub` backends have been removed. These backends were intially added to test the backend inheritance mechanism, but this mechanism is now widely used and tested in multiple backends.
50bcb2dfaeSJed Brown
51bcb2dfaeSJed Brown(v0-8)=
52bcb2dfaeSJed Brown
53bcb2dfaeSJed Brown## v0.8 (Mar 31, 2021)
54bcb2dfaeSJed Brown
55bcb2dfaeSJed Brown### Interface changes
56bcb2dfaeSJed Brown
57bcb2dfaeSJed Brown- Error handling improved to include enumerated error codes for C interface return values.
58bcb2dfaeSJed Brown- Installed headers that will follow semantic versioning were moved to {code}`include/ceed` directory. These headers have been renamed from {code}`ceed-*.h` to {code}`ceed/*.h`. Placeholder headers with the old naming schema are currently provided, but these headers will be removed in the libCEED v0.9 release.
59bcb2dfaeSJed Brown
60bcb2dfaeSJed Brown### New features
61bcb2dfaeSJed Brown
62bcb2dfaeSJed Brown- Julia and Rust interfaces added, providing a nearly 1-1 correspondence with the C interface, plus some convenience features.
63bcb2dfaeSJed Brown- Static libraries can be built with `make STATIC=1` and the pkg-config file is installed accordingly.
64bcb2dfaeSJed Brown- Add {c:func}`CeedOperatorLinearAssembleSymbolic` and {c:func}`CeedOperatorLinearAssemble` to support full assembly of libCEED operators.
65bcb2dfaeSJed Brown
66bcb2dfaeSJed Brown### Performance improvements
67bcb2dfaeSJed Brown
68bcb2dfaeSJed Brown- New HIP MAGMA backends for hipMAGMA library users: `/gpu/hip/magma` and `/gpu/hip/magma/det`.
69bcb2dfaeSJed Brown- New HIP backends for improved tensor basis performance: `/gpu/hip/shared` and `/gpu/hip/gen`.
70bcb2dfaeSJed Brown
71bcb2dfaeSJed Brown### Examples
72bcb2dfaeSJed Brown
73bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` example updated with traction boundary conditions and improved Dirichlet boundary conditions.
74bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` example updated with Neo-Hookean hyperelasticity in current configuration as well as improved Neo-Hookean hyperelasticity exploring storage vs computation tradeoffs.
75bcb2dfaeSJed Brown- {ref}`example-petsc-navier-stokes` example updated with isentropic traveling vortex test case, an analytical solution to the Euler equations that is useful for testing boundary conditions, discretization stability, and order of accuracy.
76bcb2dfaeSJed Brown- {ref}`example-petsc-navier-stokes` example updated with support for performing convergence study and plotting order of convergence by polynomial degree.
77bcb2dfaeSJed Brown
78bcb2dfaeSJed Brown(v0-7)=
79bcb2dfaeSJed Brown
80bcb2dfaeSJed Brown## v0.7 (Sep 29, 2020)
81bcb2dfaeSJed Brown
82bcb2dfaeSJed Brown### Interface changes
83bcb2dfaeSJed Brown
84bcb2dfaeSJed Brown- Replace limited {code}`CeedInterlaceMode` with more flexible component stride {code}`compstride` in {code}`CeedElemRestriction` constructors.
85bcb2dfaeSJed Brown  As a result, the {code}`indices` parameter has been replaced with {code}`offsets` and the {code}`nnodes` parameter has been replaced with {code}`lsize`.
86bcb2dfaeSJed Brown  These changes improve support for mixed finite element methods.
87bcb2dfaeSJed Brown- Replace various uses of {code}`Ceed*Get*Status` with {code}`Ceed*Is*` in the backend API to match common nomenclature.
88bcb2dfaeSJed Brown- Replace {code}`CeedOperatorAssembleLinearDiagonal` with {c:func}`CeedOperatorLinearAssembleDiagonal` for clarity.
89bcb2dfaeSJed Brown- Linear Operators can be assembled as point-block diagonal matrices with {c:func}`CeedOperatorLinearAssemblePointBlockDiagonal`, provided in row-major form in a {code}`ncomp` by {code}`ncomp` block per node.
90bcb2dfaeSJed Brown- Diagonal assemble interface changed to accept a {ref}`CeedVector` instead of a pointer to a {ref}`CeedVector` to reduce memory movement when interfacing with calling code.
91bcb2dfaeSJed Brown- Added {c:func}`CeedOperatorLinearAssembleAddDiagonal` and {c:func}`CeedOperatorLinearAssembleAddPointBlockDiagonal` for improved future integration with codes such as MFEM that compose the action of {ref}`CeedOperator`s external to libCEED.
92bcb2dfaeSJed Brown- Added {c:func}`CeedVectorTakeAray` to sync and remove libCEED read/write access to an allocated array and pass ownership of the array to the caller.
93bcb2dfaeSJed Brown  This function is recommended over {c:func}`CeedVectorSyncArray` when the {code}`CeedVector` has an array owned by the caller that was set by {c:func}`CeedVectorSetArray`.
94bcb2dfaeSJed Brown- Added {code}`CeedQFunctionContext` object to manage user QFunction context data and reduce copies between device and host memory.
95bcb2dfaeSJed Brown- Added {c:func}`CeedOperatorMultigridLevelCreate`, {c:func}`CeedOperatorMultigridLevelCreateTensorH1`, and {c:func}`CeedOperatorMultigridLevelCreateH1` to facilitate creation of multigrid prolongation, restriction, and coarse grid operators using a common quadrature space.
96bcb2dfaeSJed Brown
97bcb2dfaeSJed Brown### New features
98bcb2dfaeSJed Brown
99bcb2dfaeSJed Brown- New HIP backend: `/gpu/hip/ref`.
100bcb2dfaeSJed Brown- CeedQFunction support for user `CUfunction`s in some backends
101bcb2dfaeSJed Brown
102bcb2dfaeSJed Brown### Performance improvements
103bcb2dfaeSJed Brown
104bcb2dfaeSJed Brown- OCCA backend rebuilt to facilitate future performance enhancements.
105bcb2dfaeSJed Brown- Petsc BPs suite improved to reduce noise due to multiple calls to {code}`mpiexec`.
106bcb2dfaeSJed Brown
107bcb2dfaeSJed Brown### Examples
108bcb2dfaeSJed Brown
109bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` example updated with strain energy computation and more flexible boundary conditions.
110bcb2dfaeSJed Brown
111bcb2dfaeSJed Brown### Deprecated backends
112bcb2dfaeSJed Brown
113bcb2dfaeSJed Brown- The `/gpu/cuda/reg` backend has been removed, with its core features moved into `/gpu/cuda/ref` and `/gpu/cuda/shared`.
114bcb2dfaeSJed Brown
115bcb2dfaeSJed Brown(v0-6)=
116bcb2dfaeSJed Brown
117bcb2dfaeSJed Brown## v0.6 (Mar 29, 2020)
118bcb2dfaeSJed Brown
119bcb2dfaeSJed BrownlibCEED v0.6 contains numerous new features and examples, as well as expanded
120bcb2dfaeSJed Browndocumentation in [this new website](https://libceed.readthedocs.io).
121bcb2dfaeSJed Brown
122bcb2dfaeSJed Brown### New features
123bcb2dfaeSJed Brown
124bcb2dfaeSJed Brown- New Python interface using [CFFI](https://cffi.readthedocs.io/) provides a nearly
125bcb2dfaeSJed Brown  1-1 correspondence with the C interface, plus some convenience features.  For instance,
126bcb2dfaeSJed Brown  data stored in the {cpp:type}`CeedVector` structure are available without copy as
127bcb2dfaeSJed Brown  {py:class}`numpy.ndarray`.  Short tutorials are provided in
128bcb2dfaeSJed Brown  [Binder](https://mybinder.org/v2/gh/CEED/libCEED/main?urlpath=lab/tree/examples/tutorials/).
129bcb2dfaeSJed Brown- Linear QFunctions can be assembled as block-diagonal matrices (per quadrature point,
130bcb2dfaeSJed Brown  {c:func}`CeedOperatorAssembleLinearQFunction`) or to evaluate the diagonal
131bcb2dfaeSJed Brown  ({c:func}`CeedOperatorAssembleLinearDiagonal`).  These operations are useful for
132bcb2dfaeSJed Brown  preconditioning ingredients and are used in the libCEED's multigrid examples.
133bcb2dfaeSJed Brown- The inverse of separable operators can be obtained using
134bcb2dfaeSJed Brown  {c:func}`CeedOperatorCreateFDMElementInverse` and applied with
135bcb2dfaeSJed Brown  {c:func}`CeedOperatorApply`.  This is a useful preconditioning ingredient,
136bcb2dfaeSJed Brown  especially for Laplacians and related operators.
137bcb2dfaeSJed Brown- New functions: {c:func}`CeedVectorNorm`, {c:func}`CeedOperatorApplyAdd`,
138bcb2dfaeSJed Brown  {c:func}`CeedQFunctionView`, {c:func}`CeedOperatorView`.
139bcb2dfaeSJed Brown- Make public accessors for various attributes to facilitate writing composable code.
140bcb2dfaeSJed Brown- New backend: `/cpu/self/memcheck/serial`.
141bcb2dfaeSJed Brown- QFunctions using variable-length array (VLA) pointer constructs can be used with CUDA
142bcb2dfaeSJed Brown  backends.  (Single source is coming soon for OCCA backends.)
143bcb2dfaeSJed Brown- Fix some missing edge cases in CUDA backend.
144bcb2dfaeSJed Brown
145bcb2dfaeSJed Brown### Performance Improvements
146bcb2dfaeSJed Brown
147bcb2dfaeSJed Brown- MAGMA backend performance optimization and non-tensor bases.
148bcb2dfaeSJed Brown- No-copy optimization in {c:func}`CeedOperatorApply`.
149bcb2dfaeSJed Brown
150bcb2dfaeSJed Brown### Interface changes
151bcb2dfaeSJed Brown
152bcb2dfaeSJed Brown- Replace {code}`CeedElemRestrictionCreateIdentity` and
153bcb2dfaeSJed Brown  {code}`CeedElemRestrictionCreateBlocked` with more flexible
154bcb2dfaeSJed Brown  {c:func}`CeedElemRestrictionCreateStrided` and
155bcb2dfaeSJed Brown  {c:func}`CeedElemRestrictionCreateBlockedStrided`.
156bcb2dfaeSJed Brown- Add arguments to {c:func}`CeedQFunctionCreateIdentity`.
157bcb2dfaeSJed Brown- Replace ambiguous uses of {cpp:enum}`CeedTransposeMode` for L-vector identification
158bcb2dfaeSJed Brown  with {cpp:enum}`CeedInterlaceMode`.  This is now an attribute of the
159bcb2dfaeSJed Brown  {cpp:type}`CeedElemRestriction` (see {c:func}`CeedElemRestrictionCreate`) and no
160bcb2dfaeSJed Brown  longer passed as `lmode` arguments to {c:func}`CeedOperatorSetField` and
161bcb2dfaeSJed Brown  {c:func}`CeedElemRestrictionApply`.
162bcb2dfaeSJed Brown
163bcb2dfaeSJed Brown### Examples
164bcb2dfaeSJed Brown
165bcb2dfaeSJed BrownlibCEED-0.6 contains greatly expanded examples with {ref}`new documentation <Examples>`.
166bcb2dfaeSJed BrownNotable additions include:
167bcb2dfaeSJed Brown
168bcb2dfaeSJed Brown- Standalone {ref}`ex2-surface` ({file}`examples/ceed/ex2-surface`): compute the area of
169bcb2dfaeSJed Brown  a domain in 1, 2, and 3 dimensions by applying a Laplacian.
170bcb2dfaeSJed Brown
171bcb2dfaeSJed Brown- PETSc {ref}`example-petsc-area` ({file}`examples/petsc/area.c`): computes surface area
172bcb2dfaeSJed Brown  of domains (like the cube and sphere) by direct integration on a surface mesh;
173bcb2dfaeSJed Brown  demonstrates geometric dimension different from topological dimension.
174bcb2dfaeSJed Brown
175bcb2dfaeSJed Brown- PETSc {ref}`example-petsc-bps`:
176bcb2dfaeSJed Brown
177bcb2dfaeSJed Brown  - {file}`examples/petsc/bpsraw.c` (formerly `bps.c`): transparent CUDA support.
178bcb2dfaeSJed Brown  - {file}`examples/petsc/bps.c` (formerly `bpsdmplex.c`): performance improvements
179bcb2dfaeSJed Brown    and transparent CUDA support.
180bcb2dfaeSJed Brown  - {ref}`example-petsc-bps-sphere` ({file}`examples/petsc/bpssphere.c`):
181bcb2dfaeSJed Brown    generalizations of all CEED BPs to the surface of the sphere; demonstrates geometric
182bcb2dfaeSJed Brown    dimension different from topological dimension.
183bcb2dfaeSJed Brown
184bcb2dfaeSJed Brown- {ref}`example-petsc-multigrid` ({file}`examples/petsc/multigrid.c`): new p-multigrid
185bcb2dfaeSJed Brown  solver with algebraic multigrid coarse solve.
186bcb2dfaeSJed Brown
187bcb2dfaeSJed Brown- {ref}`example-petsc-navier-stokes` ({file}`examples/fluids/navierstokes.c`; formerly
188bcb2dfaeSJed Brown  `examples/navier-stokes`): unstructured grid support (using PETSc's `DMPlex`),
189bcb2dfaeSJed Brown  implicit time integration, SU/SUPG stabilization, free-slip boundary conditions, and
190bcb2dfaeSJed Brown  quasi-2D computational domain support.
191bcb2dfaeSJed Brown
192bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` ({file}`examples/solids/elasticity.c`): new solver for
193bcb2dfaeSJed Brown  linear elasticity, small-strain hyperelasticity, and globalized finite-strain
194bcb2dfaeSJed Brown  hyperelasticity using p-multigrid with algebraic multigrid coarse solve.
195bcb2dfaeSJed Brown
196bcb2dfaeSJed Brown(v0-5)=
197bcb2dfaeSJed Brown
198bcb2dfaeSJed Brown## v0.5 (Sep 18, 2019)
199bcb2dfaeSJed Brown
200bcb2dfaeSJed BrownFor this release, several improvements were made. Two new CUDA backends were added to
201bcb2dfaeSJed Brownthe family of backends, of which, the new `cuda-gen` backend achieves state-of-the-art
202bcb2dfaeSJed Brownperformance using single-source {ref}`CeedQFunction`. From this release, users
203bcb2dfaeSJed Browncan define Q-Functions in a single source code independently of the targeted backend
204bcb2dfaeSJed Brownwith the aid of a new macro `CEED QFUNCTION` to support JIT (Just-In-Time) and CPU
205bcb2dfaeSJed Browncompilation of the user provided {ref}`CeedQFunction` code. To allow a unified
206bcb2dfaeSJed Browndeclaration, the {ref}`CeedQFunction` API has undergone a slight change:
207bcb2dfaeSJed Brownthe `QFunctionField` parameter `ncomp` has been changed to `size`. This change
208bcb2dfaeSJed Brownrequires setting the previous value of `ncomp` to `ncomp*dim` when adding a
209bcb2dfaeSJed Brown`QFunctionField` with eval mode `CEED EVAL GRAD`.
210bcb2dfaeSJed Brown
211bcb2dfaeSJed BrownAdditionally, new CPU backends
212bcb2dfaeSJed Brownwere included in this release, such as the `/cpu/self/opt/*` backends (which are
213bcb2dfaeSJed Brownwritten in pure C and use partial **E-vectors** to improve performance) and the
214bcb2dfaeSJed Brown`/cpu/self/ref/memcheck` backend (which relies upon the
215bcb2dfaeSJed Brown[Valgrind](http://valgrind.org/) Memcheck tool to help verify that user
216bcb2dfaeSJed Brown{ref}`CeedQFunction` have no undefined values).
217bcb2dfaeSJed BrownThis release also included various performance improvements, bug fixes, new examples,
218bcb2dfaeSJed Brownand improved tests. Among these improvements, vectorized instructions for
219bcb2dfaeSJed Brown{ref}`CeedQFunction` code compiled for CPU were enhanced by using `CeedPragmaSIMD`
220bcb2dfaeSJed Browninstead of `CeedPragmaOMP`, implementation of a {ref}`CeedQFunction` gallery and
221bcb2dfaeSJed Brownidentity Q-Functions were introduced, and the PETSc benchmark problems were expanded
222bcb2dfaeSJed Brownto include unstructured meshes handling were. For this expansion, the prior version of
223bcb2dfaeSJed Brownthe PETSc BPs, which only included data associated with structured geometries, were
224bcb2dfaeSJed Brownrenamed `bpsraw`, and the new version of the BPs, which can handle data associated
225bcb2dfaeSJed Brownwith any unstructured geometry, were called `bps`. Additionally, other benchmark
226bcb2dfaeSJed Brownproblems, namely BP2 and BP4 (the vector-valued versions of BP1 and BP3, respectively),
227bcb2dfaeSJed Brownand BP5 and BP6 (the collocated versions---for which the quadrature points are the same
228bcb2dfaeSJed Brownas the Gauss Lobatto nodes---of BP3 and BP4 respectively) were added to the PETSc
229bcb2dfaeSJed Brownexamples. Furthermoew, another standalone libCEED example, called `ex2`, which
230bcb2dfaeSJed Browncomputes the surface area of a given mesh was added to this release.
231bcb2dfaeSJed Brown
232bcb2dfaeSJed BrownBackends available in this release:
233bcb2dfaeSJed Brown
23468e843eeSJed Brown| CEED resource (`-ceed`)  | Backend                                             |
23568e843eeSJed Brown|--------------------------|-----------------------------------------------------|
23668e843eeSJed Brown| `/cpu/self/ref/serial`   | Serial reference implementation                     |
23768e843eeSJed Brown| `/cpu/self/ref/blocked`  | Blocked reference implementation                    |
23868e843eeSJed Brown| `/cpu/self/ref/memcheck` | Memcheck backend, undefined value checks            |
23968e843eeSJed Brown| `/cpu/self/opt/serial`   | Serial optimized C implementation                   |
24068e843eeSJed Brown| `/cpu/self/opt/blocked`  | Blocked optimized C implementation                  |
24168e843eeSJed Brown| `/cpu/self/avx/serial`   | Serial AVX implementation                           |
24268e843eeSJed Brown| `/cpu/self/avx/blocked`  | Blocked AVX implementation                          |
24368e843eeSJed Brown| `/cpu/self/xsmm/serial`  | Serial LIBXSMM implementation                       |
24468e843eeSJed Brown| `/cpu/self/xsmm/blocked` | Blocked LIBXSMM implementation                      |
24568e843eeSJed Brown| `/cpu/occa`              | Serial OCCA kernels                                 |
24668e843eeSJed Brown| `/gpu/occa`              | CUDA OCCA kernels                                   |
24768e843eeSJed Brown| `/omp/occa`              | OpenMP OCCA kernels                                 |
24868e843eeSJed Brown| `/ocl/occa`              | OpenCL OCCA kernels                                 |
24968e843eeSJed Brown| `/gpu/cuda/ref`          | Reference pure CUDA kernels                         |
25068e843eeSJed Brown| `/gpu/cuda/reg`          | Pure CUDA kernels using one thread per element      |
25168e843eeSJed Brown| `/gpu/cuda/shared`       | Optimized pure CUDA kernels using shared memory     |
25268e843eeSJed Brown| `/gpu/cuda/gen`          | Optimized pure CUDA kernels using code generation   |
25368e843eeSJed Brown| `/gpu/magma`             | CUDA MAGMA kernels                                  |
254bcb2dfaeSJed Brown
255bcb2dfaeSJed BrownExamples available in this release:
256bcb2dfaeSJed Brown
25768e843eeSJed Brown:::{list-table}
25868e843eeSJed Brown:header-rows: 1
25968e843eeSJed Brown:widths: auto
26068e843eeSJed Brown* - User code
26168e843eeSJed Brown  - Example
26268e843eeSJed Brown* - `ceed`
26368e843eeSJed Brown  - * ex1 (volume)
26468e843eeSJed Brown    * ex2 (surface)
26568e843eeSJed Brown* - `mfem`
26668e843eeSJed Brown  - * BP1 (scalar mass operator)
26768e843eeSJed Brown    * BP3 (scalar Laplace operator)
26868e843eeSJed Brown* - `petsc`
26968e843eeSJed Brown  - * BP1 (scalar mass operator)
27068e843eeSJed Brown    * BP2 (vector mass operator)
27168e843eeSJed Brown    * BP3 (scalar Laplace operator)
27268e843eeSJed Brown    * BP4 (vector Laplace operator)
27368e843eeSJed Brown    * BP5 (collocated scalar Laplace operator)
27468e843eeSJed Brown    * BP6 (collocated vector Laplace operator)
27568e843eeSJed Brown    * Navier-Stokes
27668e843eeSJed Brown* - `nek5000`
27768e843eeSJed Brown  - * BP1 (scalar mass operator)
27868e843eeSJed Brown    * BP3 (scalar Laplace operator)
27968e843eeSJed Brown:::
280bcb2dfaeSJed Brown
281bcb2dfaeSJed Brown(v0-4)=
282bcb2dfaeSJed Brown
283bcb2dfaeSJed Brown## v0.4 (Apr 1, 2019)
284bcb2dfaeSJed Brown
285bcb2dfaeSJed BrownlibCEED v0.4 was made again publicly available in the second full CEED software
286bcb2dfaeSJed Browndistribution, release CEED 2.0. This release contained notable features, such as
287bcb2dfaeSJed Brownfour new CPU backends, two new GPU backends, CPU backend optimizations, initial
288bcb2dfaeSJed Brownsupport for operator composition, performance benchmarking, and a Navier-Stokes demo.
289bcb2dfaeSJed BrownThe new CPU backends in this release came in two families. The `/cpu/self/*/serial`
290bcb2dfaeSJed Brownbackends process one element at a time and are intended for meshes with a smaller number
291bcb2dfaeSJed Brownof high order elements. The `/cpu/self/*/blocked` backends process blocked batches of
292bcb2dfaeSJed Browneight interlaced elements and are intended for meshes with higher numbers of elements.
293bcb2dfaeSJed BrownThe `/cpu/self/avx/*` backends rely upon AVX instructions to provide vectorized CPU
294bcb2dfaeSJed Brownperformance. The `/cpu/self/xsmm/*` backends rely upon the
295bcb2dfaeSJed Brown[LIBXSMM](http://github.com/hfp/libxsmm) package to provide vectorized CPU
296bcb2dfaeSJed Brownperformance. The `/gpu/cuda/*` backends provide GPU performance strictly using CUDA.
297bcb2dfaeSJed BrownThe `/gpu/cuda/ref` backend is a reference CUDA backend, providing reasonable
298bcb2dfaeSJed Brownperformance for most problem configurations. The `/gpu/cuda/reg` backend uses a simple
299bcb2dfaeSJed Brownparallelization approach, where each thread treats a finite element. Using just in time
300bcb2dfaeSJed Browncompilation, provided by nvrtc (NVidia Runtime Compiler), and runtime parameters, this
301bcb2dfaeSJed Brownbackend unroll loops and map memory address to registers. The `/gpu/cuda/reg` backend
302bcb2dfaeSJed Brownachieve good peak performance for 1D, 2D, and low order 3D problems, but performance
303bcb2dfaeSJed Browndeteriorates very quickly when threads run out of registers.
304bcb2dfaeSJed Brown
305bcb2dfaeSJed BrownA new explicit time-stepping Navier-Stokes solver was added to the family of libCEED
306bcb2dfaeSJed Brownexamples in the `examples/petsc` directory (see {ref}`example-petsc-navier-stokes`).
307bcb2dfaeSJed BrownThis example solves the time-dependent Navier-Stokes equations of compressible gas
308bcb2dfaeSJed Browndynamics in a static Eulerian three-dimensional frame, using structured high-order
309bcb2dfaeSJed Brownfinite/spectral element spatial discretizations and explicit high-order time-stepping
310bcb2dfaeSJed Brown(available in PETSc). Moreover, the Navier-Stokes example was developed using PETSc,
311bcb2dfaeSJed Brownso that the pointwise physics (defined at quadrature points) is separated from the
312bcb2dfaeSJed Brownparallelization and meshing concerns.
313bcb2dfaeSJed Brown
314bcb2dfaeSJed BrownBackends available in this release:
315bcb2dfaeSJed Brown
31668e843eeSJed Brown| CEED resource (`-ceed`)  | Backend                                             |
31768e843eeSJed Brown|--------------------------|-----------------------------------------------------|
31868e843eeSJed Brown| `/cpu/self/ref/serial`   | Serial reference implementation                     |
31968e843eeSJed Brown| `/cpu/self/ref/blocked`  | Blocked reference implementation                    |
32068e843eeSJed Brown| `/cpu/self/tmpl`         | Backend template, defaults to `/cpu/self/blocked`   |
32168e843eeSJed Brown| `/cpu/self/avx/serial`   | Serial AVX implementation                           |
32268e843eeSJed Brown| `/cpu/self/avx/blocked`  | Blocked AVX implementation                          |
32368e843eeSJed Brown| `/cpu/self/xsmm/serial`  | Serial LIBXSMM implementation                       |
32468e843eeSJed Brown| `/cpu/self/xsmm/blocked` | Blocked LIBXSMM implementation                      |
32568e843eeSJed Brown| `/cpu/occa`              | Serial OCCA kernels                                 |
32668e843eeSJed Brown| `/gpu/occa`              | CUDA OCCA kernels                                   |
32768e843eeSJed Brown| `/omp/occa`              | OpenMP OCCA kernels                                 |
32868e843eeSJed Brown| `/ocl/occa`              | OpenCL OCCA kernels                                 |
32968e843eeSJed Brown| `/gpu/cuda/ref`          | Reference pure CUDA kernels                         |
33068e843eeSJed Brown| `/gpu/cuda/reg`          | Pure CUDA kernels using one thread per element      |
33168e843eeSJed Brown| `/gpu/magma`             | CUDA MAGMA kernels                                  |
332bcb2dfaeSJed Brown
333bcb2dfaeSJed BrownExamples available in this release:
334bcb2dfaeSJed Brown
33568e843eeSJed Brown:::{list-table}
33668e843eeSJed Brown:header-rows: 1
33768e843eeSJed Brown:widths: auto
33868e843eeSJed Brown* - User code
33968e843eeSJed Brown  - Example
34068e843eeSJed Brown* - `ceed`
34168e843eeSJed Brown  - * ex1 (volume)
34268e843eeSJed Brown* - `mfem`
34368e843eeSJed Brown  - * BP1 (scalar mass operator)
34468e843eeSJed Brown    * BP3 (scalar Laplace operator)
34568e843eeSJed Brown* - `petsc`
34668e843eeSJed Brown  - * BP1 (scalar mass operator)
34768e843eeSJed Brown    * BP3 (scalar Laplace operator)
34868e843eeSJed Brown    * Navier-Stokes
34968e843eeSJed Brown* - `nek5000`
35068e843eeSJed Brown  - * BP1 (scalar mass operator)
35168e843eeSJed Brown    * BP3 (scalar Laplace operator)
35268e843eeSJed Brown:::
353bcb2dfaeSJed Brown
354bcb2dfaeSJed Brown(v0-3)=
355bcb2dfaeSJed Brown
356bcb2dfaeSJed Brown## v0.3 (Sep 30, 2018)
357bcb2dfaeSJed Brown
358bcb2dfaeSJed BrownNotable features in this release include active/passive field interface, support for
359bcb2dfaeSJed Brownnon-tensor bases, backend optimization, and improved Fortran interface. This release
360bcb2dfaeSJed Brownalso focused on providing improved continuous integration, and many new tests with code
361bcb2dfaeSJed Browncoverage reports of about 90%. This release also provided a significant change to the
362bcb2dfaeSJed Brownpublic interface: a {ref}`CeedQFunction` can take any number of named input and output
363bcb2dfaeSJed Brownarguments while {ref}`CeedOperator` connects them to the actual data, which may be
364bcb2dfaeSJed Brownsupplied explicitly to `CeedOperatorApply()` (active) or separately via
365bcb2dfaeSJed Brown`CeedOperatorSetField()` (passive). This interface change enables reusable libraries
366bcb2dfaeSJed Brownof CeedQFunctions and composition of block solvers constructed using
367bcb2dfaeSJed Brown{ref}`CeedOperator`. A concept of blocked restriction was added to this release and
368bcb2dfaeSJed Brownused in an optimized CPU backend. Although this is typically not visible to the user,
369bcb2dfaeSJed Brownit enables effective use of arbitrary-length SIMD while maintaining cache locality.
370bcb2dfaeSJed BrownThis CPU backend also implements an algebraic factorization of tensor product gradients
371bcb2dfaeSJed Brownto perform fewer operations than standard application of interpolation and
372bcb2dfaeSJed Browndifferentiation from nodes to quadrature points. This algebraic formulation
373bcb2dfaeSJed Brownautomatically supports non-polynomial and non-interpolatory bases, thus is more general
374bcb2dfaeSJed Brownthan the more common derivation in terms of Lagrange polynomials on the quadrature points.
375bcb2dfaeSJed Brown
376bcb2dfaeSJed BrownBackends available in this release:
377bcb2dfaeSJed Brown
37868e843eeSJed Brown| CEED resource (`-ceed`) | Backend                                             |
37968e843eeSJed Brown|-------------------------|-----------------------------------------------------|
38068e843eeSJed Brown| `/cpu/self/blocked`     | Blocked reference implementation                    |
38168e843eeSJed Brown| `/cpu/self/ref`         | Serial reference implementation                     |
38268e843eeSJed Brown| `/cpu/self/tmpl`        | Backend template, defaults to `/cpu/self/blocked`   |
38368e843eeSJed Brown| `/cpu/occa`             | Serial OCCA kernels                                 |
38468e843eeSJed Brown| `/gpu/occa`             | CUDA OCCA kernels                                   |
38568e843eeSJed Brown| `/omp/occa`             | OpenMP OCCA kernels                                 |
38668e843eeSJed Brown| `/ocl/occa`             | OpenCL OCCA kernels                                 |
38768e843eeSJed Brown| `/gpu/magma`            | CUDA MAGMA kernels                                  |
388bcb2dfaeSJed Brown
389bcb2dfaeSJed BrownExamples available in this release:
390bcb2dfaeSJed Brown
39168e843eeSJed Brown:::{list-table}
39268e843eeSJed Brown:header-rows: 1
39368e843eeSJed Brown:widths: auto
39468e843eeSJed Brown* - User code
39568e843eeSJed Brown  - Example
39668e843eeSJed Brown* - `ceed`
39768e843eeSJed Brown  - * ex1 (volume)
39868e843eeSJed Brown* - `mfem`
39968e843eeSJed Brown  - * BP1 (scalar mass operator)
40068e843eeSJed Brown    * BP3 (scalar Laplace operator)
40168e843eeSJed Brown* - `petsc`
40268e843eeSJed Brown  - * BP1 (scalar mass operator)
40368e843eeSJed Brown    * BP3 (scalar Laplace operator)
40468e843eeSJed Brown* - `nek5000`
40568e843eeSJed Brown  - * BP1 (scalar mass operator)
40668e843eeSJed Brown    * BP3 (scalar Laplace operator)
40768e843eeSJed Brown:::
408bcb2dfaeSJed Brown
409bcb2dfaeSJed Brown(v0-21)=
410bcb2dfaeSJed Brown
411bcb2dfaeSJed Brown## v0.21 (Sep 30, 2018)
412bcb2dfaeSJed Brown
413bcb2dfaeSJed BrownA MAGMA backend (which relies upon the
414bcb2dfaeSJed Brown[MAGMA](https://bitbucket.org/icl/magma) package) was integrated in libCEED for this
415bcb2dfaeSJed Brownrelease. This initial integration set up the framework of using MAGMA and provided the
416bcb2dfaeSJed BrownlibCEED functionality through MAGMA kernels as one of libCEED’s computational backends.
417bcb2dfaeSJed BrownAs any other backend, the MAGMA backend provides extended basic data structures for
418bcb2dfaeSJed Brown{ref}`CeedVector`, {ref}`CeedElemRestriction`, and {ref}`CeedOperator`, and implements
419bcb2dfaeSJed Brownthe fundamental CEED building blocks to work with the new data structures.
420bcb2dfaeSJed BrownIn general, the MAGMA-specific data structures keep the libCEED pointers to CPU data
421bcb2dfaeSJed Brownbut also add corresponding device (e.g., GPU) pointers to the data. Coherency is handled
422bcb2dfaeSJed Browninternally, and thus seamlessly to the user, through the functions/methods that are
423bcb2dfaeSJed Brownprovided to support them.
424bcb2dfaeSJed Brown
425bcb2dfaeSJed BrownBackends available in this release:
426bcb2dfaeSJed Brown
42768e843eeSJed Brown| CEED resource (`-ceed`) | Backend                         |
42868e843eeSJed Brown|-------------------------|---------------------------------|
42968e843eeSJed Brown| `/cpu/self`             | Serial reference implementation |
43068e843eeSJed Brown| `/cpu/occa`             | Serial OCCA kernels             |
43168e843eeSJed Brown| `/gpu/occa`             | CUDA OCCA kernels               |
43268e843eeSJed Brown| `/omp/occa`             | OpenMP OCCA kernels             |
43368e843eeSJed Brown| `/ocl/occa`             | OpenCL OCCA kernels             |
43468e843eeSJed Brown| `/gpu/magma`            | CUDA MAGMA kernels              |
435bcb2dfaeSJed Brown
436bcb2dfaeSJed BrownExamples available in this release:
437bcb2dfaeSJed Brown
43868e843eeSJed Brown:::{list-table}
43968e843eeSJed Brown:header-rows: 1
44068e843eeSJed Brown:widths: auto
44168e843eeSJed Brown* - User code
44268e843eeSJed Brown  - Example
44368e843eeSJed Brown* - `ceed`
44468e843eeSJed Brown  - * ex1 (volume)
44568e843eeSJed Brown* - `mfem`
44668e843eeSJed Brown  - * BP1 (scalar mass operator)
44768e843eeSJed Brown    * BP3 (scalar Laplace operator)
44868e843eeSJed Brown* - `petsc`
44968e843eeSJed Brown  - * BP1 (scalar mass operator)
45068e843eeSJed Brown* - `nek5000`
45168e843eeSJed Brown  - * BP1 (scalar mass operator)
45268e843eeSJed Brown:::
453bcb2dfaeSJed Brown
454bcb2dfaeSJed Brown(v0-2)=
455bcb2dfaeSJed Brown
456bcb2dfaeSJed Brown## v0.2 (Mar 30, 2018)
457bcb2dfaeSJed Brown
458bcb2dfaeSJed BrownlibCEED was made publicly available the first full CEED software distribution, release
459bcb2dfaeSJed BrownCEED 1.0. The distribution was made available using the Spack package manager to provide
460bcb2dfaeSJed Browna common, easy-to-use build environment, where the user can build the CEED distribution
461bcb2dfaeSJed Brownwith all dependencies. This release included a new Fortran interface for the library.
462bcb2dfaeSJed BrownThis release also contained major improvements in the OCCA backend (including a new
463bcb2dfaeSJed Brown`/ocl/occa` backend) and new examples. The standalone libCEED example was modified to
464bcb2dfaeSJed Browncompute the volume volume of a given mesh (in 1D, 2D, or 3D) and placed in an
465bcb2dfaeSJed Brown`examples/ceed` subfolder. A new `mfem` example to perform BP3 (with the application
466bcb2dfaeSJed Brownof the Laplace operator) was also added to this release.
467bcb2dfaeSJed Brown
468bcb2dfaeSJed BrownBackends available in this release:
469bcb2dfaeSJed Brown
47068e843eeSJed Brown| CEED resource (`-ceed`) | Backend                         |
47168e843eeSJed Brown|-------------------------|---------------------------------|
47268e843eeSJed Brown| `/cpu/self`             | Serial reference implementation |
47368e843eeSJed Brown| `/cpu/occa`             | Serial OCCA kernels             |
47468e843eeSJed Brown| `/gpu/occa`             | CUDA OCCA kernels               |
47568e843eeSJed Brown| `/omp/occa`             | OpenMP OCCA kernels             |
47668e843eeSJed Brown| `/ocl/occa`             | OpenCL OCCA kernels             |
477bcb2dfaeSJed Brown
478bcb2dfaeSJed BrownExamples available in this release:
479bcb2dfaeSJed Brown
48068e843eeSJed Brown:::{list-table}
48168e843eeSJed Brown:header-rows: 1
48268e843eeSJed Brown:widths: auto
48368e843eeSJed Brown* - User code
48468e843eeSJed Brown  - Example
48568e843eeSJed Brown* - `ceed`
48668e843eeSJed Brown  - * ex1 (volume)
48768e843eeSJed Brown* - `mfem`
48868e843eeSJed Brown  - * BP1 (scalar mass operator)
48968e843eeSJed Brown    * BP3 (scalar Laplace operator)
49068e843eeSJed Brown* - `petsc`
49168e843eeSJed Brown  - * BP1 (scalar mass operator)
49268e843eeSJed Brown* - `nek5000`
49368e843eeSJed Brown  - * BP1 (scalar mass operator)
49468e843eeSJed Brown:::
495bcb2dfaeSJed Brown
496bcb2dfaeSJed Brown(v0-1)=
497bcb2dfaeSJed Brown
498bcb2dfaeSJed Brown## v0.1 (Jan 3, 2018)
499bcb2dfaeSJed Brown
500bcb2dfaeSJed BrownInitial low-level API of the CEED project. The low-level API provides a set of Finite
501bcb2dfaeSJed BrownElements kernels and components for writing new low-level kernels. Examples include:
502bcb2dfaeSJed Brownvector and sparse linear algebra, element matrix assembly over a batch of elements,
503bcb2dfaeSJed Brownpartial assembly and action for efficient high-order operators like mass, diffusion,
504bcb2dfaeSJed Brownadvection, etc. The main goal of the low-level API is to establish the basis for the
505bcb2dfaeSJed Brownhigh-level API. Also, identifying such low-level kernels and providing a reference
506bcb2dfaeSJed Brownimplementation for them serves as the basis for specialized backend implementations.
507bcb2dfaeSJed BrownThis release contained several backends: `/cpu/self`, and backends which rely upon the
508bcb2dfaeSJed Brown[OCCA](http://github.com/libocca/occa) package, such as `/cpu/occa`,
509bcb2dfaeSJed Brown`/gpu/occa`, and `/omp/occa`.
510bcb2dfaeSJed BrownIt also included several examples, in the `examples` folder:
511bcb2dfaeSJed BrownA standalone code that shows the usage of libCEED (with no external
512bcb2dfaeSJed Browndependencies) to apply the Laplace operator, `ex1`; an `mfem` example to perform BP1
513bcb2dfaeSJed Brown(with the application of the mass operator); and a `petsc` example to perform BP1
514bcb2dfaeSJed Brown(with the application of the mass operator).
515bcb2dfaeSJed Brown
516bcb2dfaeSJed BrownBackends available in this release:
517bcb2dfaeSJed Brown
51868e843eeSJed Brown| CEED resource (`-ceed`) | Backend                         |
51968e843eeSJed Brown|-------------------------|---------------------------------|
52068e843eeSJed Brown| `/cpu/self`             | Serial reference implementation |
52168e843eeSJed Brown| `/cpu/occa`             | Serial OCCA kernels             |
52268e843eeSJed Brown| `/gpu/occa`             | CUDA OCCA kernels               |
52368e843eeSJed Brown| `/omp/occa`             | OpenMP OCCA kernels             |
524bcb2dfaeSJed Brown
525bcb2dfaeSJed BrownExamples available in this release:
526bcb2dfaeSJed Brown
527bcb2dfaeSJed Brown| User code             | Example                           |
52868e843eeSJed Brown|-----------------------|-----------------------------------|
52968e843eeSJed Brown| `ceed`                | ex1 (scalar Laplace operator)     |
53068e843eeSJed Brown| `mfem`                | BP1 (scalar mass operator)        |
53168e843eeSJed Brown| `petsc`               | BP1 (scalar mass operator)        |
532bcb2dfaeSJed Brown```
533