bluemira.codes.plasmod.equilibrium_2d_coupling
==============================================

.. py:module:: bluemira.codes.plasmod.equilibrium_2d_coupling

.. autoapi-nested-parse::

   Couple PLASMOD to a 2-D asymmetric fixed boundary equilibrium solve

   NOTE: This procedure is known to be sensitive to inputs, exercise
   caution.



Functions
---------

.. autoapisummary::

   bluemira.codes.plasmod.equilibrium_2d_coupling.solve_transport_fixed_boundary


Module Contents
---------------

.. py:function:: solve_transport_fixed_boundary(parameterisation: bluemira.geometry.parameterisations.GeometryParameterisation, transport_solver: bluemira.codes.typing.TransportSolver, gs_solver: bluemira.equilibria.fem_fixed_boundary.fem_magnetostatic_2D.FemGradShafranovFixedBoundary, kappa95_t: float, delta95_t: float, lcar_mesh: float = 0.15, maxiter: int = 30, iter_err_max: float = 1e-05, max_inner_iter: int = 20, inner_iter_err_max: float = 0.0001, relaxation: float = 0.2, transport_run_mode: str | bluemira.codes.interface.BaseRunMode = 'run', mesh_filename: str = 'FixedBoundaryEquilibriumMesh', *, plot: bool = False, debug: bool = False, gif: bool = False, refine: bool = False, num_levels: int = 2, distance: float = 1.0, ny_fs_min: int = 40, directory: str = '') -> bluemira.equilibria.fem_fixed_boundary.fem_magnetostatic_2D.FixedBoundaryEquilibrium

   Solve the plasma fixed boundary problem using delta95 and kappa95 as target
   values and iterating on a transport solver to have consistency with pprime
   and ffprime.

   :param parameterisation: Geometry parameterisation class for the plasma
   :param transport_solver: Transport Solver to call
   :param gs_solver: Grad-Shafranov Solver instance
   :param kappa95_t: Target value for kappa at 95%
   :param delta95_t: Target value for delta at 95%
   :param lcar_mesh: Value of the characteristic length used to generate the mesh to solve the
                     Grad-Shafranov problem
   :param maxiter: Maximum number of iteration between Grad-Shafranov and the transport solver
   :param iter_err_max: Convergence maximum error to stop the iteration
   :param max_inner_iter: Maximum number of inner iterations on the flux functions
   :param inner_iter_err_max: Inner convergence error on when iterating flux functions
   :param relaxation: Iteration relaxing factor
   :param transport_run_mode: Run mode for transport solver
   :param mesh_filename: filename for mesh output file
   :param plot: Whether or not to plot
   :param refine: Whether or not the mesh should be refined around the magnetic axis
   :param num_levels: Number of refinement levels
   :param distance: Maximum distance from the magnetic axis to which the refinement will be applied
   :param ny_fs_min: Minimum number of points in a flux surface extracted from the mesh.

   :returns: **equilibrium** -- Final fixed boundary equilibrium result from the transport <-> fixed boundary
             equilibrium solve
   :rtype: FixedBoundaryEquilibrium