Miscellaneous
Useful helpers
ForwardDiff.value
— Functionvalue(x)
Return the value of a dual number (for debugging in callback functions). Re-exported from ForwardDiff.
Form factor calculatione
Additional grid methods
VoronoiFVM.Grid
— FunctionGrid=ExtendableGrids.simplexgrid
Re-Export of ExtendableGrids.simplexgrid
Deprecated as of v1.20
VoronoiFVM.cartesian!
— Methodcartesian!(grid)
Set coordinate system in grid to cartesian.
VoronoiFVM.circular_symmetric!
— Methodcircular_symmetric!(grid)
Set coordinate system in grid to circular/cylindrical symmetry.
VoronoiFVM.coordinates
— Methodcoordinates(grid::ExtendableGrid)
Return coordinate array of grid.
Deprecated as of v1.20
VoronoiFVM.spherical_symmetric!
— Methodspherical_symmetric!(grid)
Set coordinate system in grid to spherical symmetry.
Output (re)direction
VoronoiFVM.log_output!
— Functionlog_output!()
Write all subsequent output of the VoronoiFVM package to screen via Julia's logging methods (using @info or @warn).
This behavior can be changed via print_output!
.
For fine-tuning solver output, see the verbose
flag in SolverControl
.
VoronoiFVM.print_output!
— Functionprint_output!()
Write all subsequent output of the VoronoiFVM package to screen via println().
This is the default.
If enabled in Pluto notebooks, the output is directed to the terminal widget below a pluto cell. Warnings in addition are sent via logging in order to not miss them.
This behavior can be changed via log_output!
.
For fine-tuning solver output, see the verbose
flag in SolverControl
.
Exception types
VoronoiFVM.AssemblyError
— Typestruct AssemblyError <: Exception
Exception thrown if error occurred during assembly (e.g. domain error)
VoronoiFVM.ConvergenceError
— Typestruct ConvergenceError <: Exception
Exception thrown if Newton's method convergence fails.
VoronoiFVM.EmbeddingError
— Typestruct EmbeddingError <: Exception
Exception thrown if embedding fails
VoronoiFVM.LinearSolverError
— Typestruct LinearSolverError <: Exception
Exception thrown if error occurred during factorization.