freegs

Contents

freegs#

FreeGS#

Free boundary Grad-Shafranov solver

License#

Copyright 2016-2021 Ben Dudson, University of York and other contributors. Email: benjamin.dudson@york.ac.uk

FreeGS is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

FreeGS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with FreeGS. If not, see <http://www.gnu.org/licenses/>.

Modules

`boundary`	Functions to impose boundary conditions on psi(plasma)
`coil`	Poloidal field coil
`control`	Plasma control system
`critical`	Routines to find critical points (O- and X-points)
`divgeo`
`dump`	Class for reading/writing freegs Equilibrium objects
`equilibrium`	Defines class to represent the equilibrium state, including plasma and coil currents
`fieldtracer`
`filament_coil`	Classes and routines to represent coils and circuits
`geqdsk`	Handles reading and writing of Equilibrium objects
`gradshafranov`	Grad-Shafranov equation
`jtor`	Classes representing plasma profiles.
`machine`	Classes and routines to represent coils and circuits
`multi_coil`	Classes and routines to represent coils and circuits
`multigrid`	Multigrid solver for elliptic problems
`optimise`	Routines for optimising equilibria These make use of the generic "optimiser" routines
`optimiser`	Differential Evolution optimisation
`picard`	Routines for solving the nonlinear part of the Grad-Shafranov equation
`plotting`	Plotting using matplotlib
`polygons`	Routines for calculating intersection or other geometric calculations with polygons (e.g. walls, flux surface approximations).
`pre_calc_coil`	Classes and routines to represent coils and circuits
`quadrature`	Quadrature rules for averaging over polygons
`shaped_coil`	Define a class of coil which contains a uniform current density over a shaped region.
`test_critical`
`test_equilibrium`
`test_filament_coil`
`test_jtor`
`test_linearsolve`	Tests of the linear solver
`test_machine`
`test_optimise`
`test_optimiser`
`test_polygons`
`test_quadrature`
`test_readwrite`
`test_sensors`
`test_shaped_coil`