---

MFGrid Class Reference

Virtual interface for a field provider that is based on interpolation on a regular grid. More...

#include <MagneticField/Interpolation/interface/MFGrid.h>

Inheritance diagram for MFGrid:

List of all members.

Public Types
typedef GloballyPositioned < float >::GlobalPoint	GlobalPoint
typedef GloballyPositioned < float >::GlobalVector	GlobalVector
typedef GloballyPositioned < float >::LocalPoint	LocalPoint
typedef GloballyPositioned < float >::LocalVector	LocalVector
Public Member Functions
virtual std::vector< int >	dimensions () const =0
virtual void	dump () const
const GloballyPositioned< float > &	frame () const
	Local reference frame.
virtual LocalPoint	fromGridFrame (double a, double b, double c) const =0
	find grid coordinates for point. For debugging and validation only.
virtual std::vector< int >	index (const LocalPoint &p) const
	MFGrid (const GloballyPositioned< float > &vol)
virtual LocalPoint	nodePosition (int i, int j, int k) const =0
	Position of node in local frame.
virtual LocalVector	nodeValue (int i, int j, int k) const =0
	Field value at node.
virtual void	toGridFrame (const LocalPoint &p, double &a, double &b, double &c) const =0
	find grid coordinates for point. For debugging and validation only.
virtual LocalVector	valueInTesla (const LocalPoint &p) const =0
	Interpolated field value at given point.
virtual	~MFGrid ()
Private Attributes
GloballyPositioned< float >	frame_

---

Detailed Description

Virtual interface for a field provider that is based on interpolation on a regular grid.

Date

2008/04/09 19:37:23

Revision

1.4

Author:

T. Todorov

Definition at line 19 of file MFGrid.h.

---

Member Typedef Documentation

typedef GloballyPositioned<float>::GlobalPoint MFGrid::GlobalPoint

Definition at line 22 of file MFGrid.h.

typedef GloballyPositioned<float>::GlobalVector MFGrid::GlobalVector

Definition at line 23 of file MFGrid.h.

typedef GloballyPositioned<float>::LocalPoint MFGrid::LocalPoint

Definition at line 24 of file MFGrid.h.

typedef GloballyPositioned<float>::LocalVector MFGrid::LocalVector

Definition at line 25 of file MFGrid.h.

---

Constructor & Destructor Documentation

MFGrid::MFGrid

(

const GloballyPositioned< float > &

vol

)

[inline, explicit]

Definition at line 27 of file MFGrid.h.

: frame_(vol) {}

virtual MFGrid::~MFGrid

(

)

[inline, virtual]

Definition at line 29 of file MFGrid.h.

{}

---

Member Function Documentation

virtual std::vector<int> MFGrid::dimensions

(

)

const [pure virtual]

Implemented in MFGrid3D, CylinderFromSectorMFGrid, GlobalGridWrapper, and ZReflectedMFGrid.

Referenced by ZReflectedMFGrid::dimensions(), CylinderFromSectorMFGrid::dimensions(), and SteppingHelixPropagator::isYokeVolume().

virtual void MFGrid::dump

(

void

)

const [inline, virtual]

Reimplemented in GlobalGridWrapper, RectangularCartesianMFGrid, RectangularCylindricalMFGrid, SpecialCylindricalMFGrid, TrapezoidalCartesianMFGrid, and TrapezoidalCylindricalMFGrid.

Definition at line 34 of file MFGrid.h.

{}

const GloballyPositioned<float>& MFGrid::frame

(

)

const [inline]

Local reference frame.

Definition at line 53 of file MFGrid.h.

References frame_.

Referenced by SpecialCylindricalMFGrid::fromGridFrame(), RectangularCartesianMFGrid::RectangularCartesianMFGrid(), RectangularCylindricalMFGrid::RectangularCylindricalMFGrid(), SpecialCylindricalMFGrid::SpecialCylindricalMFGrid(), SpecialCylindricalMFGrid::toGridFrame(), TrapezoidalCartesianMFGrid::TrapezoidalCartesianMFGrid(), TrapezoidalCylindricalMFGrid::TrapezoidalCylindricalMFGrid(), TrapezoidalCylindricalMFGrid::uncheckedValueInTesla(), and GlobalGridWrapper::valueInTesla().

{ return frame_;}

virtual LocalPoint MFGrid::fromGridFrame	(	double	a,
		double	b,
		double	c
	)			const [pure virtual]

find grid coordinates for point. For debugging and validation only.

Implemented in CylinderFromSectorMFGrid, GlobalGridWrapper, RectangularCartesianMFGrid, RectangularCylindricalMFGrid, SpecialCylindricalMFGrid, TrapezoidalCartesianMFGrid, TrapezoidalCylindricalMFGrid, and ZReflectedMFGrid.

Referenced by MFGrid3D::nodePosition(), and MFGrid3D::valueInTesla().

virtual std::vector<int> MFGrid::index

(

const LocalPoint &

p

)

const [inline, virtual]

Reimplemented in MFGrid3D.

Definition at line 50 of file MFGrid.h.

{return std::vector<int>();}

virtual LocalPoint MFGrid::nodePosition	(	int	i,
		int	j,
		int	k
	)			const [pure virtual]

Position of node in local frame.

Implemented in MFGrid3D, CylinderFromSectorMFGrid, GlobalGridWrapper, and ZReflectedMFGrid.

virtual LocalVector MFGrid::nodeValue	(	int	i,
		int	j,
		int	k
	)			const [pure virtual]

Field value at node.

Implemented in MFGrid3D, CylinderFromSectorMFGrid, GlobalGridWrapper, and ZReflectedMFGrid.

Referenced by SteppingHelixPropagator::isYokeVolume().

virtual void MFGrid::toGridFrame	(	const LocalPoint &	p,
		double &	a,
		double &	b,
		double &	c
	)			const [pure virtual]

find grid coordinates for point. For debugging and validation only.

Implemented in CylinderFromSectorMFGrid, GlobalGridWrapper, RectangularCartesianMFGrid, RectangularCylindricalMFGrid, SpecialCylindricalMFGrid, TrapezoidalCartesianMFGrid, TrapezoidalCylindricalMFGrid, and ZReflectedMFGrid.

Referenced by MFGrid3D::index().

virtual LocalVector MFGrid::valueInTesla

(

const LocalPoint &

p

)

const [pure virtual]

Interpolated field value at given point.

Implements MagneticFieldProvider< float >.

Implemented in MFGrid3D, CylinderFromSectorMFGrid, GlobalGridWrapper, and ZReflectedMFGrid.

Referenced by CylinderFromSectorMFGrid::valueInTesla(), and ZReflectedMFGrid::valueInTesla().

---

Member Data Documentation

GloballyPositioned<float> MFGrid::frame_ [private]

Definition at line 57 of file MFGrid.h.

Referenced by frame().

---

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

• MagneticField/Interpolation/interface/MFGrid.h

---