Class to implement the model of Yamada et al. More...

#include <yamada.h>

Inheritance diagram for Yamada:

Public Member Functions
	Yamada (const TmodelInformation &, const Tproperties &)
	Constructor.
virtual	~Yamada ()
	Destructor.
double	getISFlux (int) const
	Getter for local interstellar flux.
Public Member Functions inherited from Particle
	Particle (const TmodelInformation &, const Tproperties &)
	Constructor.
virtual	~Particle ()
	Destructor.
long	simulate (Random &)
	Simulate trajectory from the earth to the heliospheric boundary.
double	getR () const
	Getter for r.
double	getT () const
	Getter for kinetic energy T.
double	getHeliosphereBoundary () const
	Getter for the boundary of the heliosphere in AU.
double	getISFlux (bool) const
	Getter for local interstellar flux.
double	getISFlux (bool, int) const
	Getter for local interstellar flux.

Protected Member Functions
double	getKappaRR () const
	Getter for radial part of the diffusion tensor.
double	getDeltaR (Random &) const
	Getter for delta r.
Protected Member Functions inherited from Particle
double	getDeltaTheta (Random &) const
	Getter for delta theta.
double	getDeltaPhi () const
	Getter for delta phi.
void	calculate ()
	Method to calculate all quantities which are needed several times in one step.
double	getV () const
	Getter for solar wind in AU*s^-1.
double	getP2 () const
	Getter for rigidity^2 in GV^2.
double	getRigidity () const
	Getter for rigidity in GV.
double	getBeta () const
	Getter for beta (particle speed)
double	getPolarity () const
	Getter for solar polarity.
double	getAngle () const
	Getter for tilt angle.
double	getTanPsi () const
	Getter for tan(psi)
double	convertDeg (double) const
	Conversion method from deg to rad.
double	getLarmorRadius () const
	Getter for Larmor radius.
double	getB0OverB () const
	Getter for B0/B (needed in many models for the diffusion tensor)
double	getB () const
	Getter for absolute value of B field.
double	getTheta () const
	Getter for angle theta.
double	getPhi () const
	Getter for angle phi.
double	getTime () const
	Getter for time.
double	getMass () const
	Getter for mass.
double	getCharge () const
	Getter for charge.
int	getHeaviside () const
	Getter for Heaviside function.
double	getKappaPerpendicular () const
	Getter for perpendicular part of the diffusion tensor.
double	getKappaThetaTheta () const
	Getter for angular part of the diffusion tensor.

Additional Inherited Members
Protected Attributes inherited from Particle
double	r
	radial coordinate
double	theta
	angular (theta) coordinate
double	phi
	angular (phi) coordinate
double	time
	time coordinate
Tproperties	spec
	Particle properties.
TstepData	data
	Data which are calculated in method void calculate()
double	dt
	dt from control file
double	heliosphereBoundary
	Boundary of the heliosphere (model dependent)
double	perPart
	Coefficient between the parallel and perpendicular diffusion tensor.
double	kappa0
	Normalization of the diffusion tensor.
double	BfieldScaling
	Normalization of the solar magnetic field.
int	polarity
	Solar magnetic field polarity.
double	angle
	HCS tilt angle.

Detailed Description

Class to implement the model of Yamada et al.

Constructor & Destructor Documentation

Constructor.

Parameters:

modelInfo	Model information from import.cc
sp	Particle properties

double Yamada::getDeltaR ( Random & rNum ) const

protectedvirtual

Getter for delta r.

Parameters:

rNum	random number class

Implements Particle.

double Yamada::getISFlux ( int Z ) const

virtual

Getter for local interstellar flux.

Parameters:

Z	Charge of the CR species

Reimplemented from Particle.

double Yamada::getKappaRR ( ) const

protected

Getter for radial part of the diffusion tensor.

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