Miscellaneous
Useful helpers
ForwardDiff.value — Function
value(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 — Function
Grid=ExtendableGrids.simplexgridRe-Export of ExtendableGrids.simplexgrid
VoronoiFVM.cartesian! — Method
cartesian!(grid)
Set coordinate system in grid to cartesian.
VoronoiFVM.circular_symmetric! — Method
circular_symmetric!(grid)
Set coordinate system in grid to circular/cylindrical symmetry.
VoronoiFVM.coordinates — Method
VoronoiFVM.spherical_symmetric! — Method
spherical_symmetric!(grid)
Set coordinate system in grid to spherical symmetry.
Output (re)direction
VoronoiFVM.log_output! — Function
log_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! — Function
print_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 — Type
struct AssemblyError <: ExceptionException thrown if error occurred during assembly (e.g. domain error)
VoronoiFVM.ConvergenceError — Type
struct ConvergenceError <: ExceptionException thrown if Newton's method convergence fails.
VoronoiFVM.EmbeddingError — Type
struct EmbeddingError <: ExceptionException thrown if embedding fails
VoronoiFVM.LinearSolverError — Type
struct LinearSolverError <: ExceptionException thrown if error occurred during factorization.