amrex.ParticleContainer Namespace Reference

Functions
def	pc_to_df (self, local=True, comm=None, root_rank=0)
def	register_ParticleContainer_extension (amr)

Detailed Description

This file is part of pyAMReX

Copyright 2023 AMReX community
Authors: Axel Huebl
License: BSD-3-Clause-LBNL

Function Documentation

pc_to_df()

def amrex.ParticleContainer.pc_to_df	(		self,
			local = True,
			comm = None,
			root_rank = 0
	)

Copy all particles into a pandas.DataFrame

Parameters
----------
self : amrex.ParticleContainer_*
    A ParticleContainer class in pyAMReX
local : bool
    MPI rank-local particles only
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_ParticleContainer_extension()

def amrex.ParticleContainer.register_ParticleContainer_extension

(

amr

)

ParticleContainer helper methods