Edit on GitHub

Library configuration

By default, LibCEED.jl uses a "basic version" of the libCEED library that is bundled as a pre-built binary. In order to access more advanced features (CUDA support, architecture-specific compiler flags, etc.), users can use LibCEED.jl with a other versions of the libCEED library (e.g. compiled from source).

This is achieved by by calling set_libceed_path! with the path to the library file. The choice of library file is stored as a per-environment preference. For changes to take effect, the Julia session must be restarted. The library currently being used by LibCEED.jl can be queried using get_libceed_path.

The version number of the currently loaded libCEED library can also be queried using ceedversion.

LibCEED.ceedversion — Function
ceedversion()

Returns a VersionNumber corresponding to the version of the libCEED library currently used.

source
LibCEED.isrelease — Function
isrelease()

Returns true if the libCEED library is a release build, false otherwise.

source
LibCEED.set_libceed_path! — Function
set_libceed_path!(path::AbstractString)
set_libceed_path!(:prebuilt)
set_libceed_path!(:default)

Sets the path of the libCEED dynamic library. path should be the absolute path to the library file.

set_libceed_path!(:prebuilt) indicates to LibCEED.jl to use the prebuilt version of the libCEED library (bundled with libCEED_jll).

set_libceed_path!(:default) indicates to LibCEED.jl to use the default library. This usually has the same effect as set_libceed_path!(:prebuilt), unless a different path has been specified in the depot-wide preferences or using Overrides.toml.

This function sets the library path as a preference associated with the currently active environment. Changes will take effect after restarting the Julia session. See the Preferences.jl documentation for more information.

source
LibCEED.use_prebuilt_libceed! — Function
use_prebuilt_libceed!()

Indicates that the prebuilt version of the libCEED library (bundled with libCEED_jll) should be used.

Equivalent to set_libceed_path!(:prebuilt).

source