Add mirror ratio objective

[f0uriest]

Resolves #848

[codecov]

Codecov Report

Attention: Patch coverage is 94.59459% with 2 lines in your changes missing coverage. Please review.

Project coverage is 95.62%. Comparing base (afeff2c) to head (df43f17).
Report is 13 commits behind head on master.

Files with missing lines	Patch %	Lines
desc/objectives/_geometry.py	94.59%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1366      +/-   ##
==========================================
- Coverage   95.62%   95.62%   -0.01%     
==========================================
  Files          98       98              
  Lines       25374    25411      +37     
==========================================
+ Hits        24264    24299      +35     
- Misses       1110     1112       +2     

Files with missing lines	Coverage Δ
desc/compute/_field.py	100.00% <ø> (ø)
desc/objectives/__init__.py	100.00% <ø> (ø)
desc/objectives/_geometry.py	96.79% <94.59%> (-0.23%)	⬇️

... and 3 files with indirect coverage changes

[github-actions]

|             benchmark_name             |         dt(%)          |         dt(s)          |        t_new(s)        |        t_old(s)        | 
| -------------------------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
 test_build_transform_fft_lowres         |     -1.32 +/- 3.58     | -7.80e-03 +/- 2.12e-02 |  5.84e-01 +/- 1.6e-02  |  5.91e-01 +/- 1.4e-02  |
 test_equilibrium_init_medres            |     +0.31 +/- 2.19     | +1.46e-02 +/- 1.03e-01 |  4.71e+00 +/- 8.4e-02  |  4.70e+00 +/- 6.0e-02  |
 test_equilibrium_init_highres           |     -0.32 +/- 2.91     | -1.94e-02 +/- 1.74e-01 |  5.97e+00 +/- 1.4e-01  |  5.99e+00 +/- 1.0e-01  |
 test_objective_compile_dshape_current   |     +0.03 +/- 1.99     | +1.29e-03 +/- 8.43e-02 |  4.23e+00 +/- 4.4e-02  |  4.23e+00 +/- 7.2e-02  |
 test_objective_compute_dshape_current   |     -5.20 +/- 8.60     | -3.19e-04 +/- 5.27e-04 |  5.81e-03 +/- 2.3e-04  |  6.13e-03 +/- 4.7e-04  |
 test_objective_jac_dshape_current       |     +0.23 +/- 6.32     | +1.06e-04 +/- 2.89e-03 |  4.58e-02 +/- 2.0e-03  |  4.57e-02 +/- 2.1e-03  |
 test_perturb_2                          |     -0.21 +/- 1.82     | -4.50e-02 +/- 3.98e-01 |  2.18e+01 +/- 3.0e-01  |  2.18e+01 +/- 2.6e-01  |
 test_proximal_freeb_jac                 |     +0.02 +/- 1.72     | +1.82e-03 +/- 1.37e-01 |  7.94e+00 +/- 9.2e-02  |  7.94e+00 +/- 1.0e-01  |
 test_solve_fixed_iter                   |     -0.67 +/- 3.53     | -2.41e-01 +/- 1.27e+00 |  3.58e+01 +/- 8.7e-01  |  3.60e+01 +/- 9.3e-01  |
 test_LinearConstraintProjection_build   |     +0.24 +/- 2.91     | +2.70e-02 +/- 3.31e-01 |  1.14e+01 +/- 1.9e-01  |  1.14e+01 +/- 2.7e-01  |
 test_build_transform_fft_midres         |     -0.44 +/- 4.15     | -2.66e-03 +/- 2.51e-02 |  6.01e-01 +/- 1.6e-02  |  6.04e-01 +/- 1.9e-02  |
 test_build_transform_fft_highres        |     -0.29 +/- 2.92     | -2.82e-03 +/- 2.82e-02 |  9.63e-01 +/- 1.3e-02  |  9.65e-01 +/- 2.5e-02  |
 test_equilibrium_init_lowres            |     -3.04 +/- 9.03     | -1.21e-01 +/- 3.59e-01 |  3.85e+00 +/- 1.1e-01  |  3.97e+00 +/- 3.4e-01  |
 test_objective_compile_atf              |     -3.44 +/- 4.74     | -2.86e-01 +/- 3.94e-01 |  8.03e+00 +/- 2.8e-01  |  8.31e+00 +/- 2.8e-01  |
 test_objective_compute_atf              |     -3.30 +/- 4.00     | -5.39e-04 +/- 6.54e-04 |  1.58e-02 +/- 5.8e-04  |  1.63e-02 +/- 3.1e-04  |
 test_objective_jac_atf                  |     -1.09 +/- 1.26     | -2.14e-02 +/- 2.48e-02 |  1.95e+00 +/- 1.5e-02  |  1.97e+00 +/- 2.0e-02  |
 test_perturb_1                          |     -1.72 +/- 2.17     | -2.54e-01 +/- 3.20e-01 |  1.45e+01 +/- 2.4e-01  |  1.48e+01 +/- 2.1e-01  |
 test_proximal_jac_atf                   |     +0.04 +/- 1.12     | +3.15e-03 +/- 9.24e-02 |  8.23e+00 +/- 7.4e-02  |  8.22e+00 +/- 5.6e-02  |
 test_proximal_freeb_compute             |     +1.09 +/- 1.19     | +2.15e-03 +/- 2.35e-03 |  2.00e-01 +/- 1.4e-03  |  1.97e-01 +/- 1.9e-03  |
 test_solve_fixed_iter_compiled          |     +0.79 +/- 1.69     | +1.71e-01 +/- 3.65e-01 |  2.18e+01 +/- 1.5e-01  |  2.16e+01 +/- 3.3e-01  |

[ddudt]

Approving, but would like to see if you can change the test to work with a lower tolerance

[ddudt]

It might be better to use the Solovev or D-shape examples. They aren't perfectly circular but are higher-resolution equilibria, so might give a more accurate solution anyways

[YigitElma]

I guess increasing the resolution slightly can give better results without taking too much time.

[YigitElma]

I agree with @ddudt, the tolerance is a bit high, but not too important if you don't change it. I made some suggestions that should work.

[YigitElma]

I guess increasing the resolution slightly can give better results without taking too much time.

[YigitElma]

Update changelog