Heed::EnergyMesh Class Reference

#include <EnergyMesh.h>

Inheritance diagram for Heed::EnergyMesh:

Public Member Functions
	EnergyMesh ()
	Default constructor.
	EnergyMesh (double femin, double femax, long fq)
	Constructor from min./max energy and number of bins.
	EnergyMesh (const std::vector< double > &fec)
	Constructor from a list of energies.
virtual	~EnergyMesh ()
	Destructor.
long	get_q () const
	Return number of bins.
double	get_emin () const
	Return left side of the first bin.
double	get_emax () const
	Return right side of the last bin.
double	get_e (long n) const
	Return left side of a given bin.
double	get_ec (long n) const
	Return center of a given bin.
const double *	get_ae (void) const
	Return all left sides.
const double *	get_aec (void) const
	Return all interval centres.
long	get_interval_number (const double ener) const
long	get_interval_number_between_centers (const double ener) const
virtual EnergyMesh *	copy () const
virtual void	print (std::ostream &file, int l) const
Public Member Functions inherited from Heed::RegPassivePtr
	RegPassivePtr (void)
	RegPassivePtr (char fs_ban_del, char fs_ban_sub, char fs_ban_cop=0)
	RegPassivePtr (const RegPassivePtr &f)
RegPassivePtr &	operator= (const RegPassivePtr &f)
CountPP_ns::CountPassivePtr *	book (void) const
void	clear_pointers (void) const
virtual RegPassivePtr *	copy () const
virtual	~RegPassivePtr ()
virtual void	print (std::ostream &file, int l=1) const
void	set_s_ban_del (char fs_ban_del)
char	get_s_ban_del (void) const
void	set_s_ban_sub (char fs_ban_sub)
char	get_s_ban_sub (void) const
void	set_s_ban_cop (char fs_ban_cop)
char	get_s_ban_cop (void) const
void	set_s_allow_del_at_zero_count (char fs_allow_del_at_zero_count)
char	get_s_allow_del_at_zero_count (void) const
long	get_total_number_of_references (void) const

Friends
std::ostream &	operator<< (std::ostream &file, EnergyMesh &f)

Additional Inherited Members
Static Public Member Functions inherited from Heed::RegPassivePtr
static void	set_s_ban_del_ignore (char fs_ban_del_ignore)
static char	get_s_ban_del_ignore (void)
static void	set_s_print_adr_cpp (char fs_print_adr_cpp)
static char	get_s_print_adr_cpp (void)

Detailed Description

Energy mesh (in MeV, as everywhere in HEED, unless otherwise specified). Internal calculations in HEED are conveniently performed with some standard energy mesh. This mesh should be logarithmic or similar, with dense spacing at small energies and sparse spacing at large energies. The class below determines such mesh and some standard functions, namely getting center of energy interval get_ec(long n), left edge of interval get_e(long n) (right edge is left one for the next bin), and some other simple functions. There may be many meshes in program (but currently only one mesh is used in a single program, different meshes may be used for totally different matters and cross sections). The pointer to mesh should be given as parameter of class constructor, when a class depends on mesh.

The class keeps the left sides of bins and their centers in arrays. Since the right side of interval is the left of the next one, the array keeping the left sides should be by one larger then the dimension of the mesh.

For reasons of speed the internal arrays keep right sides of intervals and their centers are defined as simple fixed-size arrays.

2003, I. Smirnov

Definition at line 33 of file EnergyMesh.h.

Constructor & Destructor Documentation

EnergyMesh() [1/3]

Heed::EnergyMesh::EnergyMesh ( )

inline

Default constructor.

Definition at line 36 of file EnergyMesh.h.

: q(0), emin(0.0), emax(0.0) {}

Referenced by copy().

EnergyMesh() [2/3]

Heed::EnergyMesh::EnergyMesh	(	double	femin,
		double	femax,
		long	fq
	)

Constructor from min./max energy and number of bins.

Definition at line 8 of file EnergyMesh.cpp.

    : q(fq), emin(femin), emax(femax) {
  mfunname("EnergyMesh::EnergyMesh(double femin, double femax, long fq)");
  check_econd21(q, < 0 ||, > pqener - 1, mcerr);
 
  const double rk = pow(emax / emin, (1.0 / double(q)));
  double er = emin;
  e[0] = er;
  for (long n = 1; n < q + 1; n++) {
    e[n] = er * rk;
    ec[n - 1] = (e[n - 1] + e[n]) * 0.5;
    er = e[n];
  }
}

EnergyMesh() [3/3]

Heed::EnergyMesh::EnergyMesh

(

const std::vector< double > &

fec

)

Constructor from a list of energies.

Definition at line 23 of file EnergyMesh.cpp.

                                                   : q(fec.size()) {
  mfunname("std::vector< double > fec");
  check_econd21(q, < 0 ||, > pqener - 1, mcerr);
  check_econd11(q, != 1, mcerr);  // otherwise problems with emin/emax
  if (q <= 0) {
    emin = 0.0;
    emax = 0.0;
    return;
  }
  emin = fec[0] - (fec[1] - fec[0]) / 2.0;
  emax = fec[q - 1] + (fec[q - 1] - fec[q - 2]) / 2.0;
  e[0] = emin;
  e[q] = emax;
 
  for (long n = 0; n < q; n++) {
    ec[n] = fec[n];
  }
  for (long n = 1; n < q; n++) {
    e[n] = 0.5 * (fec[n - 1] + fec[n]);
  }
}

~EnergyMesh()

virtual Heed::EnergyMesh::~EnergyMesh ( )

inlinevirtual

Destructor.

Definition at line 42 of file EnergyMesh.h.

{}

Member Function Documentation

copy()

virtual EnergyMesh * Heed::EnergyMesh::copy ( ) const

inlinevirtual

Reimplemented from Heed::RegPassivePtr.

Definition at line 63 of file EnergyMesh.h.

{ return new EnergyMesh(*this); }

get_ae()

const double * Heed::EnergyMesh::get_ae ( void  ) const

inline

Return all left sides.

Definition at line 55 of file EnergyMesh.h.

{ return e; }

get_aec()

const double * Heed::EnergyMesh::get_aec ( void  ) const

inline

Return all interval centres.

Definition at line 57 of file EnergyMesh.h.

{ return ec; }

get_e()

double Heed::EnergyMesh::get_e ( long  n ) const

inline

Return left side of a given bin.

Definition at line 51 of file EnergyMesh.h.

{ return e[n]; }

get_ec()

double Heed::EnergyMesh::get_ec ( long  n ) const

inline

Return center of a given bin.

Definition at line 53 of file EnergyMesh.h.

{ return ec[n]; }

Referenced by Heed::HeedDeltaElectron::physics_after_new_speed(), and Heed::HeedDeltaElectron::physics_mrange().

get_emax()

double Heed::EnergyMesh::get_emax ( ) const

inline

Return right side of the last bin.

Definition at line 49 of file EnergyMesh.h.

{ return emax; }

get_emin()

double Heed::EnergyMesh::get_emin ( ) const

inline

Return left side of the first bin.

Definition at line 47 of file EnergyMesh.h.

{ return emin; }

get_interval_number()

long Heed::EnergyMesh::get_interval_number

(

const double

ener

)

const

Definition at line 45 of file EnergyMesh.cpp.

                                                            {
  if (ener < emin) return -1;
  if (ener > emax) return q;
 
  long n1 = 0;
  long n2 = q;  // right side of last
  while (n2 - n1 > 1) {
    const long n3 = n1 + ((n2 - n1) >> 1);
    if (ener < e[n3]) {
      n2 = n3;
    } else {
      n1 = n3;
    }
  }
  return n1;
}

get_interval_number_between_centers()

long Heed::EnergyMesh::get_interval_number_between_centers

(

const double

ener

)

const

Definition at line 62 of file EnergyMesh.cpp.

                                                                            {
  if (ener < ec[0]) return -1;
  if (ener > ec[q - 1]) return q;
 
  long n1 = 0;
  long n2 = q - 1;  // right side of last
  while (n2 - n1 > 1) {
    const long n3 = n1 + ((n2 - n1) >> 1);
    if (ener < ec[n3]) {
      n2 = n3;
    } else {
      n1 = n3;
    }
  }
  return n1;
}

get_q()

long Heed::EnergyMesh::get_q ( ) const

inline

Return number of bins.

Definition at line 45 of file EnergyMesh.h.

{ return q; }

Referenced by Heed::HeedParticle::physics(), and Heed::HeedParticle_BGM::physics().

print()

void Heed::EnergyMesh::print ( std::ostream &  file, int  l  ) const

virtual

Reimplemented from Heed::RegPassivePtr.

Definition at line 95 of file EnergyMesh.cpp.

                                                    {
  if (l <= 0) return;
  Ifile << "EnergyMesh (l=" << l << "): \n";
  indn.n += 2;
  Ifile << "emin=" << emin << " emax=" << emax << " quantity of intervals=" << q
        << '\n' << " maximal possible quantity of intervals=" << pqener << '\n';
  if (l > 1) {
    Ifile << " number  left side        center       right side       widht\n";
    for (int n = 0; n < q; n++) {
      Ifile << std::setw(5) << n << std::setw(15) << e[n] << std::setw(15)
            << ec[n] << std::setw(15) << e[n + 1] << std::setw(15)
            << (e[n + 1] - e[n]) << '\n';
    }
  }
  indn.n -= 2;
}

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  file, EnergyMesh &  f  )

friend

Definition at line 79 of file EnergyMesh.cpp.

                                                        {
  Ifile << "EnergyMesh: \n";
  indn.n += 2;
  Ifile << "emin=" << f.emin << " emax=" << f.emax
        << " number of intervals=" << f.q << '\n'
        << " maximal number of intervals=" << EnergyMesh::pqener << '\n';
  Ifile << " bin  left side        center       right side       width\n";
  for (int n = 0; n < f.q; n++) {
    Ifile << std::setw(5) << n << std::setw(15) << f.e[n] << std::setw(15)
          << f.ec[n] << std::setw(15) << f.e[n + 1] << std::setw(15)
          << (f.e[n + 1] - f.e[n]) << '\n';
  }
  indn.n -= 2;
  return file;
}

---

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

• EnergyMesh.h
• EnergyMesh.cpp