FEAX API Reference
Complete API documentation for FEAX (Finite Element Analysis with JAX).
Core Modules
Problem Definition
- feax.problem - Base Problem class and problem definition
- feax.mesh - Mesh generation and handling
Finite Elements
- feax.fe - FiniteElement class definitions
- feax.basis - Shape functions and quadrature rules
Assembly & Solving
- feax.assembler - System matrix and residual assembly
- feax.solver - High-level solver creation (
create_solver) - feax.solvers - Solver infrastructure (options, linear, Newton, matrix-free, reduced)
Boundary Conditions
- feax.DCboundary - Dirichlet boundary conditions
Internal Variables
- feax.internal_vars - Material properties and parameters
Utilities
- feax.utils - Utility functions (save_sol, etc.)
Mechanics
Constitutive models for finite element simulations:
- feax.mechanics.cohesive - Cohesive zone models for fracture mechanics
Topology Optimization (gene)
Density-based topology optimization with adaptive remeshing:
- feax.gene.optimizer - Optimization driver (
run,Continuation,AdaptiveConfig) - feax.gene.adaptive - Adaptive remeshing and field transfer
- feax.gene.filters - Density filters and Heaviside projection
- feax.gene.responses - Compliance and volume functions
- feax.gene.mdmm - Constrained optimization (MDMM)
Flat Toolkit
Lattice material analysis and homogenization:
- feax.flat.graph - Graph-based density field generation
- feax.flat.pbc - Periodic boundary conditions
- feax.flat.solver - Homogenization solvers
- feax.flat.unitcell - Unit cell definitions
- feax.flat.utils - Visualization utilities
Browse All
Use the sidebar to explore all classes, functions, and modules in detail.