:orphan:

.. This file is auto-generated. To update the content, edit the OptionsFactory constructors in the hypnotoad source code. To change the formatting, edit the ``create_options_rst()`` function in ``conf.py``.

Circular options
================

.. table::
   :widths: 20 75 5

   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   |                             Option                             |                                   Description                                    |       Default        |
   +================================================================+==================================================================================+======================+
   | B0                                                             | Toroidal magnetic field at the magnetic axis                                     | 1.0                  |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | N_norm_prefactor                                               | Prefactor that multiplys ny_total to give the normalization factor for the total | 1.0                  |
   |                                                                | number of points in contours. The normalisation factor is used to scale the grid |                      |
   |                                                                | spacing with the total number of points, which keeps the spacing functions       |                      |
   |                                                                | consistent when the resolution is changed                                        |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | R0                                                             | Major radius of the magnetic axis                                                | 1.0                  |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | finecontour_Nfine                                              | Number of points on each FineContour. Increase for more accurate interpolation   | 100                  |
   |                                                                | or distance calculations                                                         |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | finecontour_atol                                               | Absolute tolerance for refinement of FineContours                                | 1e-12                |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | finecontour_diagnose                                           | Print and display some information to help diagnose failures in FineContour      | False                |
   |                                                                | refinement and adjustment                                                        |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | finecontour_extend_prefactor                                   | Prefactor to increase estimate for number of points to extend FineContour when   | 2.0                  |
   |                                                                | y_boundary_guards>0. May be useful to decrease in case of FineContour creation   |                      |
   |                                                                | failures if the target end is very close to a region with problematic psi (e.g.  |                      |
   |                                                                | coils, centre column). If the value is too small, may result in extrapolation    |                      |
   |                                                                | using FineContour points which is likely to be poorly constrained.               |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | finecontour_maxits                                             | Maximum number of iterations for refinement and adjustment of a FineContour      | 200                  |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | finecontour_overdamping_factor                                 | Damping factor 0<f<=1 used to stabilise iterations in                            | 0.8                  |
   |                                                                | FineContour.equaliseSpacing. Values towards 0 are most stable but make the       |                      |
   |                                                                | smallest updates. Values towards 1 are less stable but potentially faster.       |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | limiter                                                        | Core only, no limiter (False, default) or SOL only, with a limiter (True)        | False                |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | nx                                                             | Number of radial points (including boundary points)                              | 6                    |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | ny                                                             | Number of poloidal points (excluding boundary points)                            | 8                    |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | orthogonal                                                     | Is grid orthogonal?                                                              | True                 |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | poloidal_spacing_delta_psi                                     | Small increment in psi used to find vector along grad(psi) at end of separatrix  | None                 |
   |                                                                | segment. Use None for an automatically selected increment.                       |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | poloidal_spacing_method                                        | Method to use for poloidal spacing function: 'sqrt' for                          | sqrt                 |
   |                                                                | getSqrtPoloidalSpacingFunction; 'monotonic' for                                  |                      |
   |                                                                | getMonotonicPoloidalDistanceFunc; 'linear' for getLinearPoloidalDistanceFunc     |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | poloidalfunction_diagnose                                      | Print and plot extra information to diagnose when a poloidal spacing function    | False                |
   |                                                                | has an error                                                                     |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | psi_interpolation_method                                       | Method to use for interpolating psi from the eqdsk file. Possible values are:    | spline               |
   |                                                                | 'spline' for scipy.interpolate.RectBivariateSpline;'dct' for a discrete cosine   |                      |
   |                                                                | transform.                                                                       |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | psi_spacing_separatrix_multiplier                              | Factor modifying radial spacing at separatrics: <1 to make points closer, >1 to  | 1.0                  |
   |                                                                | make points further apart                                                        |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | q_coefficients                                                 | Coefficients determining the safety factor q. Value is a float (treated as a     | [3.456789012345679]  |
   |                                                                | length-0 sequence) or a sequence of floats. The values a[i] are used as the      |                      |
   |                                                                | coefficients of a polynomial series q(r) = a[0] + a[1]*r**2 + a[2]*r**4 + ...    |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | r_inner                                                        | Minor radius of the inner edge of the grid.                                      | 0.1                  |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | r_outer                                                        | Minor radius of the outer edge of the grid.                                      | 0.3                  |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | refine_atol                                                    | Absolute tolerance for refinement of points                                      | 2e-08                |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | refine_methods                                                 | Ordered list of methods to try when refining points. Valid names are: 'newton' - | ['integrate+newton', |
   |                                                                | Newton iteration; 'line' - a line search; 'integrate' integrate along psi        | 'integrate']         |
   |                                                                | gradient; 'integrate+newton' integrate, then refine with Newton; 'none' - no     |                      |
   |                                                                | refinement (always succeeds)                                                     |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | refine_timeout                                                 | Timeout for refining FineContour objects in seconds. Set to None to disable the  | 10.0                 |
   |                                                                | timeout; can be useful for debugging as exceptions may get lost due to a         |                      |
   |                                                                | separate thread being used to run the refine() method with a timeout. If you get |                      |
   |                                                                | func_timeout.exceptions.FunctionTimedOut exceptions and you are sure there is no |                      |
   |                                                                | problem with the grid, you could try increasing this value.                      |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | refine_width                                                   | Width for line search when refining points                                       | 1e-05                |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | sfunc_checktol                                                 | Tolerance to check for small negative values that are not significantly          | 1e-13                |
   |                                                                | different from zero in poloidal spacing functions                                |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | target_all_poloidal_spacing_length                             | Spacing at the wall end of a region (used for orthogonal grids). Use None to not | None                 |
   |                                                                | constrain the spacing.                                                           |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | target_inner_lower_poloidal_spacing_length                     | Spacing at the wall end of the inner, lower divertor leg region (used for        | None                 |
   |                                                                | orthogonal grids). Use None to not constrain the spacing.                        |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | target_inner_upper_poloidal_spacing_length                     | Spacing at the wall end of the inner, upper divertor leg region (used for        | None                 |
   |                                                                | orthogonal grids). Use None to not constrain the spacing. Note an upper single   |                      |
   |                                                                | null equilibrium will not use this setting, but rather                           |                      |
   |                                                                | target_inner_lower_poloidal_spacing_length, for reasons of implementation        |                      |
   |                                                                | convenience.                                                                     |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | target_outer_lower_poloidal_spacing_length                     | Spacing at the wall end of the outer, lower divertor leg region (used for        | None                 |
   |                                                                | orthogonal grids). Use None to not constrain the spacing.                        |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | target_outer_upper_poloidal_spacing_length                     | Spacing at the wall end of the outer, upper lower divertor leg region (used for  | None                 |
   |                                                                | orthogonal grids). Use None to not constrain the spacing. Note an upper single   |                      |
   |                                                                | null equilibrium will not use this setting, but rather                           |                      |
   |                                                                | target_outer_lower_poloidal_spacing_length, for reasons of implementation        |                      |
   |                                                                | convenience.                                                                     |                      |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | xpoint_poloidal_spacing_length                                 | Spacing at the X-point end of a region (used for orthogonal grids).              | 0.05                 |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+
   | y_boundary_guards                                              | Number of y-boundary cells                                                       | 0                    |
   +----------------------------------------------------------------+----------------------------------------------------------------------------------+----------------------+