Grid1D Class Reference

#include <Grid1D.h>

Public Types
typedef float	Scalar

Public Member Functions
int	cells () const
Scalar	closestNode (Scalar a) const
	Grid1D ()
	Grid1D (Scalar lower, Scalar upper, int nodes)
int	index (Scalar a) const
	returns valid index, or -1 if the value is outside range +/- one cell. More...
int	index (Scalar a, Scalar &f) const
bool	inRange (int i) const
Scalar	lower () const
Scalar	node (int i) const
int	nodes () const
void	normalize (int &ind, Scalar &f) const
Scalar	step () const
Scalar	upper () const

Private Attributes
int	edges_
Scalar	lower_
Scalar	stepinv_
Scalar	upper_

Detailed Description

Definition at line 7 of file Grid1D.h.

Member Typedef Documentation

Scalar

typedef float Grid1D::Scalar

Definition at line 9 of file Grid1D.h.

Constructor & Destructor Documentation

Grid1D() [1/2]

Grid1D::Grid1D ( )

inline

Definition at line 12 of file Grid1D.h.

{}

Grid1D() [2/2]

Grid1D::Grid1D ( Scalar  lower, Scalar  upper, int  nodes  )

inline

Definition at line 14 of file Grid1D.h.

                                                : lower_(lower), upper_(upper), edges_(nodes - 2) {
    stepinv_ = (nodes - 1) / (upper - lower);
  }

References class-composition::nodes, and pileupCalc::upper.

Member Function Documentation

cells()

int Grid1D::cells ( ) const

inline

Definition at line 22 of file Grid1D.h.

{ return edges_ + 1; }

closestNode()

Scalar Grid1D::closestNode ( Scalar  a ) const

inline

Definition at line 46 of file Grid1D.h.

                                     {
    Scalar b = (a - lower()) / step();
    Scalar c = floor(b);
    Scalar tmp = (b - c < 0.5) ? std::max(c, 0.f) : std::min(c + 1.f, static_cast<Scalar>(nodes() - 1));
    return tmp * step() + lower();
  }

References a, b, c, f, SiStripPI::max, min(), class-composition::nodes, and createJobs::tmp.

index() [1/2]

int Grid1D::index ( Scalar  a ) const

inline

returns valid index, or -1 if the value is outside range +/- one cell.

Definition at line 54 of file Grid1D.h.

                            {
    int ind = static_cast<int>((a - lower()) / step());
    // FIXME: this causes an exception to be thrown later. Should be tested
    // more carefully before release
    //  if (ind < -1 || ind > cells()) {
    //     std::cout << "**** ind = " << ind << " cells: " << cells() << std::endl;
    //    return -1;
    //  }
    return std::max(0, std::min(cells() - 1, ind));
  }

References a, cells, SiStripPI::max, and min().

Referenced by BeautifulSoup.PageElement::insert().

index() [2/2]

int Grid1D::index ( Scalar  a, Scalar &  f  ) const

inline

Definition at line 29 of file Grid1D.h.

                                       {
    Scalar b;
    f = modff((a - lower()) * stepinv_, &b);
    return b;
  }

References a, b, and f.

Referenced by BeautifulSoup.PageElement::insert(), LinearGridInterpolator3D::interpolate(), and RectangularCylindricalMFGrid::uncheckedValueInTesla().

inRange()

bool Grid1D::inRange ( int  i ) const

inline

Definition at line 26 of file Grid1D.h.

{ return i >= 0 && i <= edges_; }

References mps_fire::i.

lower()

Scalar Grid1D::lower ( ) const

inline

Definition at line 19 of file Grid1D.h.

{ return lower_; }

Referenced by RectangularCartesianMFGrid::dump(), RectangularCylindricalMFGrid::dump(), TrapezoidalCartesianMFGrid::dump(), LinearGridInterpolator3D::throwGridInterpolator3DException(), TrapezoidalCartesianMFGrid::TrapezoidalCartesianMFGrid(), and RectangularCylindricalMFGrid::uncheckedValueInTesla().

node()

Scalar Grid1D::node ( int  i ) const

inline

Definition at line 24 of file Grid1D.h.

{ return i * step() + lower(); }

References mps_fire::i.

Referenced by Grid3D::dump(), LinearGridInterpolator3D::interpolate(), and RectangularCylindricalMFGrid::uncheckedValueInTesla().

nodes()

int Grid1D::nodes ( ) const

inline

Definition at line 21 of file Grid1D.h.

{ return edges_ + 2; }

Referenced by RectangularCartesianMFGrid::dump(), RectangularCylindricalMFGrid::dump(), TrapezoidalCartesianMFGrid::dump(), Grid3D::dump(), and LinearGridInterpolator3D::interpolate().

normalize()

void Grid1D::normalize ( int &  ind, Scalar &  f  ) const

inline

Definition at line 36 of file Grid1D.h.

                                            {
    if (ind < 0) {
      f -= ind;
      ind = 0;
    } else if (ind > edges_) {
      f += ind - edges_;
      ind = edges_;
    }
  }

References f.

Referenced by LinearGridInterpolator3D::interpolate().

step()

Scalar Grid1D::step ( ) const

inline

Definition at line 18 of file Grid1D.h.

{ return 1. / stepinv_; }

Referenced by RectangularCartesianMFGrid::dump(), RectangularCylindricalMFGrid::dump(), TrapezoidalCartesianMFGrid::dump(), and RectangularCylindricalMFGrid::uncheckedValueInTesla().

upper()

Scalar Grid1D::upper ( ) const

inline

Definition at line 20 of file Grid1D.h.

{ return upper_; }

Referenced by LinearGridInterpolator3D::throwGridInterpolator3DException(), and TrapezoidalCartesianMFGrid::TrapezoidalCartesianMFGrid().

Member Data Documentation

edges_

int Grid1D::edges_

private

Definition at line 69 of file Grid1D.h.

lower_

Scalar Grid1D::lower_

private

Definition at line 67 of file Grid1D.h.

stepinv_

Scalar Grid1D::stepinv_

private

Definition at line 66 of file Grid1D.h.

upper_

Scalar Grid1D::upper_

private

Definition at line 68 of file Grid1D.h.