Function reference
Parameter Extraction
| extraction.extract_parameters | Extract parameters from a Fluent tree. |
Functionalize
| functionalize.functionalize | Compile an SDF to a pure function with free and fixed parameters. |
| functionalize.functionalize_parametric | Compile an SDF to a function whose parameters are arguments. |
| functionalize.functionalize_scene | Compile a geometry SDF tree to pure (sdf, material_fn) closures. |
| functionalize.functionalize_scene_parametric | Compile a scene so its parameters are arguments, not literals. |
Compilation cache
| cache.enable_compilation_cache | Point JAX’s persistent compilation cache at a stable directory. |
| cache.cache_directory | Where compiled executables are stored. |
Shader compilation
| backends.wgsl.codegen.compile_sdf_to_wgsl | Compile a JAX SDF function to a WGSL function string. |
| backends.wgsl.codegen.compile_scene_to_wgsl | Compile an SDF and its material evaluation to one WGSL module. |
Parametrization
| parametrization.to_normalized | to_unconstrained followed by normalize. |
| parametrization.from_normalized | unnormalize followed by to_constrained. |
| parametrization.compute_param_scales | Compute per-parameter normalization scales. |
Constraints — types
| constraints.types.base.Constraint | Base class for geometric constraints. |
| constraints.types.distance.DistanceConstraint | Constraint that fixes the distance between two points/vectors. |
| constraints.types.angle.AngleConstraint | Constraint that fixes the angle between two vectors. |
| constraints.types.parallel.ParallelConstraint | Constraint that forces two vectors to be parallel. |
| constraints.types.perpendicular.PerpendicularConstraint | Constraint that forces two vectors to be perpendicular. |
Constraints — solver
| constraints.solve.solve_constraints | Solve geometric constraints attached to a scene’s free parameters. |
| constraints.solve.satisfy_constraints | Project a construction/SDF tree onto its attached constraints in place. |
| constraints.solve.project_to_manifold | Project free_params onto the constraint manifold via Newton correction(s). |
| constraints.solve.constraint_residuals | Evaluate the constraint residuals at free_params. |
| constraints.solve.make_manifold_projection | Return an optax transform that projects params onto the constraint manifold. |
Geometry
| geometry.parameters.Vector | 3D vector parameter (position, offset, direction, size). |
| geometry.parameters.Scalar | Scalar parameter (radius, distance, angle, scale, strength, etc.). |
Meshing — extraction
| meshing.edge_detection.GridSpec | Regular sampling grid described by static Python values. |
| meshing.dual_contouring.Mesh | Dual-contour surface mesh. |
| meshing.dual_contouring.extract_mesh | Extract a feature-preserving dual-contour mesh from an implicit field. |
| meshing.edge_detection.sample_grid | Evaluate the field at every lattice vertex. |
| meshing.edge_detection.find_crossing_edges | Find every lattice edge whose endpoints lie on opposite sides of level. |
| meshing.edge_detection.edge_hermite_data | Locate the surface crossing on every edge and evaluate its gradient. |
| meshing.edge_detection.detect_edges | Sample, detect crossing edges, and refine Hermite data in one call. |
| meshing.features.manifold_cell_incidence | Group crossing edges by cell and by inside-corner component. |
| meshing.features.classify_feature_cells | Classify active cells as face, crease, or corner from normal spread. |
| meshing.dual_contouring.qef_vertices | Place one vertex per active cell from its Hermite tangent planes. |
| meshing.dual_contouring.sharp_qef_vertices | Place vertices with a rank-revealing QEF that lands exactly on features. |
| meshing.dual_contouring.dual_faces | Connect cell vertices with one oriented quad per crossing edge. |
Meshing — adaptive and simplify
| meshing.adaptive.surface_cells | Find every unit cell that may contain the level set, by octree descent. |
| meshing.adaptive.sparse_crossing_edges | Detect crossing edges without sampling the full lattice. |
| meshing.simplify.simplify_mesh | Simplify a dual-contour mesh by error-bounded, feature-safe collapses. |
Meshing — export and diagnostics
| meshing.export.save_obj | Write a Wavefront OBJ file with merged planar n-gon faces. |
| meshing.export.save_stl | Write the mesh triangles as an STL file. |
| meshing.export.save_step | Write a minimal faceted STEP AP214 boundary representation. |
| meshing.export.merge_planar_faces | Merge coplanar mesh quads into large polygon faces. |
| meshing.diagnostics.mesh_report | Bundle every diagnostic into one report. |
| meshing.diagnostics.surface_deviation | Sampled one-sided deviation of the mesh from the implicit surface. |
| meshing.diagnostics.triangle_quality | Triangle shape statistics: minimum angles, aspect ratios, degeneracy. |
| meshing.diagnostics.self_intersections | Sampled self-intersection test over non-adjacent triangle pairs. |
Gmsh tet10
| fem.gmsh.gmsh_available | Whether the optional gmsh wheel is importable. |
| fem.gmsh.gmsh_version | The installed Gmsh version string. |
| fem.gmsh.dc_surface_stl | Dual-contour sdf on grid and return its surface as STL text. |
| fem.gmsh.gmsh_tet_mesh | Mesh a geometry with Gmsh and give every node its owners. |
| fem.gmsh.sdf_gmsh_tet_mesh | The whole public route: dual-contour scene on grid, mesh it with Gmsh. |
| fem.gmsh.tet_mesh_from_gmsh | Wrap a :class:GmshMesh as the FEM layer’s :class:GmshTetMesh — static. |
| fem.gmsh.assign_ownership | Tag every node with the patches that own it, by residual alone. |
| fem.gmsh.owned_nodes | The :class:~cadjoint.plugins.OwnedNodes record of a topology. |
| fem.gmsh.patch_table | The scene’s public patch fields, world frame, flattened in table order. |
| fem.gmsh.GmshMesh | A Gmsh tet mesh with every node owned — a static record. |
Extension kinds and availability
| tier.status | Per kind: filled by whom, at what version, and whether it is usable. |
| tier.available | Whether kind is filled and usable in this process. |
| tier.require | The plugin filling kind, or :class:TierUnavailable. |
| tier.component | The imported object filling kind, or default when it is absent. |
| tier.message | The refusal text for kind — the one wording the app and library use. |
| tier.report | Versions and tier status, JSON-ready — what a public bug report carries. |
| tier.absent | Run a block with the private kinds unregistered process-wide. |
| tier.TierUnavailable | A private-tier kind was needed and is not filled (or not compatible). |
| plugins.contracts.NodeMap | node_map: design parameters to the node positions of a Gmsh mesh. |
| plugins.contracts.FeatureEdges | feature_edges: the exact feature curves of a scene, to draw. |
| plugins.contracts.BRepExtractor | brep: the derived boundary representation, kept in-process. |
| plugins.contracts.StepExporter | step_export: analytic STEP from the derived B-rep. |
| plugins.contracts.Drag | drag: move a B-rep handle by solving for the design that fits. |
| plugins.contracts.OwnedNodes | Every node of a Gmsh mesh, with the patches that own it — the seam’s record. |
| plugins.contracts.EdgeSet | The feature curves of a scene, as polylines ready to draw. |
| plugins.contracts.DragOutcome | What a drag did, and why — the drag kind’s result. |
Option sets
| enums.MeshMethod | How a SimMesh turns an SDF into elements. |
| enums.StudyKind | The physics a declared study solves. |
| enums.BoundaryConditionType | The boundary conditions a study accepts, as the wire spells them. |
| enums.Side | An axis-extreme face of a mesh, for Nodes.side. |
| enums.ObjectiveMetric | What a study-form optimization minimizes about the solved field. |
| enums.OptimizerMethod | The optimizer an Optimization descends with. |
| enums.OptimizationArgument | The optimization keywords the viewer may retune. |
| enums.GradientPath | How a study-form optimization carries the design->points derivative. |
| enums.ConstraintKind | The sketch constraints the viewer can add. |
| enums.ConstraintSolveMethod | How a sketch’s constraints are satisfied. |
| enums.FemBackend | The FEM backends cadjoint registers itself. |
| enums.PluginKind | The component slots cadjoint’s own pipeline resolves by kind. |
| enums.PluginTransport | Where a plugin’s component actually runs. |
| enums.values | The option set’s members as plain strings, in declaration order. |
| enums.listed | The option set’s members joined for an error message. |
| enums.either | The option set as a prose alternative, in declaration order. |
| enums.parse | Normalise one option value, raising message when it is not a member. |
Simulation — meshes and studies
| fem.simmesh.SimMesh | A declarable, named meshing intent — the scene program’s mesh object. |
| fem.hexmesh.HexMesh | A HEX8 volume mesh extracted from an SDF. |
| fem.hexmesh.sdf_to_hex_mesh | Extract a HEX8 volume mesh from an SDF on a regular grid. |
| fem.tetmesh.TetMesh | A TET4/TET10 volume mesh whose boundary vertices are DC surface vertices. |
| fem.tetmesh.sdf_to_tet_mesh | Extract the DC surface of sdf on grid and tet-mesh its inside. |
| fem.study.ThermalStudy | Declarative steady-state heat conduction study. |
| fem.study.ElasticStudy | Declarative small-strain linear elasticity study. |
| fem.result.SimulationResult | One solved study: named, typed, inspectable, exportable. |
Studies — the physics-agnostic layer
| studies.selection.Nodes | Factory namespace for :class:NodeSelection values. |
| studies.selection.NodeSelection | A composable, mesh-independent description of a region of space. |
| studies.selection.selection_from_description | Rebuild a :class:NodeSelection from its :meth:~NodeSelection.describe payload. |
| studies.capture.capture_studies | Collect every study constructed inside this context. |
| studies.capture.declared_studies | The studies declared so far in the active capture context. |
| studies.capture.register_study | Add a study to the active :func:capture_studies context, if any. |
Simulation — boundary conditions
| fem.study.Dirichlet | Prescribed temperature on a set of boundary nodes. |
| fem.study.HeatFlux | Prescribed heat inflow per area on the faces spanned by a selection. |
| fem.study.Fixed | Fully clamped node set (all displacement components zero). |
| fem.study.Traction | Constant traction (force per area) on the faces spanned by a selection. |
Simulation — material properties
| fem.properties.sample_cell_property | Sample one physical property per element, validated. |
| fem.properties.maybe_sample_cell_property | Sample a property per element, or return None when the scene lacks it. |
| fem.properties.sample_material_field | Sample the whole material field at every element centroid. |
| fem.properties.cell_centroids | Element centroids, (C, 3), differentiable in points. |
| fem.properties.cell_volumes | Element volumes, (C,), differentiable in points. |
| fem.properties.total_mass | Mass of the meshed domain, sum(rho_e * V_e). |
| fem.properties.quantize_to_materials | Snap a per-element property field onto a finite set of named materials. |
Simulation — backends
| fem.backends.SolverBackend | Protocol every FEM backend implements. |
| fem.backends.get_backend | Resolve a backend name (or pass an instance through). |
| fem.backends.register_backend | Register a solver backend factory under name. |
| fem.backends.available_backends | Names of registered backends (not necessarily importable). |
Optimization
| optimize.Optimization | Declarative gradient-based optimization of a scene’s free parameters. |
| optimize.OptimizationRun | One finished optimization: its descent history and both endpoints. |
| optimize.capture_optimizations | Collect every optimization constructed inside this context. |
Plugins
| plugins.plugin.Plugin | The interface every cadjoint plugin satisfies. |
| plugins.plugin.TesseractPlugin | A cadjoint kind, filled by a Tesseract over one of the transports. |
| plugins.plugin.Capabilities | What a plugin can do, read off what it declares. |
| plugins.plugin.PluginProbe | A readiness report for one plugin instance. |
| plugins.plugin.PluginMismatch | The running component is not the one the configuration expected. |
| plugins.spec.PluginSpec | Which Tesseract.from_* call stands behind one plugin name. |
| plugins.spec.runtime_scratch | One scratch directory for this process, removed when it exits. |
| plugins.registry.PluginRegistry | The plugins this process knows about, and the instances it has open. |
| plugins.registry.plugin_for_kind | The plugin currently filling kind in the process-wide registry. |
| plugins.registry.get_plugin | The plugin registered under name in the process-wide registry. |
| plugins.registry.register_plugin | Register spec in the process-wide registry. |
| plugins.registry.available_plugins | Names registered in the process-wide registry. |
| plugins.registry.build_registry | Assemble a registry from built-ins, entry points and the config file. |
| plugins.registry.load_config | Load the plugins config in effect. |
Flow solver (prototype)
| flow.domain.FlowGrid | A fixed axis-aligned lattice of cell centres in world coordinates. |
| flow.domain.sample_solid_fraction | Evaluate a scene SDF on the grid and squash it to a solid fraction. |
| flow.domain.solid_fraction | Smooth solid indicator from signed distances. |
| flow.solver.FlowConfig | Static settings for one flow problem. |
| flow.solver.FlowResult | The converged flow and the scalars read off it. |
| flow.solver.solve | Converge the penalised flow and read off both objectives. |
| flow.solver.convergence | Run the march without early exit and return its residual history. |
| flow.solver.recommended_alpha_max | A drag strong enough that the solid reads as impermeable. |
| flow.steady.SteadyOptions | Convergence settings for the forward iteration and the adjoint solve. |
| flow.steady.steady_populations | The converged populations, differentiated through the fixed point. |
| flow.objectives.pressure_drop | Mean pressure across the inlet plane minus across the outlet plane. |
| flow.objectives.heat_transfer_proxy | int chi \|u\| – air in motion where the metal is. |
Materials
| render.material.Material | Material properties for physically-inspired shading and simulation. |
| materials.aluminium_6061 | Aluminium alloy 6061-T6 — the default structural/heatsink aluminium. |
| materials.copper_c11000 | Copper C11000 (electrolytic tough pitch), annealed — heat spreaders. |
| materials.steel_1018 | AISI 1018 mild carbon steel, cold drawn — general structural steel. |
| materials.titanium_ti6al4v | Ti-6Al-4V (Grade 5), annealed — the standard aerospace titanium. |
| materials.fr4 | FR-4 woven-glass/epoxy laminate — the standard PCB substrate. |
| materials.silicon | Single-crystal silicon, intrinsic, at 300 K — dies and MEMS. |
| materials.thermal_pad | A filled-silicone thermal interface pad (gap filler). |
| materials.pla | PLA (polylactic acid) — the default FDM printing plastic. |
| materials.catalogue | Every catalogue material, freshly constructed. |
| sdf.measure.volume.volume | Estimate the volume of an SDF as a differentiable JAX scalar. |
| sdf.measure.mass.material_mass | Estimate the mass of an SDF from its material field, as a JAX scalar. |
Render
| render.scene.Camera | Perspective camera used by :func:cadjoint.render.render_scene. |
| render.scene.Scene | Geometry, camera, lighting, and background for one forward render. |
| render.settings.RenderSettings | Quality and performance controls for the forward renderer. |
| render.raymarch.render.render_scene | Render a :class:Scene with an explicit quality preset or settings. |
| render.raymarch.render.raymarch | Render an SDF to an (height, width, 3) NumPy image. |
| render.raymarch.render.render_raymarched | Render an SDF with :func:raymarch and display it with matplotlib. |
Viewer — payload schema
| viewer.schema.payloads.CompilePayload | What mode="compile" answers with when the program ran. |
| viewer.schema.payloads.ConstructionNode | One construction object from the executed program. |
| viewer.schema.payloads.ConstructionFace | One analytic face of a feature — a reference, not stored geometry. |
| viewer.schema.payloads.MaterialDefinition | A named Python Material definition shown in the material browser. |
| viewer.schema.payloads.SimMeshPayload | One SimMesh declared in the scene program. |
| viewer.schema.payloads.StudyPayload | One study declared in the scene program. |
| viewer.schema.payloads.OptimizationPayload | One Optimization(...) declared in the scene program. |
| viewer.schema.payloads.MeshEdgePayload | World-space line segments of the extracted dual-contour mesh. |
| viewer.schema.requests.validate_patch_request | Parse one request against the model for its op. |
| viewer.schema.emit.typescript_source | The whole generated module, ready to write to :data:TYPESCRIPT_PATH. |