Structure to bundle options for redistancing. More...
Structure to bundle options for redistancing.
For the redistancing, we can choose some options. These options will then be passed bundled as a structure to the redistancing function. Setting these options is optional, since they all have a Default value as well.
min_iter | Minimum number of iterations before steady state in narrow band will be checked (Default: 1e5). |
max_iter | Maximum number of iterations you want to run the redistancing, even if steady state might not yet have been reached (Default: 1e12). |
order_space_op | Order of accuracy of the upwind gradient computation when solving the eikonal equation during the redistancing. Options are: {1, 3, 5} (Default: 5). |
convTolChange.value | Convolution tolerance for the normalized total change of Phi in the narrow band between two consecutive iterations (Default: 1e-15). |
convTolChange.check | Set true, if you want to use the normalized total change between two iterations as measure of how close you are to the steady state solution. Redistancing will then stop if convTolChange.value is reached or if the current iteration is bigger than max_iter. |
convTolResidual.value | Convolution tolerance for the residual, that is abs(magnitude gradient of phi - 1) of Phi in the narrow band (Default 1e-3). |
convTolResidual.check | Set true, if you want to use the residual of the current iteration as measure of how close you are to the steady state solution. Redistancing will then stop if convTolResidual.value is reached or if the current iteration is bigger than max_iter. |
interval_check_convergence | Interval of number of iterations at which convergence to steady state is checked (Default: 100). |
width_NB_in_grid_points | Width of narrow band in number of grid points. Convergence is checked for this area around the interface only, so don't choose too small! (Default: 8). |
print_current_iterChangeResidual | If true, the number of the current iteration, the corresponding change w.r.t the previous iteration and the residual is printed (Default: false). |
print_steadyState_iter | If true, the number of the steady-state-iteration, the corresponding change w.r.t the previous iteration and the residual is printed (Default: false). |
save_temp_grid | If true, save the temporary grid as hdf5 that can be reloaded onto a grid |
Definition at line 117 of file RedistancingSussman.hpp.
#include <RedistancingSussman.hpp>
Data Fields | |
size_t | min_iter = 1e3 |
size_t | max_iter = 1e6 |
Conv_tol_change< phi_type > | convTolChange |
Conv_tol_residual< phi_type > | convTolResidual |
size_t | interval_check_convergence = 100 |
size_t | width_NB_in_grid_points = 2 |
bool | print_current_iterChangeResidual = false |
bool | print_steadyState_iter = true |
bool | save_temp_grid = false |
Conv_tol_change<phi_type> Redist_options< phi_type >::convTolChange |
Definition at line 122 of file RedistancingSussman.hpp.
Conv_tol_residual<phi_type> Redist_options< phi_type >::convTolResidual |
Definition at line 123 of file RedistancingSussman.hpp.
size_t Redist_options< phi_type >::interval_check_convergence = 100 |
Definition at line 125 of file RedistancingSussman.hpp.
size_t Redist_options< phi_type >::max_iter = 1e6 |
Definition at line 120 of file RedistancingSussman.hpp.
size_t Redist_options< phi_type >::min_iter = 1e3 |
Definition at line 119 of file RedistancingSussman.hpp.
bool Redist_options< phi_type >::print_current_iterChangeResidual = false |
Definition at line 127 of file RedistancingSussman.hpp.
bool Redist_options< phi_type >::print_steadyState_iter = true |
Definition at line 128 of file RedistancingSussman.hpp.
bool Redist_options< phi_type >::save_temp_grid = false |
Definition at line 129 of file RedistancingSussman.hpp.
size_t Redist_options< phi_type >::width_NB_in_grid_points = 2 |
Definition at line 126 of file RedistancingSussman.hpp.