Skip to main content

Crate sim_lib_femm_function

Crate sim_lib_femm_function 

Source
Expand description

FEMM models as first-class callable runtime functions.

The kernel defines the Value/Expr/Shape/codec protocol contracts and sim-numbers supplies the number domains, tensors, and linear algebra; this crate supplies the FEM behavior: it wraps a model as a callable that maps parameters to quantities, fields, or solutions, and registers those callables and the model value with the runtime.

The quality surface returns a quantity value together with the sim_lib_femm_solve::SolveCertificate that proves solve fidelity. Passing Some(params) for wrt adds a total gradient and annotates the returned certificate with the corresponding GradientTrust; passing None returns the value and certificate without gradient work.

Structs§

FemmCall
One evaluation request against a model: which parameters, output, and limits.
FemmEval
The result of evaluating a model: the output value plus optional gradient.
FemmFuncPayload
The opaque payload carried by a model-derived runtime function.
FemmFunctionLib
The runtime library that installs the FEMM function exports.
ModelCallable
A FemmCallable that solves a concrete model on each evaluation.
ModelValue
A FEMM model held as a first-class runtime object.
QualityAnswer
Quantity value, certificate, and optional total gradient for a completed solve.

Enums§

OutputQuery
The kind of output an evaluation produces from a solved model.

Traits§

FemmCallable
Something that can be evaluated as a FEMM function of its parameters.

Functions§

femm_as_func
Wraps a model as a sim-numbers Func of the named variables.
femm_field_func
Wraps a model’s potential field as a sim-numbers Func over position.
model_value
Wraps a model as a ModelValue runtime object.
quality
Returns the requested quantity and the certificate for a completed solve.