Skip to content

Commit

Permalink
Mark mirror ratio objective params as keyword only
Browse files Browse the repository at this point in the history
  • Loading branch information
f0uriest committed Dec 12, 2024
1 parent 455a09b commit 5be74a8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions desc/objectives/_geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -1364,14 +1364,13 @@ class MirrorRatio(_Objective):
(Bₘₐₓ - Bₘᵢₙ) / (Bₘₐₓ + Bₘᵢₙ)
Where Bₘₐₓ and Bₘᵢₙ are the maximum and minimum values of ||B|| on given surface.
Where Bₘₐₓ and Bₘᵢₙ are the maximum and minimum values of ||B|| on a given surface.
Returns one value for each surface in ``grid``.
Parameters
----------
eq : Equilibrium or OmnigenousField
Equilibrium or OmnigenousField that
will be optimized to satisfy the Objective.
Equilibrium or OmnigenousField that will be optimized to satisfy the Objective.
grid : Grid, optional
Collocation grid containing the nodes to evaluate at. Defaults to
``LinearGrid(M=eq.M_grid, N=eq.N_grid)`` for ``Equilibrium``
Expand All @@ -1391,14 +1390,15 @@ class MirrorRatio(_Objective):
def __init__(
self,
eq,
*,
grid=None,
target=None,
bounds=None,
weight=1,
normalize=True,
normalize_target=True,
loss_function=None,
deriv_mode="auto",
grid=None,
name="mirror ratio",
jac_chunk_size=None,
):
Expand Down

0 comments on commit 5be74a8

Please sign in to comment.