DISPATCH
particle_utils.particles Class Reference

Public Member Functions

def __init__ (self, it=0, run='', data='../data', read=0, r=0, dr=1, gas_mass=0, verbose=0)
 
def get_gas_mass (self, verbose=0)
 
def read_all (self, verbose=0)
 
def read_patch (self, file, verbose=0)
 
def read_shell (self, r=100, dr=1, dust2gas=0.01, save=True, verbose=0)
 
def read_plane (self, x=None, y=None, z=None, ds=1, wmin=1e-9, dust2gas=0.01, save=True, verbose=0)
 
def shell (self, r=100, dr=1, dust2gas=0.01, verbose=0)
 

Public Attributes

 files
 
 gas_mass
 
 particles
 
 rate
 

Detailed Description

Definition at line 25 of file particle_utils.py.

Constructor & Destructor Documentation

◆ __init__()

def particle_utils.particles.__init__ (   self,
  it = 0,
  run = '',
  data = '../data',
  read = 0,
  r = 0,
  dr = 1,
  gas_mass = 0,
  verbose = 0 
)
Initialize, by reading in the list of patch files 

Definition at line 26 of file particle_utils.py.

References particle_utils.particles.files, dispatch_data.Snapshot.files, particle_utils.particles.gas_mass, and particle_utils.particles.read_shell().

Member Function Documentation

◆ get_gas_mass()

def particle_utils.particles.get_gas_mass (   self,
  verbose = 0 
)

◆ read_all()

def particle_utils.particles.read_all (   self,
  verbose = 0 
)
Trigger reading of all patches (may take a long time) 

Definition at line 56 of file particle_utils.py.

References particle_utils.particles.read_shell().

◆ read_patch()

def particle_utils.particles.read_patch (   self,
  file,
  verbose = 0 
)
Read particles in a patch 

Definition at line 60 of file particle_utils.py.

Referenced by particle_utils.particles.read_plane().

◆ read_plane()

def particle_utils.particles.read_plane (   self,
  x = None,
  y = None,
  z = None,
  ds = 1,
  wmin = 1e-9,
  dust2gas = 0.01,
  save = True,
  verbose = 0 
)
Read particles in a plane, by default saving them 

Definition at line 146 of file particle_utils.py.

References particle_utils.particles.files, dispatch_data.Snapshot.files, particle_utils.particles.particles, and particle_utils.particles.read_patch().

◆ read_shell()

def particle_utils.particles.read_shell (   self,
  r = 100,
  dr = 1,
  dust2gas = 0.01,
  save = True,
  verbose = 0 
)

◆ shell()

def particle_utils.particles.shell (   self,
  r = 100,
  dr = 1,
  dust2gas = 0.01,
  verbose = 0 
)

The documentation for this class was generated from the following file: