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. 1570a7ffb3SJeremy L Thompson- Add {c:func}`CeedOperatorLinearAssembleQFunctionBuildOrUpdate` to reduce object creation overhead in assembly of CeedOperator preconditioning ingredients. 164db537f9SJeremy L Thompson- Promote {c:func}`CeedOperatorCheckReady`to the public API to facilitate interactive interfaces. 17dcc1e3ecSJeremy L Thompson- Warning added when compiling OCCA backend to alert users that this backend is experimental. 189a1d3511SJeremy L Thompson- `ceed-backend.h`, `ceed-hash.h`, and `ceed-khash.h` removed. Users should use `ceed/backend.h`, `ceed/hash.h`, and `ceed/khash.h`. 1943e1b16fSJeremy L Thompson- Added {c:func}`CeedQFunctionGetKernelName`; refactored {c:func}`CeedQFunctionGetSourcePath` to exclude function kernel name. 207e7773b5SJeremy L Thompson 21f479eb23SJeremy L Thompson### New features 22f479eb23SJeremy L Thompson 23f479eb23SJeremy L Thompson- `CeedScalar` can now be set as `float` or `double` at compile time. 2430601ac0SJeremy L Thompson- Added JiT utilities in `ceed/jit-tools.h` to reduce duplicated code in GPU backends. 25fb3c7d02SJeremy L Thompson- Added support for JiT of QFunctions with `#include "relative/path/local-file.h"` statements for additional local files. Note that files included with `""` are searched relative to the current file first, then by compiler paths (as with `<>` includes). To use this feature, one should adhere to relative paths only, not compiler flags like `-I`, which the JiT will not be aware of. 2623dfbf5bSJeremy L Thompson- Remove need to guard library headers in QFunction source for code generation backends. 273f21f6b1SJeremy L Thompson- `CeedDebugEnv()` macro created to provide debugging outputs when Ceed context is not present. 28f479eb23SJeremy L Thompson 29bcb2dfaeSJed Brown### Maintainability 30bcb2dfaeSJed Brown 31bcb2dfaeSJed Brown- Refactored preconditioner support internally to facilitate future development and improve GPU completeness/test coverage. 32db52d626SJeremy L Thompson- `Include-what-you-use` makefile target added as `make iwyu`. 33*bf4cb664SJeremy L Thompson- Create backend constant `CEED_FIELD_MAX` to reduce magic numbers in codebase. 34bcb2dfaeSJed Brown 35bcb2dfaeSJed Brown(v0-9)= 36bcb2dfaeSJed Brown 37bcb2dfaeSJed Brown## v0.9 (Jul 6, 2021) 38bcb2dfaeSJed Brown 39bcb2dfaeSJed Brown### Interface changes 40bcb2dfaeSJed Brown 41bcb2dfaeSJed Brown- Minor modification in error handling macro to silence pedantic warnings when compiling with Clang, but no functional impact. 42bcb2dfaeSJed Brown 43bcb2dfaeSJed Brown### New features 44bcb2dfaeSJed Brown 45bcb2dfaeSJed Brown- Add {c:func}`CeedVectorAXPY` and {c:func}`CeedVectorPointwiseMult` as a convenience for stand-alone testing and internal use. 46bcb2dfaeSJed Brown- Add `CEED_QFUNCTION_HELPER` macro to properly annotate QFunction helper functions for code generation backends. 47bcb2dfaeSJed Brown- Add `CeedPragmaOptimizeOff` macro for code that is sensitive to floating point errors from fast math optimizations. 48bcb2dfaeSJed Brown- Rust support: split `libceed-sys` crate out of `libceed` and [publish both on crates.io](https://crates.io/crates/libceed). 49bcb2dfaeSJed Brown 50bcb2dfaeSJed Brown### Performance improvements 51bcb2dfaeSJed Brown 52bcb2dfaeSJed Brown### Examples 53bcb2dfaeSJed Brown 54bcb2dfaeSJed Brown- Solid mechanics mini-app updated to explore the performance impacts of various formulations in the initial and current configurations. 55bcb2dfaeSJed Brown- Fluid mechanics example adds GPU support and improves modularity. 56bcb2dfaeSJed Brown 57bcb2dfaeSJed Brown### Deprecated backends 58bcb2dfaeSJed Brown 59bcb2dfaeSJed 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. 60bcb2dfaeSJed Brown 61bcb2dfaeSJed Brown(v0-8)= 62bcb2dfaeSJed Brown 63bcb2dfaeSJed Brown## v0.8 (Mar 31, 2021) 64bcb2dfaeSJed Brown 65bcb2dfaeSJed Brown### Interface changes 66bcb2dfaeSJed Brown 67bcb2dfaeSJed Brown- Error handling improved to include enumerated error codes for C interface return values. 68bcb2dfaeSJed 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. 69bcb2dfaeSJed Brown 70bcb2dfaeSJed Brown### New features 71bcb2dfaeSJed Brown 72bcb2dfaeSJed Brown- Julia and Rust interfaces added, providing a nearly 1-1 correspondence with the C interface, plus some convenience features. 73bcb2dfaeSJed Brown- Static libraries can be built with `make STATIC=1` and the pkg-config file is installed accordingly. 74bcb2dfaeSJed Brown- Add {c:func}`CeedOperatorLinearAssembleSymbolic` and {c:func}`CeedOperatorLinearAssemble` to support full assembly of libCEED operators. 75bcb2dfaeSJed Brown 76bcb2dfaeSJed Brown### Performance improvements 77bcb2dfaeSJed Brown 78bcb2dfaeSJed Brown- New HIP MAGMA backends for hipMAGMA library users: `/gpu/hip/magma` and `/gpu/hip/magma/det`. 79bcb2dfaeSJed Brown- New HIP backends for improved tensor basis performance: `/gpu/hip/shared` and `/gpu/hip/gen`. 80bcb2dfaeSJed Brown 81bcb2dfaeSJed Brown### Examples 82bcb2dfaeSJed Brown 83bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` example updated with traction boundary conditions and improved Dirichlet boundary conditions. 84bcb2dfaeSJed 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. 85bcb2dfaeSJed 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. 86bcb2dfaeSJed Brown- {ref}`example-petsc-navier-stokes` example updated with support for performing convergence study and plotting order of convergence by polynomial degree. 87bcb2dfaeSJed Brown 88bcb2dfaeSJed Brown(v0-7)= 89bcb2dfaeSJed Brown 90bcb2dfaeSJed Brown## v0.7 (Sep 29, 2020) 91bcb2dfaeSJed Brown 92bcb2dfaeSJed Brown### Interface changes 93bcb2dfaeSJed Brown 94bcb2dfaeSJed Brown- Replace limited {code}`CeedInterlaceMode` with more flexible component stride {code}`compstride` in {code}`CeedElemRestriction` constructors. 95bcb2dfaeSJed 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`. 96bcb2dfaeSJed Brown These changes improve support for mixed finite element methods. 97bcb2dfaeSJed Brown- Replace various uses of {code}`Ceed*Get*Status` with {code}`Ceed*Is*` in the backend API to match common nomenclature. 98bcb2dfaeSJed Brown- Replace {code}`CeedOperatorAssembleLinearDiagonal` with {c:func}`CeedOperatorLinearAssembleDiagonal` for clarity. 99bcb2dfaeSJed 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. 100bcb2dfaeSJed 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. 101bcb2dfaeSJed 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. 102bcb2dfaeSJed 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. 103bcb2dfaeSJed 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`. 104bcb2dfaeSJed Brown- Added {code}`CeedQFunctionContext` object to manage user QFunction context data and reduce copies between device and host memory. 105bcb2dfaeSJed 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. 106bcb2dfaeSJed Brown 107bcb2dfaeSJed Brown### New features 108bcb2dfaeSJed Brown 109bcb2dfaeSJed Brown- New HIP backend: `/gpu/hip/ref`. 110bcb2dfaeSJed Brown- CeedQFunction support for user `CUfunction`s in some backends 111bcb2dfaeSJed Brown 112bcb2dfaeSJed Brown### Performance improvements 113bcb2dfaeSJed Brown 114bcb2dfaeSJed Brown- OCCA backend rebuilt to facilitate future performance enhancements. 115bcb2dfaeSJed Brown- Petsc BPs suite improved to reduce noise due to multiple calls to {code}`mpiexec`. 116bcb2dfaeSJed Brown 117bcb2dfaeSJed Brown### Examples 118bcb2dfaeSJed Brown 119bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` example updated with strain energy computation and more flexible boundary conditions. 120bcb2dfaeSJed Brown 121bcb2dfaeSJed Brown### Deprecated backends 122bcb2dfaeSJed Brown 123bcb2dfaeSJed Brown- The `/gpu/cuda/reg` backend has been removed, with its core features moved into `/gpu/cuda/ref` and `/gpu/cuda/shared`. 124bcb2dfaeSJed Brown 125bcb2dfaeSJed Brown(v0-6)= 126bcb2dfaeSJed Brown 127bcb2dfaeSJed Brown## v0.6 (Mar 29, 2020) 128bcb2dfaeSJed Brown 129bcb2dfaeSJed BrownlibCEED v0.6 contains numerous new features and examples, as well as expanded 130bcb2dfaeSJed Browndocumentation in [this new website](https://libceed.readthedocs.io). 131bcb2dfaeSJed Brown 132bcb2dfaeSJed Brown### New features 133bcb2dfaeSJed Brown 134bcb2dfaeSJed Brown- New Python interface using [CFFI](https://cffi.readthedocs.io/) provides a nearly 135bcb2dfaeSJed Brown 1-1 correspondence with the C interface, plus some convenience features. For instance, 136bcb2dfaeSJed Brown data stored in the {cpp:type}`CeedVector` structure are available without copy as 137bcb2dfaeSJed Brown {py:class}`numpy.ndarray`. Short tutorials are provided in 138bcb2dfaeSJed Brown [Binder](https://mybinder.org/v2/gh/CEED/libCEED/main?urlpath=lab/tree/examples/tutorials/). 139bcb2dfaeSJed Brown- Linear QFunctions can be assembled as block-diagonal matrices (per quadrature point, 140bcb2dfaeSJed Brown {c:func}`CeedOperatorAssembleLinearQFunction`) or to evaluate the diagonal 141bcb2dfaeSJed Brown ({c:func}`CeedOperatorAssembleLinearDiagonal`). These operations are useful for 142bcb2dfaeSJed Brown preconditioning ingredients and are used in the libCEED's multigrid examples. 143bcb2dfaeSJed Brown- The inverse of separable operators can be obtained using 144bcb2dfaeSJed Brown {c:func}`CeedOperatorCreateFDMElementInverse` and applied with 145bcb2dfaeSJed Brown {c:func}`CeedOperatorApply`. This is a useful preconditioning ingredient, 146bcb2dfaeSJed Brown especially for Laplacians and related operators. 147bcb2dfaeSJed Brown- New functions: {c:func}`CeedVectorNorm`, {c:func}`CeedOperatorApplyAdd`, 148bcb2dfaeSJed Brown {c:func}`CeedQFunctionView`, {c:func}`CeedOperatorView`. 149bcb2dfaeSJed Brown- Make public accessors for various attributes to facilitate writing composable code. 150bcb2dfaeSJed Brown- New backend: `/cpu/self/memcheck/serial`. 151bcb2dfaeSJed Brown- QFunctions using variable-length array (VLA) pointer constructs can be used with CUDA 152bcb2dfaeSJed Brown backends. (Single source is coming soon for OCCA backends.) 153bcb2dfaeSJed Brown- Fix some missing edge cases in CUDA backend. 154bcb2dfaeSJed Brown 155bcb2dfaeSJed Brown### Performance Improvements 156bcb2dfaeSJed Brown 157bcb2dfaeSJed Brown- MAGMA backend performance optimization and non-tensor bases. 158bcb2dfaeSJed Brown- No-copy optimization in {c:func}`CeedOperatorApply`. 159bcb2dfaeSJed Brown 160bcb2dfaeSJed Brown### Interface changes 161bcb2dfaeSJed Brown 162bcb2dfaeSJed Brown- Replace {code}`CeedElemRestrictionCreateIdentity` and 163bcb2dfaeSJed Brown {code}`CeedElemRestrictionCreateBlocked` with more flexible 164bcb2dfaeSJed Brown {c:func}`CeedElemRestrictionCreateStrided` and 165bcb2dfaeSJed Brown {c:func}`CeedElemRestrictionCreateBlockedStrided`. 166bcb2dfaeSJed Brown- Add arguments to {c:func}`CeedQFunctionCreateIdentity`. 167bcb2dfaeSJed Brown- Replace ambiguous uses of {cpp:enum}`CeedTransposeMode` for L-vector identification 168bcb2dfaeSJed Brown with {cpp:enum}`CeedInterlaceMode`. This is now an attribute of the 169bcb2dfaeSJed Brown {cpp:type}`CeedElemRestriction` (see {c:func}`CeedElemRestrictionCreate`) and no 170bcb2dfaeSJed Brown longer passed as `lmode` arguments to {c:func}`CeedOperatorSetField` and 171bcb2dfaeSJed Brown {c:func}`CeedElemRestrictionApply`. 172bcb2dfaeSJed Brown 173bcb2dfaeSJed Brown### Examples 174bcb2dfaeSJed Brown 175bcb2dfaeSJed BrownlibCEED-0.6 contains greatly expanded examples with {ref}`new documentation <Examples>`. 176bcb2dfaeSJed BrownNotable additions include: 177bcb2dfaeSJed Brown 178bcb2dfaeSJed Brown- Standalone {ref}`ex2-surface` ({file}`examples/ceed/ex2-surface`): compute the area of 179bcb2dfaeSJed Brown a domain in 1, 2, and 3 dimensions by applying a Laplacian. 180bcb2dfaeSJed Brown 181bcb2dfaeSJed Brown- PETSc {ref}`example-petsc-area` ({file}`examples/petsc/area.c`): computes surface area 182bcb2dfaeSJed Brown of domains (like the cube and sphere) by direct integration on a surface mesh; 183bcb2dfaeSJed Brown demonstrates geometric dimension different from topological dimension. 184bcb2dfaeSJed Brown 185bcb2dfaeSJed Brown- PETSc {ref}`example-petsc-bps`: 186bcb2dfaeSJed Brown 187bcb2dfaeSJed Brown - {file}`examples/petsc/bpsraw.c` (formerly `bps.c`): transparent CUDA support. 188bcb2dfaeSJed Brown - {file}`examples/petsc/bps.c` (formerly `bpsdmplex.c`): performance improvements 189bcb2dfaeSJed Brown and transparent CUDA support. 190bcb2dfaeSJed Brown - {ref}`example-petsc-bps-sphere` ({file}`examples/petsc/bpssphere.c`): 191bcb2dfaeSJed Brown generalizations of all CEED BPs to the surface of the sphere; demonstrates geometric 192bcb2dfaeSJed Brown dimension different from topological dimension. 193bcb2dfaeSJed Brown 194bcb2dfaeSJed Brown- {ref}`example-petsc-multigrid` ({file}`examples/petsc/multigrid.c`): new p-multigrid 195bcb2dfaeSJed Brown solver with algebraic multigrid coarse solve. 196bcb2dfaeSJed Brown 197bcb2dfaeSJed Brown- {ref}`example-petsc-navier-stokes` ({file}`examples/fluids/navierstokes.c`; formerly 198bcb2dfaeSJed Brown `examples/navier-stokes`): unstructured grid support (using PETSc's `DMPlex`), 199bcb2dfaeSJed Brown implicit time integration, SU/SUPG stabilization, free-slip boundary conditions, and 200bcb2dfaeSJed Brown quasi-2D computational domain support. 201bcb2dfaeSJed Brown 202bcb2dfaeSJed Brown- {ref}`example-petsc-elasticity` ({file}`examples/solids/elasticity.c`): new solver for 203bcb2dfaeSJed Brown linear elasticity, small-strain hyperelasticity, and globalized finite-strain 204bcb2dfaeSJed Brown hyperelasticity using p-multigrid with algebraic multigrid coarse solve. 205bcb2dfaeSJed Brown 206bcb2dfaeSJed Brown(v0-5)= 207bcb2dfaeSJed Brown 208bcb2dfaeSJed Brown## v0.5 (Sep 18, 2019) 209bcb2dfaeSJed Brown 210bcb2dfaeSJed BrownFor this release, several improvements were made. Two new CUDA backends were added to 211bcb2dfaeSJed Brownthe family of backends, of which, the new `cuda-gen` backend achieves state-of-the-art 212bcb2dfaeSJed Brownperformance using single-source {ref}`CeedQFunction`. From this release, users 213bcb2dfaeSJed Browncan define Q-Functions in a single source code independently of the targeted backend 214bcb2dfaeSJed Brownwith the aid of a new macro `CEED QFUNCTION` to support JIT (Just-In-Time) and CPU 215bcb2dfaeSJed Browncompilation of the user provided {ref}`CeedQFunction` code. To allow a unified 216bcb2dfaeSJed Browndeclaration, the {ref}`CeedQFunction` API has undergone a slight change: 217bcb2dfaeSJed Brownthe `QFunctionField` parameter `ncomp` has been changed to `size`. This change 218bcb2dfaeSJed Brownrequires setting the previous value of `ncomp` to `ncomp*dim` when adding a 219bcb2dfaeSJed Brown`QFunctionField` with eval mode `CEED EVAL GRAD`. 220bcb2dfaeSJed Brown 221bcb2dfaeSJed BrownAdditionally, new CPU backends 222bcb2dfaeSJed Brownwere included in this release, such as the `/cpu/self/opt/*` backends (which are 223bcb2dfaeSJed Brownwritten in pure C and use partial **E-vectors** to improve performance) and the 224bcb2dfaeSJed Brown`/cpu/self/ref/memcheck` backend (which relies upon the 225bcb2dfaeSJed Brown[Valgrind](http://valgrind.org/) Memcheck tool to help verify that user 226bcb2dfaeSJed Brown{ref}`CeedQFunction` have no undefined values). 227bcb2dfaeSJed BrownThis release also included various performance improvements, bug fixes, new examples, 228bcb2dfaeSJed Brownand improved tests. Among these improvements, vectorized instructions for 229bcb2dfaeSJed Brown{ref}`CeedQFunction` code compiled for CPU were enhanced by using `CeedPragmaSIMD` 230bcb2dfaeSJed Browninstead of `CeedPragmaOMP`, implementation of a {ref}`CeedQFunction` gallery and 231bcb2dfaeSJed Brownidentity Q-Functions were introduced, and the PETSc benchmark problems were expanded 232bcb2dfaeSJed Brownto include unstructured meshes handling were. For this expansion, the prior version of 233bcb2dfaeSJed Brownthe PETSc BPs, which only included data associated with structured geometries, were 234bcb2dfaeSJed Brownrenamed `bpsraw`, and the new version of the BPs, which can handle data associated 235bcb2dfaeSJed Brownwith any unstructured geometry, were called `bps`. Additionally, other benchmark 236bcb2dfaeSJed Brownproblems, namely BP2 and BP4 (the vector-valued versions of BP1 and BP3, respectively), 237bcb2dfaeSJed Brownand BP5 and BP6 (the collocated versions---for which the quadrature points are the same 238bcb2dfaeSJed Brownas the Gauss Lobatto nodes---of BP3 and BP4 respectively) were added to the PETSc 239bcb2dfaeSJed Brownexamples. Furthermoew, another standalone libCEED example, called `ex2`, which 240bcb2dfaeSJed Browncomputes the surface area of a given mesh was added to this release. 241bcb2dfaeSJed Brown 242bcb2dfaeSJed BrownBackends available in this release: 243bcb2dfaeSJed Brown 24468e843eeSJed Brown| CEED resource (`-ceed`) | Backend | 24568e843eeSJed Brown|--------------------------|-----------------------------------------------------| 24668e843eeSJed Brown| `/cpu/self/ref/serial` | Serial reference implementation | 24768e843eeSJed Brown| `/cpu/self/ref/blocked` | Blocked reference implementation | 24868e843eeSJed Brown| `/cpu/self/ref/memcheck` | Memcheck backend, undefined value checks | 24968e843eeSJed Brown| `/cpu/self/opt/serial` | Serial optimized C implementation | 25068e843eeSJed Brown| `/cpu/self/opt/blocked` | Blocked optimized C implementation | 25168e843eeSJed Brown| `/cpu/self/avx/serial` | Serial AVX implementation | 25268e843eeSJed Brown| `/cpu/self/avx/blocked` | Blocked AVX implementation | 25368e843eeSJed Brown| `/cpu/self/xsmm/serial` | Serial LIBXSMM implementation | 25468e843eeSJed Brown| `/cpu/self/xsmm/blocked` | Blocked LIBXSMM implementation | 25568e843eeSJed Brown| `/cpu/occa` | Serial OCCA kernels | 25668e843eeSJed Brown| `/gpu/occa` | CUDA OCCA kernels | 25768e843eeSJed Brown| `/omp/occa` | OpenMP OCCA kernels | 25868e843eeSJed Brown| `/ocl/occa` | OpenCL OCCA kernels | 25968e843eeSJed Brown| `/gpu/cuda/ref` | Reference pure CUDA kernels | 26068e843eeSJed Brown| `/gpu/cuda/reg` | Pure CUDA kernels using one thread per element | 26168e843eeSJed Brown| `/gpu/cuda/shared` | Optimized pure CUDA kernels using shared memory | 26268e843eeSJed Brown| `/gpu/cuda/gen` | Optimized pure CUDA kernels using code generation | 26368e843eeSJed Brown| `/gpu/magma` | CUDA MAGMA kernels | 264bcb2dfaeSJed Brown 265bcb2dfaeSJed BrownExamples available in this release: 266bcb2dfaeSJed Brown 26768e843eeSJed Brown:::{list-table} 26868e843eeSJed Brown:header-rows: 1 26968e843eeSJed Brown:widths: auto 27068e843eeSJed Brown* - User code 27168e843eeSJed Brown - Example 27268e843eeSJed Brown* - `ceed` 27368e843eeSJed Brown - * ex1 (volume) 27468e843eeSJed Brown * ex2 (surface) 27568e843eeSJed Brown* - `mfem` 27668e843eeSJed Brown - * BP1 (scalar mass operator) 27768e843eeSJed Brown * BP3 (scalar Laplace operator) 27868e843eeSJed Brown* - `petsc` 27968e843eeSJed Brown - * BP1 (scalar mass operator) 28068e843eeSJed Brown * BP2 (vector mass operator) 28168e843eeSJed Brown * BP3 (scalar Laplace operator) 28268e843eeSJed Brown * BP4 (vector Laplace operator) 28368e843eeSJed Brown * BP5 (collocated scalar Laplace operator) 28468e843eeSJed Brown * BP6 (collocated vector Laplace operator) 28568e843eeSJed Brown * Navier-Stokes 28668e843eeSJed Brown* - `nek5000` 28768e843eeSJed Brown - * BP1 (scalar mass operator) 28868e843eeSJed Brown * BP3 (scalar Laplace operator) 28968e843eeSJed Brown::: 290bcb2dfaeSJed Brown 291bcb2dfaeSJed Brown(v0-4)= 292bcb2dfaeSJed Brown 293bcb2dfaeSJed Brown## v0.4 (Apr 1, 2019) 294bcb2dfaeSJed Brown 295bcb2dfaeSJed BrownlibCEED v0.4 was made again publicly available in the second full CEED software 296bcb2dfaeSJed Browndistribution, release CEED 2.0. This release contained notable features, such as 297bcb2dfaeSJed Brownfour new CPU backends, two new GPU backends, CPU backend optimizations, initial 298bcb2dfaeSJed Brownsupport for operator composition, performance benchmarking, and a Navier-Stokes demo. 299bcb2dfaeSJed BrownThe new CPU backends in this release came in two families. The `/cpu/self/*/serial` 300bcb2dfaeSJed Brownbackends process one element at a time and are intended for meshes with a smaller number 301bcb2dfaeSJed Brownof high order elements. The `/cpu/self/*/blocked` backends process blocked batches of 302bcb2dfaeSJed Browneight interlaced elements and are intended for meshes with higher numbers of elements. 303bcb2dfaeSJed BrownThe `/cpu/self/avx/*` backends rely upon AVX instructions to provide vectorized CPU 304bcb2dfaeSJed Brownperformance. The `/cpu/self/xsmm/*` backends rely upon the 305bcb2dfaeSJed Brown[LIBXSMM](http://github.com/hfp/libxsmm) package to provide vectorized CPU 306bcb2dfaeSJed Brownperformance. The `/gpu/cuda/*` backends provide GPU performance strictly using CUDA. 307bcb2dfaeSJed BrownThe `/gpu/cuda/ref` backend is a reference CUDA backend, providing reasonable 308bcb2dfaeSJed Brownperformance for most problem configurations. The `/gpu/cuda/reg` backend uses a simple 309bcb2dfaeSJed Brownparallelization approach, where each thread treats a finite element. Using just in time 310bcb2dfaeSJed Browncompilation, provided by nvrtc (NVidia Runtime Compiler), and runtime parameters, this 311bcb2dfaeSJed Brownbackend unroll loops and map memory address to registers. The `/gpu/cuda/reg` backend 312bcb2dfaeSJed Brownachieve good peak performance for 1D, 2D, and low order 3D problems, but performance 313bcb2dfaeSJed Browndeteriorates very quickly when threads run out of registers. 314bcb2dfaeSJed Brown 315bcb2dfaeSJed BrownA new explicit time-stepping Navier-Stokes solver was added to the family of libCEED 316bcb2dfaeSJed Brownexamples in the `examples/petsc` directory (see {ref}`example-petsc-navier-stokes`). 317bcb2dfaeSJed BrownThis example solves the time-dependent Navier-Stokes equations of compressible gas 318bcb2dfaeSJed Browndynamics in a static Eulerian three-dimensional frame, using structured high-order 319bcb2dfaeSJed Brownfinite/spectral element spatial discretizations and explicit high-order time-stepping 320bcb2dfaeSJed Brown(available in PETSc). Moreover, the Navier-Stokes example was developed using PETSc, 321bcb2dfaeSJed Brownso that the pointwise physics (defined at quadrature points) is separated from the 322bcb2dfaeSJed Brownparallelization and meshing concerns. 323bcb2dfaeSJed Brown 324bcb2dfaeSJed BrownBackends available in this release: 325bcb2dfaeSJed Brown 32668e843eeSJed Brown| CEED resource (`-ceed`) | Backend | 32768e843eeSJed Brown|--------------------------|-----------------------------------------------------| 32868e843eeSJed Brown| `/cpu/self/ref/serial` | Serial reference implementation | 32968e843eeSJed Brown| `/cpu/self/ref/blocked` | Blocked reference implementation | 33068e843eeSJed Brown| `/cpu/self/tmpl` | Backend template, defaults to `/cpu/self/blocked` | 33168e843eeSJed Brown| `/cpu/self/avx/serial` | Serial AVX implementation | 33268e843eeSJed Brown| `/cpu/self/avx/blocked` | Blocked AVX implementation | 33368e843eeSJed Brown| `/cpu/self/xsmm/serial` | Serial LIBXSMM implementation | 33468e843eeSJed Brown| `/cpu/self/xsmm/blocked` | Blocked LIBXSMM implementation | 33568e843eeSJed Brown| `/cpu/occa` | Serial OCCA kernels | 33668e843eeSJed Brown| `/gpu/occa` | CUDA OCCA kernels | 33768e843eeSJed Brown| `/omp/occa` | OpenMP OCCA kernels | 33868e843eeSJed Brown| `/ocl/occa` | OpenCL OCCA kernels | 33968e843eeSJed Brown| `/gpu/cuda/ref` | Reference pure CUDA kernels | 34068e843eeSJed Brown| `/gpu/cuda/reg` | Pure CUDA kernels using one thread per element | 34168e843eeSJed Brown| `/gpu/magma` | CUDA MAGMA kernels | 342bcb2dfaeSJed Brown 343bcb2dfaeSJed BrownExamples available in this release: 344bcb2dfaeSJed Brown 34568e843eeSJed Brown:::{list-table} 34668e843eeSJed Brown:header-rows: 1 34768e843eeSJed Brown:widths: auto 34868e843eeSJed Brown* - User code 34968e843eeSJed Brown - Example 35068e843eeSJed Brown* - `ceed` 35168e843eeSJed Brown - * ex1 (volume) 35268e843eeSJed Brown* - `mfem` 35368e843eeSJed Brown - * BP1 (scalar mass operator) 35468e843eeSJed Brown * BP3 (scalar Laplace operator) 35568e843eeSJed Brown* - `petsc` 35668e843eeSJed Brown - * BP1 (scalar mass operator) 35768e843eeSJed Brown * BP3 (scalar Laplace operator) 35868e843eeSJed Brown * Navier-Stokes 35968e843eeSJed Brown* - `nek5000` 36068e843eeSJed Brown - * BP1 (scalar mass operator) 36168e843eeSJed Brown * BP3 (scalar Laplace operator) 36268e843eeSJed Brown::: 363bcb2dfaeSJed Brown 364bcb2dfaeSJed Brown(v0-3)= 365bcb2dfaeSJed Brown 366bcb2dfaeSJed Brown## v0.3 (Sep 30, 2018) 367bcb2dfaeSJed Brown 368bcb2dfaeSJed BrownNotable features in this release include active/passive field interface, support for 369bcb2dfaeSJed Brownnon-tensor bases, backend optimization, and improved Fortran interface. This release 370bcb2dfaeSJed Brownalso focused on providing improved continuous integration, and many new tests with code 371bcb2dfaeSJed Browncoverage reports of about 90%. This release also provided a significant change to the 372bcb2dfaeSJed Brownpublic interface: a {ref}`CeedQFunction` can take any number of named input and output 373bcb2dfaeSJed Brownarguments while {ref}`CeedOperator` connects them to the actual data, which may be 374bcb2dfaeSJed Brownsupplied explicitly to `CeedOperatorApply()` (active) or separately via 375bcb2dfaeSJed Brown`CeedOperatorSetField()` (passive). This interface change enables reusable libraries 376bcb2dfaeSJed Brownof CeedQFunctions and composition of block solvers constructed using 377bcb2dfaeSJed Brown{ref}`CeedOperator`. A concept of blocked restriction was added to this release and 378bcb2dfaeSJed Brownused in an optimized CPU backend. Although this is typically not visible to the user, 379bcb2dfaeSJed Brownit enables effective use of arbitrary-length SIMD while maintaining cache locality. 380bcb2dfaeSJed BrownThis CPU backend also implements an algebraic factorization of tensor product gradients 381bcb2dfaeSJed Brownto perform fewer operations than standard application of interpolation and 382bcb2dfaeSJed Browndifferentiation from nodes to quadrature points. This algebraic formulation 383bcb2dfaeSJed Brownautomatically supports non-polynomial and non-interpolatory bases, thus is more general 384bcb2dfaeSJed Brownthan the more common derivation in terms of Lagrange polynomials on the quadrature points. 385bcb2dfaeSJed Brown 386bcb2dfaeSJed BrownBackends available in this release: 387bcb2dfaeSJed Brown 38868e843eeSJed Brown| CEED resource (`-ceed`) | Backend | 38968e843eeSJed Brown|-------------------------|-----------------------------------------------------| 39068e843eeSJed Brown| `/cpu/self/blocked` | Blocked reference implementation | 39168e843eeSJed Brown| `/cpu/self/ref` | Serial reference implementation | 39268e843eeSJed Brown| `/cpu/self/tmpl` | Backend template, defaults to `/cpu/self/blocked` | 39368e843eeSJed Brown| `/cpu/occa` | Serial OCCA kernels | 39468e843eeSJed Brown| `/gpu/occa` | CUDA OCCA kernels | 39568e843eeSJed Brown| `/omp/occa` | OpenMP OCCA kernels | 39668e843eeSJed Brown| `/ocl/occa` | OpenCL OCCA kernels | 39768e843eeSJed Brown| `/gpu/magma` | CUDA MAGMA kernels | 398bcb2dfaeSJed Brown 399bcb2dfaeSJed BrownExamples available in this release: 400bcb2dfaeSJed Brown 40168e843eeSJed Brown:::{list-table} 40268e843eeSJed Brown:header-rows: 1 40368e843eeSJed Brown:widths: auto 40468e843eeSJed Brown* - User code 40568e843eeSJed Brown - Example 40668e843eeSJed Brown* - `ceed` 40768e843eeSJed Brown - * ex1 (volume) 40868e843eeSJed Brown* - `mfem` 40968e843eeSJed Brown - * BP1 (scalar mass operator) 41068e843eeSJed Brown * BP3 (scalar Laplace operator) 41168e843eeSJed Brown* - `petsc` 41268e843eeSJed Brown - * BP1 (scalar mass operator) 41368e843eeSJed Brown * BP3 (scalar Laplace operator) 41468e843eeSJed Brown* - `nek5000` 41568e843eeSJed Brown - * BP1 (scalar mass operator) 41668e843eeSJed Brown * BP3 (scalar Laplace operator) 41768e843eeSJed Brown::: 418bcb2dfaeSJed Brown 419bcb2dfaeSJed Brown(v0-21)= 420bcb2dfaeSJed Brown 421bcb2dfaeSJed Brown## v0.21 (Sep 30, 2018) 422bcb2dfaeSJed Brown 423bcb2dfaeSJed BrownA MAGMA backend (which relies upon the 424bcb2dfaeSJed Brown[MAGMA](https://bitbucket.org/icl/magma) package) was integrated in libCEED for this 425bcb2dfaeSJed Brownrelease. This initial integration set up the framework of using MAGMA and provided the 426bcb2dfaeSJed BrownlibCEED functionality through MAGMA kernels as one of libCEED’s computational backends. 427bcb2dfaeSJed BrownAs any other backend, the MAGMA backend provides extended basic data structures for 428bcb2dfaeSJed Brown{ref}`CeedVector`, {ref}`CeedElemRestriction`, and {ref}`CeedOperator`, and implements 429bcb2dfaeSJed Brownthe fundamental CEED building blocks to work with the new data structures. 430bcb2dfaeSJed BrownIn general, the MAGMA-specific data structures keep the libCEED pointers to CPU data 431bcb2dfaeSJed Brownbut also add corresponding device (e.g., GPU) pointers to the data. Coherency is handled 432bcb2dfaeSJed Browninternally, and thus seamlessly to the user, through the functions/methods that are 433bcb2dfaeSJed Brownprovided to support them. 434bcb2dfaeSJed Brown 435bcb2dfaeSJed BrownBackends available in this release: 436bcb2dfaeSJed Brown 43768e843eeSJed Brown| CEED resource (`-ceed`) | Backend | 43868e843eeSJed Brown|-------------------------|---------------------------------| 43968e843eeSJed Brown| `/cpu/self` | Serial reference implementation | 44068e843eeSJed Brown| `/cpu/occa` | Serial OCCA kernels | 44168e843eeSJed Brown| `/gpu/occa` | CUDA OCCA kernels | 44268e843eeSJed Brown| `/omp/occa` | OpenMP OCCA kernels | 44368e843eeSJed Brown| `/ocl/occa` | OpenCL OCCA kernels | 44468e843eeSJed Brown| `/gpu/magma` | CUDA MAGMA kernels | 445bcb2dfaeSJed Brown 446bcb2dfaeSJed BrownExamples available in this release: 447bcb2dfaeSJed Brown 44868e843eeSJed Brown:::{list-table} 44968e843eeSJed Brown:header-rows: 1 45068e843eeSJed Brown:widths: auto 45168e843eeSJed Brown* - User code 45268e843eeSJed Brown - Example 45368e843eeSJed Brown* - `ceed` 45468e843eeSJed Brown - * ex1 (volume) 45568e843eeSJed Brown* - `mfem` 45668e843eeSJed Brown - * BP1 (scalar mass operator) 45768e843eeSJed Brown * BP3 (scalar Laplace operator) 45868e843eeSJed Brown* - `petsc` 45968e843eeSJed Brown - * BP1 (scalar mass operator) 46068e843eeSJed Brown* - `nek5000` 46168e843eeSJed Brown - * BP1 (scalar mass operator) 46268e843eeSJed Brown::: 463bcb2dfaeSJed Brown 464bcb2dfaeSJed Brown(v0-2)= 465bcb2dfaeSJed Brown 466bcb2dfaeSJed Brown## v0.2 (Mar 30, 2018) 467bcb2dfaeSJed Brown 468bcb2dfaeSJed BrownlibCEED was made publicly available the first full CEED software distribution, release 469bcb2dfaeSJed BrownCEED 1.0. The distribution was made available using the Spack package manager to provide 470bcb2dfaeSJed Browna common, easy-to-use build environment, where the user can build the CEED distribution 471bcb2dfaeSJed Brownwith all dependencies. This release included a new Fortran interface for the library. 472bcb2dfaeSJed BrownThis release also contained major improvements in the OCCA backend (including a new 473bcb2dfaeSJed Brown`/ocl/occa` backend) and new examples. The standalone libCEED example was modified to 474bcb2dfaeSJed Browncompute the volume volume of a given mesh (in 1D, 2D, or 3D) and placed in an 475bcb2dfaeSJed Brown`examples/ceed` subfolder. A new `mfem` example to perform BP3 (with the application 476bcb2dfaeSJed Brownof the Laplace operator) was also added to this release. 477bcb2dfaeSJed Brown 478bcb2dfaeSJed BrownBackends available in this release: 479bcb2dfaeSJed Brown 48068e843eeSJed Brown| CEED resource (`-ceed`) | Backend | 48168e843eeSJed Brown|-------------------------|---------------------------------| 48268e843eeSJed Brown| `/cpu/self` | Serial reference implementation | 48368e843eeSJed Brown| `/cpu/occa` | Serial OCCA kernels | 48468e843eeSJed Brown| `/gpu/occa` | CUDA OCCA kernels | 48568e843eeSJed Brown| `/omp/occa` | OpenMP OCCA kernels | 48668e843eeSJed Brown| `/ocl/occa` | OpenCL OCCA kernels | 487bcb2dfaeSJed Brown 488bcb2dfaeSJed BrownExamples available in this release: 489bcb2dfaeSJed Brown 49068e843eeSJed Brown:::{list-table} 49168e843eeSJed Brown:header-rows: 1 49268e843eeSJed Brown:widths: auto 49368e843eeSJed Brown* - User code 49468e843eeSJed Brown - Example 49568e843eeSJed Brown* - `ceed` 49668e843eeSJed Brown - * ex1 (volume) 49768e843eeSJed Brown* - `mfem` 49868e843eeSJed Brown - * BP1 (scalar mass operator) 49968e843eeSJed Brown * BP3 (scalar Laplace operator) 50068e843eeSJed Brown* - `petsc` 50168e843eeSJed Brown - * BP1 (scalar mass operator) 50268e843eeSJed Brown* - `nek5000` 50368e843eeSJed Brown - * BP1 (scalar mass operator) 50468e843eeSJed Brown::: 505bcb2dfaeSJed Brown 506bcb2dfaeSJed Brown(v0-1)= 507bcb2dfaeSJed Brown 508bcb2dfaeSJed Brown## v0.1 (Jan 3, 2018) 509bcb2dfaeSJed Brown 510bcb2dfaeSJed BrownInitial low-level API of the CEED project. The low-level API provides a set of Finite 511bcb2dfaeSJed BrownElements kernels and components for writing new low-level kernels. Examples include: 512bcb2dfaeSJed Brownvector and sparse linear algebra, element matrix assembly over a batch of elements, 513bcb2dfaeSJed Brownpartial assembly and action for efficient high-order operators like mass, diffusion, 514bcb2dfaeSJed Brownadvection, etc. The main goal of the low-level API is to establish the basis for the 515bcb2dfaeSJed Brownhigh-level API. Also, identifying such low-level kernels and providing a reference 516bcb2dfaeSJed Brownimplementation for them serves as the basis for specialized backend implementations. 517bcb2dfaeSJed BrownThis release contained several backends: `/cpu/self`, and backends which rely upon the 518bcb2dfaeSJed Brown[OCCA](http://github.com/libocca/occa) package, such as `/cpu/occa`, 519bcb2dfaeSJed Brown`/gpu/occa`, and `/omp/occa`. 520bcb2dfaeSJed BrownIt also included several examples, in the `examples` folder: 521bcb2dfaeSJed BrownA standalone code that shows the usage of libCEED (with no external 522bcb2dfaeSJed Browndependencies) to apply the Laplace operator, `ex1`; an `mfem` example to perform BP1 523bcb2dfaeSJed Brown(with the application of the mass operator); and a `petsc` example to perform BP1 524bcb2dfaeSJed Brown(with the application of the mass operator). 525bcb2dfaeSJed Brown 526bcb2dfaeSJed BrownBackends available in this release: 527bcb2dfaeSJed Brown 52868e843eeSJed Brown| CEED resource (`-ceed`) | Backend | 52968e843eeSJed Brown|-------------------------|---------------------------------| 53068e843eeSJed Brown| `/cpu/self` | Serial reference implementation | 53168e843eeSJed Brown| `/cpu/occa` | Serial OCCA kernels | 53268e843eeSJed Brown| `/gpu/occa` | CUDA OCCA kernels | 53368e843eeSJed Brown| `/omp/occa` | OpenMP OCCA kernels | 534bcb2dfaeSJed Brown 535bcb2dfaeSJed BrownExamples available in this release: 536bcb2dfaeSJed Brown 537bcb2dfaeSJed Brown| User code | Example | 53868e843eeSJed Brown|-----------------------|-----------------------------------| 53968e843eeSJed Brown| `ceed` | ex1 (scalar Laplace operator) | 54068e843eeSJed Brown| `mfem` | BP1 (scalar mass operator) | 54168e843eeSJed Brown| `petsc` | BP1 (scalar mass operator) | 542bcb2dfaeSJed Brown``` 543