Adds callback support to Klee's Lua input by kennyweiss · Pull Request #1962 · llnl/axom

kennyweiss · 2026-08-25T03:34:29Z

Summary

This feature PR adds callback support to Klee's Lua input
It also adds the ability to pass a separate initialization context (a Lua table) into Klee (Lua only)
- This allows users to provide their own variables/functions to override information in the Lua input
- E.g. the Klee input might have dimension-specific logic, and this initialization context allows then to set the dimension
The callback support allows fields to support function alternatives via the new inlet addFunctionAsValueAlternative()
Docs: https://axom.readthedocs.io/en/feature-kweiss-klee-lua-callbacks/

TODO

Update RELEASE-NOTES

BradWhitlock

Looks good to me.

Converted some SLIC_ERROR() calls to throwing exceptions so we can provide better error handling.

…deck Users can pass in a lua table containing variables and functions.

Adds inlet::KleeReader::shouldTreatFunctionAsNotFound() as a way to override default behavior. This defaults to false, but is overriden by klee to allow functions for scalars/maps.

Specifically, the variables can be modified within the deck.

* Removed scalar->vector coersion. Need to return a table with one entry rather than a scalar * Stop storing name for operators. They were not used * Removed unreachable duplicate export extraction

Bindings operate in isolated environment so they don't inherit or affect the global state.

This avoids extra calls for variables vs. tabular Lua input.

We have to explicitly register which paths can contain callbacks with inlet.

* Tags function alternatives as internal Sidre groups so restart reconstruction doesn't expose callback storage as ordinary fields * Reject multiple callback alternatives for the same input path and documents this

…ables directly

…tives to values

… first We previously overcomplicated the solution to allow order independence, which does not seem necessary. The simplified approach allows us to treat the result as an ordinary function.

Only support a Lua table as input, not a ket/value map.

…gexes for tests

… callback evaluation And documents when we use SLIC_ERROR/SLIC_WARNING vs. validation checks vs. throwing.

…g double

And adds a minor missing one.

…root

kennyweiss requested review from Arlie-Capps, BradWhitlock, adayton1, bmhan12, jcs15c, publixsubfan, rhornung67 and white238 August 25, 2026 03:34

kennyweiss self-assigned this Aug 25, 2026

kennyweiss added Inlet Klee Related to the Klee component labels Aug 25, 2026

kennyweiss mentioned this pull request Aug 25, 2026

Adds missing subscript operator to ArrayIteratorBase #1963

Merged

kennyweiss force-pushed the feature/kweiss/klee-lua-callbacks branch from 60d7019 to 353e98e Compare August 27, 2026 05:32

BradWhitlock approved these changes Aug 27, 2026

View reviewed changes

kennyweiss and others added 16 commits August 27, 2026 18:22

Klee: Adds callback functionality to lua-based Klee input

59ba170

Converted some SLIC_ERROR() calls to throwing exceptions so we can provide better error handling.

Klee: Adds ability to load variables into klee lua

2b84e46

Klee: Adds LuaBindingChunk as a way of passing state to the lua Klee …

a76830f

…deck Users can pass in a lua table containing variables and functions.

Improves how we override inlet checks for functions

55d43a2

Adds inlet::KleeReader::shouldTreatFunctionAsNotFound() as a way to override default behavior. This defaults to false, but is overriden by klee to allow functions for scalars/maps.

Only load the shapeset once in the tutorial example

e99d25f

inlet: keep Lua state alive for returned functions

0459b14

klee: Improves docs and tests about input lua variables to klee deck

2d427b0

Specifically, the variables can be modified within the deck.

klee: Improves test that compares lua and yaml parsing

987b8c2

docs: demonstrate callback-based Klee Lua tutorial deck

f0a3035

Klee: several cleanups to callback support

be06403

* Removed scalar->vector coersion. Need to return a table with one entry rather than a scalar * Stop storing name for operators. They were not used * Removed unreachable duplicate export extraction

Klee: Isolates Lua bindings environment

725ed5c

Bindings operate in isolated environment so they don't inherit or affect the global state.

Klee: Streamlines variables/bindings for Lua input into single struct

016c46c

This avoids extra calls for variables vs. tabular Lua input.

Klee: Improved validation of user input -- checks for lua keywords

404fbf3

Reworks callback registration in Inlet/Klee

0f81df2

We have to explicitly register which paths can contain callbacks with inlet.

Klee: Improves internal plumbing of Lua callbacks

ed6a381

Inlet: Improves path-finding for nested callback aliases

f845e3f

kennyweiss and others added 29 commits August 27, 2026 18:23

Klee: Adds tests for callbacks on operators

d47bf96

Integrates Lua callbacks into quest shaping example and tutorial

bfb0709

Updates data submodule with new shaping example

b20c615

Inlet: Defines restart behavior for function alternatives

992cfd5

* Tags function alternatives as internal Sidre groups so restart reconstruction doesn't expose callback storage as ordinary fields * Reject multiple callback alternatives for the same input path and documents this

Inlet: Improve docs and examples related to lua functions

828936f

Light touchup to docs for consistency

6d31e04

Klee: Improves error messages related to Slice callbacks

6799395

Inlet: Simplifies changes to support callbacks as value alternates

3491517

Adds missing doxygen to new/changed functions

7f06c0b

Inlet: Function value alternatives now own their FunctionVariant call…

3a6f114

…ables directly

Inlet; Adds a single canonical path for handling functions as alterna…

2794a91

…tives to values

Inlet: Cleanup -- removes unnecessary traversal function

efa90db

Inlet: Consolidates/streamlines new inlet tests

0183ea4

Inlet: Streamlines new user and developer docs

1f78feb

Minor fixup for formatting and a return variable

d6cbb4e

Inlet: Simplifies addFunctionAsValueAlternative by requiring it to be…

0f25993

… first We previously overcomplicated the solution to allow order independence, which does not seem necessary. The simplified approach allows us to treat the result as an ordinary function.

Klee: Consistently declares callbacks before data for operators

a778933

Klee: Removes SingleOperatorData -- it was an unnecessary abstraction

dc6e9ed

Klee: Simplifies error/exception messages in GeometryOperatorsIO

d773826

Klee: Simplifies Lua initialization to Klee input

a26457a

Only support a Lua table as input, not a ket/value map.

Klee: Fixes transposed parameters in an error message and improves re…

4abd283

…gexes for tests

Klee: Documents processing order for Klee operators and shapes

9dbd5e4

Bugfix for bump dependency in mesh clipper

1bd1c0b

Inlet: Use InletError instead of std::runtime_error for errors during…

df9d446

… callback evaluation And documents when we use SLIC_ERROR/SLIC_WARNING vs. validation checks vs. throwing.

Inlet: Add error message if setting function alternative after settin…

d313f57

…g double

Klee: Use string_view to avoid warning

740799f

Klee: Removes redundant io tests

5a84b81

And adds a minor missing one.

Avoids race condition in shaping tutorial tests when writing shaping.…

bc2bad0

…root

Formats code

b3663e1

kennyweiss force-pushed the feature/kweiss/klee-lua-callbacks branch from 353e98e to b3663e1 Compare August 28, 2026 01:29

Navigation Menu

Uh oh!

Adds callback support to Klee's Lua input - #1962

Adds callback support to Klee's Lua input#1962
kennyweiss wants to merge 52 commits into
developfrom
feature/kweiss/klee-lua-callbacks

kennyweiss commented Aug 25, 2026 •

edited

Loading

Uh oh!

BradWhitlock left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

kennyweiss commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

TODO

Uh oh!

BradWhitlock left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kennyweiss commented Aug 25, 2026 •

edited

Loading