AFPProtonTransportParam Class Reference

Class for the parameterization used by the proton transport tool. More...

#include <AFPProtonTransportParam.h>

Collaboration diagram for AFPProtonTransportParam:

Public Member Functions
	AFPProtonTransportParam (double beam_energy, AFPProtonTransportPolynomial *poly_array[8])
	Constructor which sets m_energy and m_polynomial. More...
	~AFPProtonTransportParam ()
	Destructor of the class. It deletes the polynomial objects set in the constructor. More...
double	evaluate (double x0, double y0, double z0, double sx, double sy, double E) const
	This function evaluates value of the parameterization given a certain polynomial. It takes as arguments the inital position, slope and nominal energy and uses it along with the polynomial objects given to the constructor to calculate the value of the parameterization. More...

Private Attributes
double	m_energy
	Nominal beam energy. More...
AFPProtonTransportPolynomial *	m_polynomial [8]
	Object of the AFPProtonTransportPolynomial class used for the position calculations. More...

Detailed Description

Class for the parameterization used by the proton transport tool.

This class calculates the parameterization for a given polynomial. Using the given polynomial and the inital positon, slope and nominal beam energy it can calculate the parameterization.

Definition at line 16 of file AFPProtonTransportParam.h.

Constructor & Destructor Documentation

AFPProtonTransportParam()

AFPProtonTransportParam::AFPProtonTransportParam	(	double	beam_energy,
		AFPProtonTransportPolynomial *	poly_array[8]
	)

Constructor which sets m_energy and m_polynomial.

Parameters

beam_energy	nominal beam energy
poly_array	array of pointers to 8 polynomials with transport parametrisation

Definition at line 7 of file AFPProtonTransportParam.cxx.

                                                                                                                {
  m_energy = beam_energy;
  for (int i = 0; i < 8; i++) m_polynomial[i] = poly_array[i];
}

~AFPProtonTransportParam()

AFPProtonTransportParam::~AFPProtonTransportParam

(

)

Destructor of the class. It deletes the polynomial objects set in the constructor.

Definition at line 12 of file AFPProtonTransportParam.cxx.

                                                   {
  for (int i = 0; i < 8; i++)
    delete m_polynomial[i];
}

Member Function Documentation

evaluate()

double AFPProtonTransportParam::evaluate	(	double	x0,
		double	y0,
		double	z0,
		double	sx,
		double	sy,
		double	E
	)		const

This function evaluates value of the parameterization given a certain polynomial. It takes as arguments the inital position, slope and nominal energy and uses it along with the polynomial objects given to the constructor to calculate the value of the parameterization.

Definition at line 17 of file AFPProtonTransportParam.cxx.

                                                                                                                {
  const double xi = (m_energy - E) / m_energy;
 
  double v0 = m_polynomial[0]->evaluate(xi);
  double v1 = x0 * m_polynomial[1]->evaluate(xi);
  double v2 = y0 * m_polynomial[2]->evaluate(xi);
  double v3 = z0 * m_polynomial[3]->evaluate(xi);
  double v4 = sx0 * m_polynomial[4]->evaluate(xi);
  double v5 = sy0 * m_polynomial[5]->evaluate(xi);
  double v6 = z0 * sx0 * m_polynomial[6]->evaluate(xi);
  double v7 = z0 * sy0 * m_polynomial[7]->evaluate(xi);
 
  double value = v0 + v1 + v2 + v3 + v4 + v5 + v6 + v7;
 
  return value;
}

Member Data Documentation

m_energy

double AFPProtonTransportParam::m_energy

private

Nominal beam energy.

Definition at line 30 of file AFPProtonTransportParam.h.

m_polynomial

AFPProtonTransportPolynomial* AFPProtonTransportParam::m_polynomial[8]

private

Object of the AFPProtonTransportPolynomial class used for the position calculations.

Definition at line 32 of file AFPProtonTransportParam.h.

---

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

• AFPProtonTransportParam.h
• AFPProtonTransportParam.cxx