The main GCMotion namespace#

The main GCMotion namespace offers the creation of entities, such as a tokamak Profile, a Particle or a Collection of Particles, as well as tokamak configuration objects, such as a QFactor, MagneticField and ElectricField:

Constructing Quantities#

All variables that represent physical quantities (except from angles) are defind as Quantities, using the pint libary. See how you can define them here:

Tokamak Configuration#

A Tokamak entity, apart from its major and minor radii, requires a q-factor, a magnetic and an electric field to be defined:

gcmotion.qfactor

Creates a q-factor

gcmotion.bfield

Creates a Magnetic field

gcmotion.efield

Creates an Electric field

See also:

Essential Entities#

Tokamak(R, a, qfactor, bfield, efield)

Creates a tokamak device.

Profile(tokamak, species[, mu, Pzeta, E])

A Profile entity describes an unperturbed equilibrium with a given Tokamak configuration and with at least 2/3 fixed Constants of Motion.

InitialConditions(species, theta0, zeta0, ...)

Creates a set of initial conditions for a particle

Particle(tokamak, init)

Creates a specific Particle in a specific Profile and with specific InitialConditions.

Utilities#

get_size(obj)

Quantifies _get_size() result and prints it.

Scripts#