MFGrid3D Class Reference

#include <MFGrid3D.h>

Inheritance diagram for MFGrid3D:

Public Member Functions
virtual Dimensions	dimensions (void) const
virtual Indexes	index (const LocalPoint &p) const
	MFGrid3D (const GloballyPositioned< float > &vol)
virtual LocalPoint	nodePosition (int i, int j, int k) const
	Position of node in local frame. More...
virtual LocalVector	nodeValue (int i, int j, int k) const
	Field value at node. More...
virtual LocalVector	uncheckedValueInTesla (const LocalPoint &p) const =0
	Interpolated field value at given point; does not check for exceptions. More...
virtual LocalVector	valueInTesla (const LocalPoint &p) const
	Interpolated field value at given point. More...
Public Member Functions inherited from MFGrid
virtual void	dump () const
const GloballyPositioned< float > &	frame () const
	Local reference frame. More...
virtual LocalPoint	fromGridFrame (double a, double b, double c) const =0
	find grid coordinates for point. For debugging and validation only. More...
	MFGrid (const GloballyPositioned< float > &vol)
virtual void	toGridFrame (const LocalPoint &p, double &a, double &b, double &c) const =0
	find grid coordinates for point. For debugging and validation only. More...
virtual	~MFGrid ()
Public Member Functions inherited from MagneticFieldProvider< float >
virtual LocalVectorType	derivativeInTeslaPerMeter (const LocalPointType &p, int N) const
virtual int	hasDerivatives () const
virtual LocalVectorType	valueInTesla (const LocalPointType &p) const =0
virtual	~MagneticFieldProvider ()

Protected Types
using	BVector = Grid3D::BVector
using	GridType = Grid3D

Protected Member Functions
void	setGrid (const GridType &grid)

Protected Attributes
GridType	grid_

Additional Inherited Members
Public Types inherited from MFGrid
typedef GloballyPositioned < float >::GlobalPoint	GlobalPoint
typedef GloballyPositioned < float >::GlobalVector	GlobalVector
typedef GloballyPositioned < float >::LocalPoint	LocalPoint
typedef GloballyPositioned < float >::LocalVector	LocalVector
Public Types inherited from MagneticFieldProvider< float >
typedef Point3DBase< float, GlobalTag >	GlobalPointType
typedef Vector3DBase< float, GlobalTag >	GlobalVectorType
typedef Point3DBase< float, LocalTag >	LocalPointType
typedef Vector3DBase< float, LocalTag >	LocalVectorType

Detailed Description

Generic virtual implementation of a MFGrid for a 3D underlying regular grid.

Author

T. Todorov

Definition at line 17 of file MFGrid3D.h.

Member Typedef Documentation

using MFGrid3D::BVector = Grid3D::BVector

protected

Definition at line 60 of file MFGrid3D.h.

using MFGrid3D::GridType = Grid3D

protected

Definition at line 59 of file MFGrid3D.h.

Constructor & Destructor Documentation

MFGrid3D::MFGrid3D ( const GloballyPositioned< float > &  vol )

inlineexplicit

Definition at line 20 of file MFGrid3D.h.

: MFGrid(vol) {}

Member Function Documentation

virtual Dimensions MFGrid3D::dimensions ( void  ) const

inlinevirtual

Implements MFGrid.

Definition at line 23 of file MFGrid3D.h.

References Dimensions::d, Dimensions::h, tmp, and Dimensions::w.

                                            {
    Dimensions tmp;
    tmp.w = grid_.grida().nodes();
    tmp.h = grid_.gridb().nodes();
    tmp.d = grid_.gridc().nodes();
    return tmp;
  }

virtual Indexes MFGrid3D::index ( const LocalPoint &  p ) const

inlinevirtual

Reimplemented from MFGrid.

Definition at line 42 of file MFGrid3D.h.

References a, b, EnergyCorrector::c, Indexes::i, Indexes::j, Indexes::k, mps_fire::result, and MFGrid::toGridFrame().

                                                    {
    Indexes result;
    double a, b, c;
    toGridFrame( p, a, b, c);
    result.i = grid_.grida().index(a);
    result.j = grid_.gridb().index(b);
    result.k = grid_.gridc().index(c);
    return result;
  }

virtual LocalPoint MFGrid3D::nodePosition ( int  i, int  j, int  k  ) const

inlinevirtual

Position of node in local frame.

Implements MFGrid.

Definition at line 32 of file MFGrid3D.h.

References MFGrid::fromGridFrame().

                                                               {
    return fromGridFrame( grid_.grida().node(i), grid_.gridb().node(j), grid_.gridc().node(k));
  }

virtual LocalVector MFGrid3D::nodeValue ( int  i, int  j, int  k  ) const

inlinevirtual

Field value at node.

must check range here: FIX ME !!!!

Implements MFGrid.

Definition at line 37 of file MFGrid3D.h.

                                                            {
    return MFGrid::LocalVector(grid_( i, j, k));
  }

void MFGrid3D::setGrid ( const GridType &  grid )

inlineprotected

Definition at line 64 of file MFGrid3D.h.

References getRunAppsInfo::grid.

                                      {
    grid_ = grid;
  }

virtual LocalVector MFGrid3D::uncheckedValueInTesla ( const LocalPoint &  p ) const

pure virtual

Interpolated field value at given point; does not check for exceptions.

Implemented in SpecialCylindricalMFGrid, TrapezoidalCartesianMFGrid, TrapezoidalCylindricalMFGrid, RectangularCartesianMFGrid, and RectangularCylindricalMFGrid.

Referenced by valueInTesla().

MFGrid::LocalVector MFGrid3D::valueInTesla ( const LocalPoint &  p ) const

virtual

Interpolated field value at given point.

Implements MFGrid.

Definition at line 5 of file MFGrid3D.cc.

References MFGrid::fromGridFrame(), GridInterpolator3DException::limits(), uncheckedValueInTesla(), and pileupCalc::upper.

{
  try {
    return uncheckedValueInTesla( p);
  }
  catch ( GridInterpolator3DException& outside) {
    double *limits = outside.limits();
    LocalPoint lower = fromGridFrame( limits[0], limits[1], limits[2]);
    LocalPoint upper = fromGridFrame( limits[3], limits[4], limits[5]);
    throw MagVolumeOutsideValidity( lower, upper);
  }

}

Member Data Documentation

GridType MFGrid3D::grid_

protected

Definition at line 62 of file MFGrid3D.h.

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