---

Grid1D< T > Class Template Reference

#include <MagneticField/Interpolation/src/Grid1D.h>

List of all members.

Public Types
typedef T	Scalar
Public Member Functions
int	cells () const
Scalar	closestNode (Scalar a) const
	Grid1D (Scalar lower, Scalar upper, int nodes)
	Grid1D ()
int	index (Scalar a) const
	returns valid index, or -1 if the value is outside range +/- one cell.
Scalar	lower () const
Scalar	node (int i) const
int	nodes () const
Scalar	step () const
Scalar	upper () const
Private Attributes
Scalar	lower_
int	nodes_
Scalar	step_
Scalar	upper_

---

Detailed Description

template<class T>
class Grid1D< T >

Definition at line 5 of file Grid1D.h.

---

Member Typedef Documentation

template<class T>

typedef T Grid1D< T >::Scalar

Definition at line 8 of file Grid1D.h.

---

Constructor & Destructor Documentation

template<class T>

Grid1D< T >::Grid1D

(

)

[inline]

Definition at line 10 of file Grid1D.h.

{}

template<class T>

Grid1D< T >::Grid1D	(	Scalar	lower,
		Scalar	upper,
		int	nodes
	)			[inline]

Definition at line 12 of file Grid1D.h.

References Grid1D< T >::step_.

                                                 : 
    lower_(lower), upper_(upper), nodes_(nodes) {
    step_ = (upper - lower) / (nodes-1);
  }

---

Member Function Documentation

template<class T>

int Grid1D< T >::cells

(

)

const [inline]

Definition at line 22 of file Grid1D.h.

References Grid1D< T >::nodes().

Referenced by Grid1D< T >::index().

{return nodes()-1;}

template<class T>

Scalar Grid1D< T >::closestNode

(

Scalar

a

)

const [inline]

Definition at line 26 of file Grid1D.h.

References b, c, Grid1D< T >::lower(), max, min, Grid1D< T >::nodes(), Grid1D< T >::step(), and tmp.

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

template<class T>

int Grid1D< T >::index

(

Scalar

a

)

const [inline]

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

Definition at line 34 of file Grid1D.h.

References Grid1D< T >::cells(), Grid1D< T >::lower(), max, min, and Grid1D< T >::step().

                             {
    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));
  }

template<class T>

Scalar Grid1D< T >::lower

(

)

const [inline]

Definition at line 19 of file Grid1D.h.

References Grid1D< T >::lower_.

Referenced by Grid1D< T >::closestNode(), Grid1D< T >::index(), Grid1D< T >::node(), and TrapezoidalCartesianMFGrid::TrapezoidalCartesianMFGrid().

{return lower_;}

template<class T>

Scalar Grid1D< T >::node

(

int

i

)

const [inline]

Definition at line 24 of file Grid1D.h.

References Grid1D< T >::lower(), and Grid1D< T >::step().

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

template<class T>

int Grid1D< T >::nodes

(

)

const [inline]

Definition at line 21 of file Grid1D.h.

References Grid1D< T >::nodes_.

Referenced by Grid1D< T >::cells(), and Grid1D< T >::closestNode().

{return nodes_;}

template<class T>

Scalar Grid1D< T >::step

(

)

const [inline]

Definition at line 18 of file Grid1D.h.

References Grid1D< T >::step_.

Referenced by Grid1D< T >::closestNode(), Grid1D< T >::index(), and Grid1D< T >::node().

{return step_;}

template<class T>

Scalar Grid1D< T >::upper

(

)

const [inline]

Definition at line 20 of file Grid1D.h.

References Grid1D< T >::upper_.

Referenced by TrapezoidalCartesianMFGrid::TrapezoidalCartesianMFGrid().

{return upper_;}

---

Member Data Documentation

template<class T>

Scalar Grid1D< T >::lower_ [private]

Definition at line 48 of file Grid1D.h.

Referenced by Grid1D< T >::lower().

template<class T>

int Grid1D< T >::nodes_ [private]

Definition at line 50 of file Grid1D.h.

Referenced by Grid1D< T >::nodes().

template<class T>

Scalar Grid1D< T >::step_ [private]

Definition at line 47 of file Grid1D.h.

Referenced by Grid1D< T >::Grid1D(), and Grid1D< T >::step().

template<class T>

Scalar Grid1D< T >::upper_ [private]

Definition at line 49 of file Grid1D.h.

Referenced by Grid1D< T >::upper().

---

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

• MagneticField/Interpolation/src/Grid1D.h

---