Skip to content

API_REFERENCE.md

Latest commit

 

History

History
52 lines (36 loc) · 1.9 KB

API_REFERENCE.md

File metadata and controls

52 lines (36 loc) · 1.9 KB
Raw

Core API Reference

Thermal model

FourierThermalTransport(grid_shape, element_size_m, material, boundary, conductivity_W_mK) creates the Cartesian model.

  • set_power_map(map, units="W/cell" | "W/m2" | "W/m3", z_index=0)
  • solve() / solve_steady() -> SteadyStateResult
  • step(power_map_W) for explicit transient compatibility

SteadyStateResult contains temperature_K, converged, residual, residual_W, method, mesh_shape, cell_size_m, total_power_W, boundary_heat_W, energy_balance_error_W, assumptions, warnings, and model_version.

Boundaries

FaceBoundaryCondition(mode, T_K, h_W_m2K, heat_flux_W_m2) supports adiabatic, dirichlet, robin, and flux.

ThermalBoundaryCondition(faces={...}) assigns individual faces. Omitted faces are adiabatic. ThermalBoundaryCondition.package_cooled(...) is the common one-face package configuration.

Package

PackageStack provides total_resistance, external_resistance, effective_external_h, resistance_breakdown, layer_temperatures, and junction_temperature. Use external_resistance when the die itself is already meshed.

Inverse design

ThermalDesignProblem accepts a model factory, fixed spatial power pattern, bounded DesignVariable objects, and ThermalConstraint objects.

  • maximum_allowable_power(problem) -> DesignSolution
  • pareto_explore(problem) -> non-dominated solutions

Every evaluation calls the model's steady solver.

Uncertainty

  • local_sensitivity(evaluator, parameters)
  • propagate_uncertainty(evaluator, parameters, samples, seed)

Raw floating-point public inputs use SI units and unit-bearing names where new APIs are concerned. ThermalOptimizer, TechnologyRoadmap, DesignSpace, the dashboard, and gate-energy projections are compatibility/experimental surfaces, not alternative flagship equations or reviewed engineering workflows. See docs/COMPATIBILITY_SURFACES.md.