flekspy.tp.test_particles

Classes

FLEKSTP

A class that is used to read and plot test particles. Each particle ID consists of

Module Contents

class flekspy.tp.test_particles.FLEKSTP(dirs: str | List[str], iDomain: int = 0, iSpecies: int = 0, iListStart: int = 0, iListEnd: int = -1, readAllFiles: bool = False)

Bases: object

A class that is used to read and plot test particles. Each particle ID consists of a CPU index, a particle index on each CPU, and a location index. By default, 7 real numbers saved for each step: time + position + velocity.

Parameters:

dirs (str) – the path to the test particle dataset.

Examples: >>> tp = FLEKSTP(“res/run1/PC/test_particles”, iSpecies=1) >>> pIDs = list(tp.IDs()) >>> tp.plot_trajectory(pIDs[3]) >>> tp.save_trajectory_to_csv(pIDs[5]) >>> ids, pData = tp.read_particles_at_time(6500.8, doSave=True) >>> f = tp.plot_location(pData)

it_ = 0

ix_ = 1

iy_ = 2

iz_ = 3

iu_ = 4

iv_ = 5

iw_ = 6

iBx_ = 7

iBy_ = 8

iBz_ = 9

iEx_ = 10

iEy_ = 11

iEz_ = 12

iSpecies = 0

plistfiles = []

pfiles = []

indextotime = []

plists: List[Dict[Tuple[int, int], int]] = []

IDs

filetime = []

__repr__()

getIDs()

get_index_to_time() → List

Getter method for accessing indextotime.

read_particle_list(fileName: str) → Dict[Tuple[int, int], int]

Read and return a list of the particle IDs.

_read_the_first_record(fileName: str) → List[float] | None

Get the first record stored in one file.

read_particles_at_time(time: float, doSave: bool = False) → Tuple[numpy.ndarray, numpy.ndarray]

Get the information of all the particles at a given time. If doSave, save to a CSV file with the name “particles_t***.csv”.

Note that the time tags in filetime do not include the last saved time.

Returns:

a numpy array of tuples contains the particle IDs. pData: a numpy real array with the particle weight, location and velocity.

Return type:

ids

Examples: >>> ids, pData = pt.read_particles_at_time(3700, doSave=True)

save_trajectory_to_csv(pID: Tuple[int, int], fileName: str = None, shiftTime: bool = False, scaleTime: bool = False) → None

Save the trajectory of a particle to a csv file.

Parameters:

• pID – particle ID.

• shiftTime (bool) – If set to True, set the initial time to be 0.

• scaleTime (bool) – If set to True, scale the time into [0,1] range, only scale time if shiftTime = True.

Example: >>> tp.save_trajectory_to_csv((3,15))

read_particle_trajectory(pID: Tuple[int, int])

Return the trajectory of a test particle.

Parameters:

pID – particle ID

Examples: >>> trajectory = tp.read_particle_trajectory((66,888))

read_initial_location(pID)

Return the initial location of a test particle.

select_particles(f_select: Callable = None) → List[Tuple[int, int]]

Return the test particles whose initial conditions satisfy the requirement set by the user defined function f_select. The first argument of f_select is the particle ID, and the second argument is the ID of a particle.

Examples: >>> def f_select(tp, pid): >>> pData = tp.read_initial_location(pid) >>> inTime = pData[FLEKSTP.it_] < 3601 >>> inRegion = pData[FLEKSTP.ix_] > 20 >>> return inTime and inRegion >>> >>> pselected = tp.select_particles(f_select) >>> tp.plot_trajectory(list(pselected.keys())[1])

get_data(data, name: str)

plot_trajectory(pID: Tuple[int, int], *, type='all', xaxis='t', yaxis='x', ax=None, **kwargs)

Plots the trajectory and velocities of the particle pID.

Example: >>> tp.plot_trajectory((3,15))

plot_location(pData: numpy.ndarray)

Plot the location of particles pData.

Examples: >>> ids, pData = tp.read_particles_at_time(3700, doSave=True) >>> f = tp.plot_location(pData)