evoxels
Contents:
evoxels
How to use the VoxelFields class
How to run solvers
Microstructure simulation chain
Rapid prototyping for custom ODE classes
Differentiable numerical simulations
Appendix: Code testing and verification with Manufactured Solutions
API Reference
Contributing
Authors
evoxels
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
_
__init__() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
(evoxels.function_approximators.ChemicalPotentialLegendrePolynomials method)
(evoxels.function_approximators.DiffusionLegendrePolynomials method)
(evoxels.function_approximators.ExpLegendrePolynomials method)
(evoxels.function_approximators.LegendrePolynomialRecurrence method)
(evoxels.inversion.InversionModel method)
(evoxels.InversionModel method)
(evoxels.problem_definition.CahnHilliard method)
(evoxels.problem_definition.CoupledReactionDiffusion method)
(evoxels.problem_definition.MultiPhaseAllenCahn method)
(evoxels.problem_definition.ReactionDiffusion method)
(evoxels.problem_definition.ReactionDiffusionSBM method)
(evoxels.problem_definition.TwoPhaseAllenCahn method)
(evoxels.profiler.JAXMemoryProfiler method)
(evoxels.profiler.MemoryProfiler method)
(evoxels.profiler.TorchMemoryProfiler method)
(evoxels.solvers.BaseSolver method)
(evoxels.solvers.MultiPhaseSolver method)
(evoxels.solvers.SteadyStatePseudoTimeSolver method)
(evoxels.solvers.TimeDependentSolver method)
(evoxels.timesteppers.ExponentialEuler method)
(evoxels.timesteppers.ForwardEuler method)
(evoxels.timesteppers.PseudoSpectralIMEX method)
(evoxels.timesteppers.RKC1 method)
(evoxels.timesteppers.RKC2 method)
(evoxels.timesteppers.RungeKutta4 method)
(evoxels.VoxelFields method)
(evoxels.voxelgrid.Grid method)
(evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
A
A (evoxels.problem_definition.CahnHilliard attribute)
(evoxels.problem_definition.ReactionDiffusion attribute)
add_field() (evoxels.VoxelFields method)
arange() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
argmax() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
average() (evoxels.VoxelFields method)
(evoxels.voxelgrid.VoxelGrid method)
axes() (evoxels.VoxelFields method)
(evoxels.voxelgrid.VoxelGrid method)
B
backend (evoxels.inversion.InversionModel attribute)
(evoxels.InversionModel attribute)
(evoxels.solvers.BaseSolver attribute)
BaseSolver (class in evoxels.solvers)
bc (evoxels.problem_definition.CahnHilliard attribute)
(evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.ReactionDiffusion attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
bc_flux (evoxels.problem_definition.ReactionDiffusionSBM attribute)
bc_type (evoxels.problem_definition.ODE property)
C
CahnHilliard (class in evoxels.problem_definition)
CellCenteredBCs (class in evoxels.boundary_conditions)
check_convergence() (evoxels.solvers.SteadyStatePseudoTimeSolver method)
check_freq (evoxels.solvers.SteadyStatePseudoTimeSolver attribute)
ChemicalPotentialLegendrePolynomials (class in evoxels.function_approximators)
concatenate() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
conv_crit (evoxels.solvers.SteadyStatePseudoTimeSolver attribute)
convention (evoxels.VoxelFields attribute)
(evoxels.voxelgrid.Grid attribute)
CoupledReactionDiffusion (class in evoxels.problem_definition)
cumsum() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
curvature (evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
D
D (evoxels.problem_definition.CahnHilliard attribute)
(evoxels.problem_definition.ReactionDiffusion attribute)
D_A (evoxels.problem_definition.CoupledReactionDiffusion attribute)
D_B (evoxels.problem_definition.CoupledReactionDiffusion attribute)
damping (evoxels.timesteppers.RKC1 attribute)
(evoxels.timesteppers.RKC2 attribute)
device (evoxels.solvers.BaseSolver attribute)
DiffraxTimeStepperAdapter (class in evoxels.diffrax_adapter)
DiffusionLegendrePolynomials (class in evoxels.function_approximators)
domain_size (evoxels.VoxelFields attribute)
dt (evoxels.timesteppers.ExponentialEuler attribute)
(evoxels.timesteppers.ForwardEuler attribute)
(evoxels.timesteppers.PseudoSpectralIMEX attribute)
(evoxels.timesteppers.RKC1 attribute)
(evoxels.timesteppers.RKC2 attribute)
(evoxels.timesteppers.RungeKutta4 attribute)
E
eps (evoxels.problem_definition.CahnHilliard attribute)
(evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
evoxels
module
evoxels.boundary_conditions
module
evoxels.diffrax_adapter
module
evoxels.fd_stencils
module
evoxels.function_approximators
module
evoxels.inversion
module
evoxels.precompiled_solvers
module
evoxels.precompiled_solvers.allen_cahn
module
evoxels.precompiled_solvers.cahn_hilliard
module
evoxels.problem_definition
module
evoxels.profiler
module
evoxels.solvers
module
evoxels.timesteppers
module
evoxels.voxelgrid
module
expand_dim() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
ExpLegendrePolynomials (class in evoxels.function_approximators)
ExponentialEuler (class in evoxels.timesteppers)
export_scalar_field_to_numpy() (evoxels.voxelgrid.VoxelGrid method)
export_to_vtk() (evoxels.VoxelFields method)
F
f (evoxels.problem_definition.ReactionDiffusion attribute)
fast (evoxels.problem_definition.MultiPhaseAllenCahn attribute)
FDStencils (class in evoxels.fd_stencils)
feed (evoxels.problem_definition.CoupledReactionDiffusion attribute)
fft_axes() (evoxels.voxelgrid.VoxelGrid method)
fft_k_squared() (evoxels.voxelgrid.VoxelGrid method)
fft_mesh() (evoxels.voxelgrid.VoxelGrid method)
fftn() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
fieldnames (evoxels.solvers.BaseSolver attribute)
fields (evoxels.VoxelFields attribute)
force (evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
forward_solve() (evoxels.inversion.InversionModel method)
(evoxels.InversionModel method)
ForwardEuler (class in evoxels.timesteppers)
fourier_symbol (evoxels.problem_definition.CahnHilliard property)
(evoxels.problem_definition.CoupledReactionDiffusion property)
(evoxels.problem_definition.MultiPhaseAllenCahn property)
(evoxels.problem_definition.ReactionDiffusion property)
(evoxels.problem_definition.SemiLinearODE property)
(evoxels.problem_definition.TwoPhaseAllenCahn property)
from_labels (evoxels.solvers.MultiPhaseSolver attribute)
func() (evoxels.diffrax_adapter.DiffraxTimeStepperAdapter method)
G
gab (evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
get_cuda_memory_from_nvidia_smi() (evoxels.profiler.MemoryProfiler method)
grad_x_center() (evoxels.fd_stencils.FDStencils method)
grad_x_face() (evoxels.fd_stencils.FDStencils method)
grad_y_center() (evoxels.fd_stencils.FDStencils method)
grad_y_face() (evoxels.fd_stencils.FDStencils method)
grad_z_center() (evoxels.fd_stencils.FDStencils method)
grad_z_face() (evoxels.fd_stencils.FDStencils method)
gradient_norm_squared() (evoxels.fd_stencils.FDStencils method)
Grid (class in evoxels.voxelgrid)
grid (evoxels.VoxelFields attribute)
grid_info() (evoxels.VoxelFields method)
I
init() (evoxels.diffrax_adapter.DiffraxTimeStepperAdapter method)
init_scalar_field() (evoxels.voxelgrid.VoxelGrid method)
initialize_boundary_conditions() (evoxels.problem_definition.ODE method)
interaction (evoxels.problem_definition.CoupledReactionDiffusion attribute)
InversionModel (class in evoxels)
(class in evoxels.inversion)
irfftn() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
J
JAXMemoryProfiler (class in evoxels.profiler)
K
k_squared() (evoxels.problem_definition.SemiLinearODE method)
kill (evoxels.problem_definition.CoupledReactionDiffusion attribute)
L
laplace() (evoxels.fd_stencils.FDStencils method)
LegendrePolynomialRecurrence (class in evoxels.function_approximators)
M
M (evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
mask (evoxels.problem_definition.ReactionDiffusionSBM attribute)
(evoxels.problem_definition.SmoothedBoundaryODE property)
max_degree (evoxels.function_approximators.ChemicalPotentialLegendrePolynomials attribute)
(evoxels.function_approximators.DiffusionLegendrePolynomials attribute)
(evoxels.function_approximators.ExpLegendrePolynomials attribute)
(evoxels.function_approximators.LegendrePolynomialRecurrence attribute)
max_phases (evoxels.solvers.MultiPhaseSolver attribute)
mean() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
MemoryProfiler (class in evoxels.profiler)
meshgrid() (evoxels.VoxelFields method)
(evoxels.voxelgrid.VoxelGrid method)
module
evoxels
evoxels.boundary_conditions
evoxels.diffrax_adapter
evoxels.fd_stencils
evoxels.function_approximators
evoxels.inversion
evoxels.precompiled_solvers
evoxels.precompiled_solvers.allen_cahn
evoxels.precompiled_solvers.cahn_hilliard
evoxels.problem_definition
evoxels.profiler
evoxels.solvers
evoxels.timesteppers
evoxels.voxelgrid
mu_hom (evoxels.problem_definition.CahnHilliard attribute)
MultiPhaseAllenCahn (class in evoxels.problem_definition)
MultiPhaseSolver (class in evoxels.solvers)
N
normal_laplace() (evoxels.fd_stencils.FDStencils method)
Nx (evoxels.VoxelFields property)
Ny (evoxels.VoxelFields property)
Nz (evoxels.VoxelFields property)
O
ODE (class in evoxels.problem_definition)
order (evoxels.problem_definition.CahnHilliard property)
(evoxels.problem_definition.CoupledReactionDiffusion property)
(evoxels.problem_definition.MultiPhaseAllenCahn property)
(evoxels.problem_definition.ODE property)
(evoxels.problem_definition.ReactionDiffusion property)
(evoxels.problem_definition.TwoPhaseAllenCahn property)
(evoxels.timesteppers.ExponentialEuler property)
(evoxels.timesteppers.ForwardEuler property)
(evoxels.timesteppers.PseudoSpectralIMEX property)
(evoxels.timesteppers.RKC1 property)
(evoxels.timesteppers.RKC2 property)
(evoxels.timesteppers.RungeKutta4 property)
(evoxels.timesteppers.TimeStepper property)
order() (evoxels.diffrax_adapter.DiffraxTimeStepperAdapter method)
origin (evoxels.VoxelFields attribute)
(evoxels.voxelgrid.Grid attribute)
output_label_fieldname (evoxels.solvers.MultiPhaseSolver attribute)
P
pad_bc() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
(evoxels.problem_definition.ODE method)
pad_dirichlet_periodic() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
pad_fft_bc() (evoxels.problem_definition.SemiLinearODE method)
pad_fft_dirichlet_periodic() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
pad_fft_periodic() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
pad_fft_zero_flux_periodic() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
pad_periodic() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
pad_periodic_BC_staggered_x() (evoxels.boundary_conditions.StaggeredXBCs method)
pad_zero_flux_periodic() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
pad_zeros() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
phases_to_rgb() (evoxels.solvers.MultiPhaseSolver method)
phi1() (evoxels.timesteppers.ExponentialEuler method)
phiPade() (evoxels.timesteppers.ExponentialEuler method)
plot_field_interactive() (evoxels.VoxelFields method)
plot_slice() (evoxels.VoxelFields method)
polygrad (evoxels.timesteppers.RKC1 attribute)
(evoxels.timesteppers.RKC2 attribute)
pos_params (evoxels.inversion.InversionModel attribute)
(evoxels.InversionModel attribute)
potential (evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
precision (evoxels.VoxelFields attribute)
print_memory_stats() (evoxels.profiler.JAXMemoryProfiler method)
(evoxels.profiler.MemoryProfiler method)
(evoxels.profiler.TorchMemoryProfiler method)
problem (evoxels.timesteppers.ExponentialEuler attribute)
(evoxels.timesteppers.ForwardEuler attribute)
(evoxels.timesteppers.PseudoSpectralIMEX attribute)
(evoxels.timesteppers.RKC1 attribute)
(evoxels.timesteppers.RKC2 attribute)
(evoxels.timesteppers.RungeKutta4 attribute)
problem_cls (evoxels.inversion.InversionModel attribute)
(evoxels.InversionModel attribute)
(evoxels.solvers.BaseSolver attribute)
problem_kwargs (evoxels.inversion.InversionModel attribute)
(evoxels.InversionModel attribute)
PseudoSpectralIMEX (class in evoxels.timesteppers)
R
ReactionDiffusion (class in evoxels.problem_definition)
ReactionDiffusionSBM (class in evoxels.problem_definition)
real_of_ifftn() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
residuals() (evoxels.inversion.InversionModel method)
(evoxels.InversionModel method)
rfft_axes() (evoxels.voxelgrid.VoxelGrid method)
rfft_k_squared() (evoxels.voxelgrid.VoxelGrid method)
rfft_k_squared_nonperiodic() (evoxels.voxelgrid.VoxelGrid method)
rfftn() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
rhs() (evoxels.problem_definition.CahnHilliard method)
(evoxels.problem_definition.CoupledReactionDiffusion method)
(evoxels.problem_definition.MultiPhaseAllenCahn method)
(evoxels.problem_definition.ODE method)
(evoxels.problem_definition.ReactionDiffusion method)
(evoxels.problem_definition.ReactionDiffusionSBM method)
(evoxels.problem_definition.TwoPhaseAllenCahn method)
rhs_analytic() (evoxels.problem_definition.CahnHilliard method)
(evoxels.problem_definition.CoupledReactionDiffusion method)
(evoxels.problem_definition.MultiPhaseAllenCahn method)
(evoxels.problem_definition.ODE method)
(evoxels.problem_definition.ReactionDiffusion method)
(evoxels.problem_definition.ReactionDiffusionSBM method)
(evoxels.problem_definition.TwoPhaseAllenCahn method)
RKC1 (class in evoxels.timesteppers)
RKC2 (class in evoxels.timesteppers)
run_allen_cahn_solver() (in module evoxels)
(in module evoxels.precompiled_solvers.allen_cahn)
run_cahn_hilliard_solver() (in module evoxels)
(in module evoxels.precompiled_solvers.cahn_hilliard)
RungeKutta4 (class in evoxels.timesteppers)
S
SemiLinearODE (class in evoxels.problem_definition)
set() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
set_field() (evoxels.VoxelFields method)
set_voxel_sphere() (evoxels.VoxelFields method)
shape (evoxels.VoxelFields attribute)
(evoxels.voxelgrid.Grid attribute)
SmoothedBoundaryODE (class in evoxels.problem_definition)
solve() (evoxels.inversion.InversionModel method)
(evoxels.InversionModel method)
(evoxels.solvers.BaseSolver method)
sort() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
spacing (evoxels.VoxelFields attribute)
(evoxels.voxelgrid.Grid attribute)
squeeze() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
StaggeredXBCs (class in evoxels.boundary_conditions)
SteadyStatePseudoTimeSolver (class in evoxels.solvers)
step() (evoxels.diffrax_adapter.DiffraxTimeStepperAdapter method)
(evoxels.timesteppers.ExponentialEuler method)
(evoxels.timesteppers.PseudoSpectralIMEX method)
(evoxels.timesteppers.TimeStepper method)
step_dt() (evoxels.timesteppers.ExponentialEuler method)
(evoxels.timesteppers.ForwardEuler method)
(evoxels.timesteppers.PseudoSpectralIMEX method)
(evoxels.timesteppers.RKC1 method)
(evoxels.timesteppers.RKC2 method)
(evoxels.timesteppers.RungeKutta4 method)
(evoxels.timesteppers.TimeStepper method)
step_fn (evoxels.solvers.BaseSolver attribute)
sum() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
T
T0() (evoxels.function_approximators.LegendrePolynomialRecurrence method)
take_along_dim() (evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
TimeDependentSolver (class in evoxels.solvers)
TimeStepper (class in evoxels.timesteppers)
timestepper (evoxels.diffrax_adapter.DiffraxTimeStepperAdapter attribute)
timestepper_cls (evoxels.inversion.InversionModel attribute)
(evoxels.InversionModel attribute)
(evoxels.solvers.BaseSolver attribute)
to_backend() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
to_numpy() (evoxels.voxelgrid.VoxelGrid method)
(evoxels.voxelgrid.VoxelGridJax method)
(evoxels.voxelgrid.VoxelGridTorch method)
to_x_face() (evoxels.fd_stencils.FDStencils method)
to_y_face() (evoxels.fd_stencils.FDStencils method)
to_z_face() (evoxels.fd_stencils.FDStencils method)
TorchMemoryProfiler (class in evoxels.profiler)
train() (evoxels.inversion.InversionModel method)
(evoxels.InversionModel method)
trim_boundary_nodes() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
trim_ghost_nodes() (evoxels.boundary_conditions.CellCenteredBCs method)
(evoxels.boundary_conditions.StaggeredXBCs method)
TwoPhaseAllenCahn (class in evoxels.problem_definition)
U
update_memory_stats() (evoxels.profiler.MemoryProfiler method)
V
verify_fft_bc_config() (evoxels.problem_definition.SemiLinearODE method)
vf (evoxels.inversion.InversionModel attribute)
(evoxels.InversionModel attribute)
(evoxels.solvers.BaseSolver attribute)
vg (evoxels.problem_definition.CahnHilliard attribute)
(evoxels.problem_definition.CoupledReactionDiffusion attribute)
(evoxels.problem_definition.MultiPhaseAllenCahn attribute)
(evoxels.problem_definition.ReactionDiffusion attribute)
(evoxels.problem_definition.TwoPhaseAllenCahn attribute)
VoxelFields (class in evoxels)
VoxelGrid (class in evoxels.voxelgrid)
VoxelGridJax (class in evoxels.voxelgrid)
VoxelGridTorch (class in evoxels.voxelgrid)