BfldMap.h

Go to the documentation of this file.

// $Id: BfldMap.h,v 1.9 2005/02/09 04:58:14 rhatcher Exp $
//
// BfldMap
//
// This structure provides services for holding the magnetic field components
// at a series of points (cf. BfldMesh).  It encapsulates knowledge 
// about the field values themselves, an possibly how to adjust them
// for external effects (chemistry, coil current, etc.) but doesn't
// explicitly hold any knowledge about the relative spatial placement
// of the field values; that it must glean from BfldMesh.
//
// Author:  R. Hatcher 2000.06.20
//
#ifndef BFLDMAP_H
#define BFLDMAP_H

#include "TVector3.h"
#include "TClonesArray.h"
// don't use simple 'class TClonesArray' or CINT can't build streamer

#include "BField/BfldGrid.h"
#include "BField/BfldRefCnt.h"

#include <vector>

class BfldMap : public TObject, public BfldRefCnt {

 public:

   BfldMap();
   BfldMap(BfldGrid::Grid_t grid, Int_t variant);
   virtual ~BfldMap();

   virtual TVector3  GetBField(Int_t generator);   // return corrected field
                                                   // oooops no longer! ==Raw
   virtual TVector3  GetRawField(Int_t generator); // uncorrected field

   BfldGrid::Grid_t  GetGrid() const;    // which grid does this map lie on?
   Int_t             GetVariant() const; // which map variation, due to
                                         // chemistry, end-plane effects, etc
   Float_t           GetGeneratedCoilCurrent() const;

 protected:

   void            ResizeVectors(UInt_t size);
   void            AddGenerator(UInt_t generator, Double_t bx, Double_t by, 
                                Double_t bz=0.0);
                   // the TVector3 interface is for convenience only
                   // the preferred interface is the one with components
   void            AddGenerator(UInt_t generator, TVector3& bfld);

   BfldGrid::Grid_t    fGrid;
   Int_t               fVariant;
   Bool_t              fIs3d;       // has non-zero z components

   Float_t             fGeneratedCoilCurrent;  // current used when generating
   Bool_t              fFilledOkay;            // successful construction?
   std::string         fDataSource;            // e.g. filename

   UInt_t              fNumGenerators;
   std::vector<Float_t> fBx;
   std::vector<Float_t> fBy;
   std::vector<Float_t> fBz;
   ClassDef(BfldMap,4)

 private:

};

inline BfldGrid::Grid_t BfldMap::GetGrid() const { return fGrid; }
inline Int_t            BfldMap::GetVariant() const { return fVariant; }
inline Float_t          BfldMap::GetGeneratedCoilCurrent() const
                                     { return fGeneratedCoilCurrent; }

#endif // BFLDMAP_H

// RWH Blog:
// Currently we have the ctor reading the text files and filling the
// object, but we also need a means of doing this from the DBI tables.
//    specialized functions for 
//         Rect2d file reading (would simultaneously build corresponding mesh)
//         Voronoi file reading
// Make this class lighter by replacing TClonesArray of TVector3's
// with vector<Double_t> x, y, z; bool hasZcomponents;
// don't fill z unless hasZcomponents
// no overhead of TObject, construct TVector3's as necessary
//    

---