gcmotion.Particle

class gcmotion.Particle(tokamak: Tokamak, init: InitialConditions)

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

A particle entity represents a fully-fledged particle inside a specific tokamak device, and defined initial conditions.

Parameters:

tokamakTokamak

Tokamak object containing information about the tokamak.

initInitialConditions

InitialConditions object containing the set of initial condtions of the particle.

Methods

quantities([which, everything])	Prints the pint Quantities of the object.
run([orbit, info, events])	Calculates the particle's orbit.

Notes

To view the particle’s attributes, use its quantities() method.

Examples

Here is how a particle is created:

>>> import gcmotion as gcm
>>> import numpy as np
>>>
>>> # Quantity Constructor
>>> Rnum = 1.65
>>> anum = 0.5
>>> B0num = 1
>>> species = "p"
>>> Q = gcm.QuantityConstructor(R=Rnum, a=anum, B0=B0num, species=species)
>>>
>>> # Intermediate Quantities
>>> R = Q(Rnum, "meters")
>>> a = Q(anum, "meters")
>>> B0 = Q(B0num, "Tesla")
>>> i = Q(10, "NUPlasma_current")
>>> g = Q(1, "NUPlasma_current")
>>> Ea = Q(73500, "Volts/meter")
>>>
>>> # Construct a Tokamak
>>> tokamak = gcm.Tokamak(
...     R=R,
...     a=a,
...     qfactor=gcm.qfactor.Hypergeometric(a, B0, q0=1.1, q_wall=3.8, n=2),
...     bfield=gcm.bfield.LAR(B0=B0, i=i, g=g),
...     efield=gcm.efield.Radial(a, Ea, B0, peak=0.98, rw=1 / 50),
... )
>>>
>>> # Setup Initial Conditions
>>> init = gcm.InitialConditions(
...     species="p",
...     muB=Q(0.5, "keV"),
...     Pzeta0=Q(-0.015, "NUCanonical_momentum"),
...     theta0=0,
...     zeta0=0,
...     psi0=Q(0.6, "psi_wall"),
...     t_eval=Q(np.linspace(0, 1e-3, 1000), "seconds"),
... )
>>>
>>> # Create the particle and calculate its obrit
>>> particle = gcm.Particle(tokamak=tokamak, init=init)
>>> particle.run()

Methods

Particle.quantities([which, everything])	Prints the pint Quantities of the object.
Particle.run([orbit, info, events])	Calculates the particle's orbit.