ImpactX
Functions
impactx.ImpactXParticleContainer Namespace Reference

Functions

def ix_pc_plot_mpl_phasespace (self, num_bins=50, 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_plot_mpl_phasespace()

def impactx.ImpactXParticleContainer.ix_pc_plot_mpl_phasespace (   self,
  num_bins = 50,
  root_rank = 0 
)
Plot the longitudinal and transverse phase space projections with matplotlib.

Parameters
----------
self : ImpactXParticleContainer_*
    The particle container class in ImpactX
num_bins : int, default=50
    The number of bins for spatial and momentum directions per plot axis.
root_rank : int, default=0
    MPI root rank to reduce to in parallel runs.

Returns
-------
A matplotlib figure with containing the plot.
For MPI-parallel ranks, the figure is only created on the root_rank.

◆ register_ImpactXParticleContainer_extension()

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