Crate libceed_sys[][src]

Expand description

libCEED Rust Interface

This is the documentation for the low level (unsafe) Rust bindings to the libCEED C interface. See the libCEED user manual for usage information. Note that most Rust users will prefer the higher level (safe) Rust interface in the libceed package.

libCEED is a low-level API for for the efficient high-order discretization methods developed by the ECP co-design Center for Efficient Exascale Discretizations (CEED). While our focus is on high-order finite elements, the approach is mostly algebraic and thus applicable to other discretizations in factored form.

Usage

To use low level libCEED bindings in a Rust package, the following Cargo.toml can be used.

[dependencies]
libceed-sys = "0.8.0"

For a development version of the libCEED Rust bindings, use the following Cargo.toml.

[dependencies]
libceed-sys = { git = "https://github.com/CEED/libCEED", branch = "main" }

Supported features:

  • static (default): link to static libceed.a
  • system: use libceed from a system directory (otherwise, install from source)

Development

To develop libCEED, use cargo build in the rust/libceed-sys directory to install a local copy and build the bindings. If you need custom flags for the C project, we recommend using make configure to cache arguments. If you disable the static feature, then you’ll need to set LD_LIBRARY_PATH for doctests to be able to find it. You can do this in $CEED_DIR/lib and set PKG_CONFIG_PATH.

Note: the LD_LIBRARY_PATH workarounds will become unnecessary if this issue is resolved – it’s currently closed, but the problem still exists.

Modules

bind_ceed