CRPropa 3
Propagation of ultrarelativistic particles through galactic and extragalactic space

crpropa  Base64 encodig and decoding 
AdvectionField  Abstract base class for advection fields. These are used to model the deterministic part of the FokkerPlanck equation. The getDivergence() method is used to model the adibatic cooling/heating 
AdvectionFieldList  Advection field decorator implementing a superposition of fields 
UniformAdvectionField  Advection field with one velocity/advectionfield vector 
ConstantSphericalAdvectionField  Spherical advection field with a constant wind speed 
SphericalAdvectionField  Spherical advection with a exponentially increasing and exponentially constant velocity 
SphericalAdvectionShock  Spherical advection with a constant velocity for r<r_0 at the the shock the velocity drops to v_0/4. followed by a decrease proportional to 1/r^2 
Base64  
Candidate  All information about the cosmic ray 
Clock  Provides a clock / timer 
CylindricalProjectionMap  2D histogram of spherical coordinates in equalarea projection 
EmissionMap  Particle Type and energy binned emission maps 
Surface  A geometrical surface 
Plane  A plane given by a point x0 and two axes v1 and v2 with normal n = v1.cross(v2) or the normal n. Note that distance is negative on one side of the plane and positive on the other, depending on the orientation of the normal vector 
Sphere  A sphere around point _center with radius _radius 
ParaxialBox  A box with perpendicular surfaces aligned to the x,y,zaxes 
Grid  Template class for fields on a periodic grid with trilinear interpolation 
AMRMagneticField  Wrapper for saga::MagneticField 
ArchimedeanSpiralField  Magnetic field model following a Archimedean spiral 
TorroidalHaloField  Galactic halo field model from Prouza & Smida 2003 and Sun et al. 2008 
LogarithmicSpiralField  Galactic disk field model of axisymmetric (ASS) or bisymmetric (BSS) logarithmic spiral shape 
JF12Field  JF12Field galactic magnetic field model 
JF12FieldSolenoidal  JF12FieldSolenoidal galactic magnetic field model 
MagneticField  Abstract base class for magnetic fields 
PeriodicMagneticField  Magnetic field decorator implementing periodic fields 
MagneticFieldList  Magnetic field decorator implementing a superposition of fields 
MagneticFieldEvolution  Magnetic field decorator implementing an evolution of type (1+z)^m 
UniformMagneticField  Magnetic field with one Bfield vector 
MagneticDipoleField  Magnetic dipole field defined by the magnetic moment and the 'core' radius 
RenormalizeMagneticField  Renormalize strength of a given field by expression in which B is the strength variable 
MagneticFieldGrid  Magnetic field on a periodic (or reflective), cartesian grid with trilinear interpolation 
ModulatedMagneticFieldGrid  Modulated magnetic field on a periodic grid 
PT11Field  
QuimbyMagneticField  Wrapper for quimby::MagneticField 
QuimbyMagneticFieldAdapter  Wrapper to use crpropa::MagneticField in Quimby 
LensPart  Holds one matrix for the lens and information about the rigidity range 
MagneticLens  The lens for the galactic magnetic field. Note that the energies refer to protons (Z=1). To be used with other particles with a different charge number please select the rigidity accordingly 
ParticleMapsContainer  Container for particlemaps The maps are stored with discrete energies on a logarithmic scale. The default energy width is 0.02 with an energy bin from 10**17.99  10**18.01 eV 
Pixelization  Every communication with healpix is done through this class to avoid bugs with missmatching coordinates (and make python hooks easier) 
ConstantDensity  
Cordes  Zylindrical symetrical model of the density of ionised hydrogen (HII) of the Milkyway Cordes et al., 1991, Nature 353,737 
Density  Abstract base class for targetdensity 
Ferriere  Model of the distribution of hydrogen in the Milky Way Here in model Ferriere 2007 seperated in 2 regions (inner, outer). The border is for R=3 kpc in galactocentric radius. model is discribed in outer: ApJ, 497, 759 inner: arxiv: astroph/0702532 
DensityList  Superposition of density models. the addDensity function adds a new density to the list. The getDensity function cares about acitvated types in loaded densitys. The get(typ)Density doesn't care 
Nakanishi  Zylindrical symetrical model of the density distribution of the Milkyway for atomic (HI) and molecular (H2) hydrogen Modell for HI arXiv:astroph/0304338 Modell for H2 arxiv:astroph/0610769 fit of the models given in arXiv:1607.07886 
AdiabaticCooling  Implements adiabatic cooling/heating due to advection 
PeriodicBox  Rectangular box with periodic boundaries 
ReflectiveBox  Rectangular box with reflective boundaries 
CubicBoundary  Flags a particle when exiting the cube 
SphericalBoundary  Flag a particle when leaving the sphere 
EllipsoidalBoundary  Flags a particle when leaving the ellipsoid 
CylindricalBoundary  Flags a particle when leaving the cylinder. This module flags particles when outside of the cylinder, defined by a radius and a height. The particle is made inactive and by default is flagged "OutOfBounds". Optionally the module can ensure the candidate does not overshoot the boundary by more than a set margin 
MaximumTrajectoryLength  Deactivates the candidate beyond a maximum trajectory length 
MinimumEnergy  Deactivates the candidate below a minimum energy 
MinimumRigidity  Deactivates the candidate below a minimum rigidity 
MinimumRedshift  Deactivates the candidate below a minimum redshift 
DetectionLength  Detects the candidate at a given trajectoryLength 
DiffusionSDE  Propagates candidates as pseudo(!)particles. The time integration of SDEs is used to solve the transport equation. Here an EulerMayurama integration scheme is used. The diffusion tensor can be anisotropic with respect to the magnetic field line coordinates. The integration of field lines is done via the CKalgorithm 
ElasticScattering  Elastic scattering of background photons on cosmic ray nuclei 
ElectronPairProduction  Electronpair production of charged nuclei with background photons 
EMCascade  Collects and deactivates photons, electrons and positrons. Uses DINT to calculate the EM cascade 
EMDoublePairProduction  Electron double pair production of photons with background photons 
EMInverseComptonScattering  Inverse Compton scattering of electrons with background photons 
EMPairProduction  Electronpair production of photons with background photons 
EMTripletPairProduction  Electron triplet pair production of electrons with background photons 
HDF5Output  Output to HDF5 Format 
NuclearDecay  Nuclear decay of unstable nuclei 
ObserverFeature  Abstract base class for features of cosmic ray observers 
Observer  General cosmic ray observer 
ObserverDetectAll  Detects all particles 
ObserverSurface  Detects particles crossing the durface 
ObserverSmallSphere  Detects particles upon entering a sphere 
ObserverTracking  Tracks particles inside a sphere 
ObserverLargeSphere  Detects particles upon exiting a sphere 
ObserverPoint  Detects particles when reaching x = 0 
ObserverRedshiftWindow  Detects particles in a given redshift window 
ObserverInactiveVeto  Veto for inactive candidates 
ObserverNucleusVeto  Veto for nuclei (including protons and neutrons) 
ObserverNeutrinoVeto  Veto for neutrinos 
ObserverPhotonVeto  Veto for photons 
ObserverElectronVeto  Veto for electrons and positrons 
ObserverTimeEvolution  Observes the time evolution of the candidates (phasespace elements) This observer is very useful if the time evolution of the particle density is needed. It detects all candidates in regular timeintervals and limits the nextStep of candidates to prevent overshooting of detection intervals 
Output  Configurable output base class 
Property  
ShellOutput  Show the trajectory in the shell 
ShellOutput1D  Show the trajectory in the shell 
ShellPropertyOutput  Show the candidate properties in the shell 
ParticleCollector  A helper ouput mechanism to keep candidates inmemory and directly transfer them to Python 
PhotoDisintegration  Photodisintegration of nuclei by background photons 
PhotonEleCa  
PhotonOutput1D  
PhotoPionProduction  Photopion interactions of nuclei with background photons 
PropagationBP  Propagation through magnetic fields using the Boris method 
Y  
PropagationCK  Rectilinear propagation through magnetic fields using the CashKarp method 
Y  
Redshift  Updates redshift and applies adiabatic energy loss according to the traveled distance 
FutureRedshift  Updates redshift and applies adiabatic energy loss according to the traveled distance. Extends to negative redshift values to allow for symmetric time windows around z=0 
RestrictToRegion  Limit Module to region in simulation 
SimplePropagation  Simple rectilinear propagation in absence of magnetic fields 
SynchrotronRadiation  Synchrotron radiation of charged particles in magnetic fields 
TextOutput  Configurable plain text output for cosmic ray information 
PerformanceModule  Module to monitor the simulation performance 
ParticleFilter  Reject Particles not listed in filter 
EmissionMapFiller  Fill EmissionMap with source particle state 
Module  Abstract base class for modules 
AbstractCondition  Abstract Module providing common features for conditional modules 
ModuleList  The simulation itself: A list of simulation modules 
ModuleListRunner  Run the provided ModuleList when process is called 
ParticleState  State of the particle: ID, energy, position, direction 
Random  Random number generator 
Referenced  Base class for reference counting 
ref_ptr  Referenced pointer 
SourceFeature  Abstract base class cosmic ray source features 
SourceInterface  Abstract base class for cosmic ray sources 
Source  General cosmic ray source 
SourceList  List of cosmic ray sources of individual lumosities 
SourceParticleType  Particle type at the source 
SourceMultipleParticleTypes  Multiple particle types with individual relative abundances 
SourceEnergy  Sets the initial energy to a given value 
SourcePowerLawSpectrum  Particle energy following a power law spectrum 
SourceComposition  Multiple nuclei with power law spectrum between Emin and Z * Rmax 
SourcePosition  Position of a point source 
SourceMultiplePositions  Multiple point source positions with individual luminosities 
SourceUniformSphere  Uniform random source positions inside a sphere 
SourceUniformHollowSphere  Uniform random source positions inside of a hollow sphere wall 
SourceUniformShell  Uniform random source positions on a sphere 
SourceUniformBox  Uniform random source positions inside a box 
SourceUniformCylinder  Uniform random source positions inside a Cylinder 
SourceSNRDistribution  Source distribution that follows the Galactic SNR distribution 
SourcePulsarDistribution  Source distribution following the Galactic pulsar distribution 
SourceUniform1D  1DPositions from a uniform source distribution in an expanding universe 
SourceDensityGrid  Random source positions from a density grid 
SourceDensityGrid1D  Random source positions from a 1D density grid 
SourceIsotropicEmission  Isotropic emission from a source 
SourceDirection  Emission in a discrete direction 
SourceEmissionMap  Deactivate Candidate if it has zero probability in provided EmissionMap 
SourceEmissionCone  Uniform random emission inside a cone 
SourceRedshift  Discrete redshift (time of emission) 
SourceUniformRedshift  Random redshift (time of emission) from uniform distribution 
SourceRedshiftEvolution  Random redshift (time of emission) from (1+z)^m distribution 
SourceRedshift1D  Redshift according to the distance to 0 
SourceGenericComposition  Multiple nuclei with energies described by an expression string 
Nucleus  
Variant  Storage container for data types as e.g. int, float, string, etc 
bad_conversion  
Vector3  Template class for 3vectors of type float, double, .. 
PshirkovField  Pshirkov2011 galactic magnetic field model 