From 9bdd61bd37d0da34d333931d68faaf9bce517980 Mon Sep 17 00:00:00 2001 From: Vladislav Neverov Date: Mon, 31 Jan 2022 19:59:26 +0300 Subject: [PATCH] Fix f_profile definition in EFITEquilibrium docstring and changelog. --- CHANGELOG.md | 2 +- cherab/tools/equilibrium/efit.pyx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 684393f5..b6881a6c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ Release 1.4.0 (TBD) ------------------- New: -* Make f_profile (toroidal flux) a read-only attribute of EFITEquilibrium. (#355) +* Make f_profile (current flux) a read-only attribute of EFITEquilibrium. (#355) Release 1.3.0 (8 Dec 2021) -------------------------- diff --git a/cherab/tools/equilibrium/efit.pyx b/cherab/tools/equilibrium/efit.pyx index 8c9492e0..cb23496a 100644 --- a/cherab/tools/equilibrium/efit.pyx +++ b/cherab/tools/equilibrium/efit.pyx @@ -73,7 +73,7 @@ cdef class EFITEquilibrium: :ivar Function2D psi: The poloidal flux in the r-z plane, :math:`\psi(r,z)`. :ivar Function2D psi_normalised: The normalised poloidal flux in the r-z plane, :math:`\psi_n(r,z)`. - :ivar Function1D f_profile: The toroidal flux at the specified normalised poloidal flux, :math:`F(\psi_n)`. + :ivar Function1D f_profile: The current flux at the specified normalised poloidal flux, :math:`F(\psi_n)`. :ivar Function1D q: The safety factor :math:`q` at the specified normalised poloidal flux, :math:`q(\psi_n)`. :ivar VectorFunction2D b_field: A 2D function that returns the magnetic field vector at the specified point in the r-z plane, :math:`B(r, z)`.