Skip to main content
Ctrl+K

FreeGS 0.1.dev264+g5b41fe556 documentation

Contents:

  • Creating equilibria
  • Input and Output
  • Diagnostics
  • Tests
  • Optimisation

API reference:

  • API Reference
    • freegs
      • freegs.boundary
        • freegs.boundary.fixedBoundary
        • freegs.boundary.freeBoundary
        • freegs.boundary.freeBoundaryHagenow
      • freegs.coil
        • freegs.coil.AreaCurrentLimit
        • freegs.coil.Coil
      • freegs.control
        • freegs.control.ConstrainPsi2D
        • freegs.control.ConstrainPsi2DAdvanced
        • freegs.control.ConstrainPsiNorm2D
        • freegs.control.ConstrainPsiNorm2DAdvanced
        • freegs.control.constrain
      • freegs.critical
        • freegs.critical.core_mask
        • freegs.critical.find_critical
        • freegs.critical.find_psisurface
        • freegs.critical.find_safety
        • freegs.critical.find_separatrix
      • freegs.divgeo
        • freegs.divgeo.write
      • freegs.dump
        • freegs.dump.OutputFile
        • freegs.dump.OutputFormatNotAvailableError
      • freegs.equilibrium
        • freegs.equilibrium.coarsen
        • freegs.equilibrium.newDomain
        • freegs.equilibrium.refine
        • freegs.equilibrium.Equilibrium
      • freegs.fieldtracer
        • freegs.fieldtracer.traceFieldLines
        • freegs.fieldtracer.FieldTracer
        • freegs.fieldtracer.LineCoordinates
      • freegs.filament_coil
        • freegs.filament_coil.populate_with_fils
        • freegs.filament_coil.FilamentCoil
      • freegs.geqdsk
        • freegs.geqdsk.ceilPow2
        • freegs.geqdsk.isPow2
        • freegs.geqdsk.read
        • freegs.geqdsk.write
      • freegs.gradshafranov
        • freegs.gradshafranov.Greens
        • freegs.gradshafranov.GreensBr
        • freegs.gradshafranov.GreensBz
        • freegs.gradshafranov.GSElliptic
        • freegs.gradshafranov.GSsparse
        • freegs.gradshafranov.GSsparse4thOrder
      • freegs.jtor
        • freegs.jtor.ConstrainBetapIp
        • freegs.jtor.ConstrainPaxisIp
        • freegs.jtor.Profile
        • freegs.jtor.ProfilesPprimeFfprime
      • freegs.machine
        • freegs.machine.DIIID
        • freegs.machine.EmptyTokamak
        • freegs.machine.MAST
        • freegs.machine.MASTU
        • freegs.machine.MASTU_simple
        • freegs.machine.MAST_sym
        • freegs.machine.MirroredCoil
        • freegs.machine.TCV
        • freegs.machine.TestTokamak
        • freegs.machine.TestTokamakLimited
        • freegs.machine.TestTokamakSensor
        • freegs.machine.Circuit
        • freegs.machine.FluxLoopSensor
        • freegs.machine.Machine
        • freegs.machine.PoloidalFieldSensor
        • freegs.machine.RogowskiSensor
        • freegs.machine.Sensor
        • freegs.machine.Solenoid
        • freegs.machine.Wall
      • freegs.multi_coil
        • freegs.multi_coil.MultiCoil
      • freegs.multigrid
        • freegs.multigrid.createVcycle
        • freegs.multigrid.interpolate
        • freegs.multigrid.restrict
        • freegs.multigrid.smoothJacobi
        • freegs.multigrid.smoothMG
        • freegs.multigrid.smoothVcycle
        • freegs.multigrid.LaplaceSparse
        • freegs.multigrid.LaplacianOp
        • freegs.multigrid.MGDirect
        • freegs.multigrid.MGJacobi
      • freegs.optimise
        • freegs.optimise.max_abs_coil_current
        • freegs.optimise.max_coil_force
        • freegs.optimise.no_wall_intersection
        • freegs.optimise.optimise
        • freegs.optimise.weighted_sum
        • freegs.optimise.CoilHeight
        • freegs.optimise.CoilRadius
        • freegs.optimise.PlotMonitor
      • freegs.optimiser
        • freegs.optimiser.mutate
        • freegs.optimiser.optimise
        • freegs.optimiser.pickUnique
      • freegs.picard
        • freegs.picard.solve
      • freegs.plotting
        • freegs.plotting.plotCoils
        • freegs.plotting.plotConstraints
        • freegs.plotting.plotEquilibrium
      • freegs.polygons
        • freegs.polygons.area
        • freegs.polygons.clockwise
        • freegs.polygons.intersect
        • freegs.polygons.triangulate
      • freegs.pre_calc_coil
        • freegs.pre_calc_coil.PreCalcCoil
      • freegs.quadrature
        • freegs.quadrature.average
        • freegs.quadrature.polygon_quad
        • freegs.quadrature.triangle_quad
      • freegs.shaped_coil
        • freegs.shaped_coil.ShapedCoil
      • freegs.test_critical
        • freegs.test_critical.test_doublet
        • freegs.test_critical.test_mask_zero_psi_bndry
        • freegs.test_critical.test_one_opoint
        • freegs.test_critical.test_one_xpoint
      • freegs.test_equilibrium
        • freegs.test_equilibrium.test_check_limited_diverted_plasma
        • freegs.test_equilibrium.test_check_limited_non_square_grid
        • freegs.test_equilibrium.test_fixed_boundary_psi
        • freegs.test_equilibrium.test_fixed_boundary_psi_check_limited
        • freegs.test_equilibrium.test_inoutseparatrix
        • freegs.test_equilibrium.test_setSolverVcycle
      • freegs.test_filament_coil
        • freegs.test_filament_coil.test_mirrored
        • freegs.test_filament_coil.test_move_R
        • freegs.test_filament_coil.test_move_Z
        • freegs.test_filament_coil.test_single
        • freegs.test_filament_coil.test_two_filaments
        • freegs.test_filament_coil.test_two_turns
      • freegs.test_jtor
        • freegs.test_jtor.test_psinorm_range
      • freegs.test_linearsolve
        • freegs.test_linearsolve.test_direct_laplacian
        • freegs.test_linearsolve.test_multigrid_laplacian
      • freegs.test_machine
        • freegs.test_machine.test_coil_axis
        • freegs.test_machine.test_coil_forces
        • freegs.test_machine.test_coil_forces_unequal
      • freegs.test_optimise
        • freegs.test_optimise.test_CoilHeight
        • freegs.test_optimise.test_CoilHeightLimits
        • freegs.test_optimise.test_CoilRadius
        • freegs.test_optimise.test_CoilRadiusLimits
        • freegs.test_optimise.DummyCoil
        • freegs.test_optimise.DummyEq
      • freegs.test_optimiser
        • freegs.test_optimiser.calculate_score
        • freegs.test_optimiser.test_pick_all
        • freegs.test_optimiser.test_pick_different
        • freegs.test_optimiser.test_pick_excludes
        • freegs.test_optimiser.test_quadratic
        • freegs.test_optimiser.test_reducing
        • freegs.test_optimiser.ControlIndex
      • freegs.test_polygons
        • freegs.test_polygons.test_area
        • freegs.test_polygons.test_clockwise
        • freegs.test_polygons.test_lineintersect
        • freegs.test_polygons.test_nointersect
        • freegs.test_polygons.test_squareintersect
        • freegs.test_polygons.test_triangulate_four
        • freegs.test_polygons.test_triangulate_three
      • freegs.test_quadrature
        • freegs.test_quadrature.test_integral
        • freegs.test_quadrature.test_unity
      • freegs.test_readwrite
        • freegs.test_readwrite.test_readwrite
      • freegs.test_sensors
        • freegs.test_sensors.test_flux
        • freegs.test_sensors.test_iso_flux
        • freegs.test_sensors.test_offaxis_Bfield
        • freegs.test_sensors.test_rog_around_Filamentcoil
        • freegs.test_sensors.test_rog_around_Shapedcoil
        • freegs.test_sensors.test_rog_around_circuit
        • freegs.test_sensors.test_rog_around_coil
        • freegs.test_sensors.test_rog_with_plasma
        • freegs.test_sensors.test_xpoint_field
      • freegs.test_shaped_coil
        • freegs.test_shaped_coil.test_area
        • freegs.test_shaped_coil.test_move_R
        • freegs.test_shaped_coil.test_move_Z
  • Repository
  • Suggest edit
  • Open issue
  • .rst

Welcome to FreeGS’s documentation!

Contents

  • Indices and tables

Welcome to FreeGS’s documentation!#

Contents:

  • Creating equilibria
    • Tokamak coils, circuits and solenoid
    • Machine walls (limiters)
    • Sensors
    • Equilibrium and plasma domain
    • Boundaries
    • Plasma profiles
    • Feedback and shape control
    • Solving
  • Input and Output
    • Writing G-EQDSK files
    • Reading G-EQDSK files
    • Writing DivGeo files
  • Diagnostics
    • Safety factor, q
    • Poloidal beta
    • Plasma pressure
    • Separatrix location
    • Currents in the coils
    • Forces on the coils
    • Sensor Measurements
    • Field line connection length
  • Tests
    • Unit tests
    • Convergence test
  • Optimisation
    • Differential Evolution
    • Optimising tokamak equilibria

API reference:

  • API Reference
    • freegs

Indices and tables#

  • Index

  • Module Index

  • Search Page

next

Creating equilibria

Contents
  • Indices and tables

By Ben Dudson

© Copyright 2017-2023, FreeGS authors.