ImpactX
Functions
impactx.ImpactXParticleContainer Namespace Reference

Functions

def ix_pc_to_df (self, local=True, comm=None, root_rank=0)
 
def register_ImpactXParticleContainer_extension (ixpc)
 

Detailed Description

This file is part of ImpactX

Copyright 2023 ImpactX contributors
Authors: Axel Huebl
License: BSD-3-Clause-LBNL

Function Documentation

◆ ix_pc_to_df()

def impactx.ImpactXParticleContainer.ix_pc_to_df (   self,
  local = True,
  comm = None,
  root_rank = 0 
)
Copy all particles into a pandas.DataFrame

Parameters
----------
self : ImpactXParticleContainer_*
    The particle container class in ImpactX
local : bool
    MPI-local particles
comm : MPI Communicator
    if local is False, this defaults to mpi4py.MPI.COMM_WORLD
root_rank : MPI root rank to gather to
    if local is False, this defaults to 0

Returns
-------
A concatenated pandas.DataFrame with particles from all levels.

Returns None if no particles were found.
If local=False, then all ranks but the root_rank will return None.

◆ register_ImpactXParticleContainer_extension()

def impactx.ImpactXParticleContainer.register_ImpactXParticleContainer_extension (   ixpc)
ImpactXParticleContainer helper methods