BfldLoanPool.h

Go to the documentation of this file.

// $Id: BfldLoanPool.h,v 1.20 2009/09/16 16:55:44 rhatcher Exp $
//
// BfldLoanPool
//
// A singleton class to instantiate BfldMesh (rectangular grids and
// Voronoi diagrams) and BfldMaps.
//
// It does NOT -construct- them in the sense of turning an FEA node
// list into a Voronoi diagram or running ANSYS, but rather simply
// supplies methods for getting a copy of the appropriate structure
// (presumably by reading it from a file or using data from the database).
//
// This version is *NOT* thread safe!!!
//
// Author:  R. Hatcher 2000.06.20
//
#ifndef BFLDLOANPOOL_H
#define BFLDLOANPOOL_H

#include "TObjArray.h"
#include "BField/BfldGrid.h"
#include "Validity/VldContext.h"
#include "Configurable/CfgConfigurable.h"

class BfldMesh;
class BfldMap;
class BfldCache;

class BfldLoanPool : public TObject, public CfgConfigurable {

public:

   static BfldLoanPool*    Instance();
   virtual void            Config();
   virtual const Registry& DefaultConfig() const;
   virtual void            SetConfigFromEnvironment();

   BfldMap    *GetMap(BfldGrid::Grid_t grid, Int_t variant);
   BfldMesh   *GetMesh(BfldGrid::Grid_t grid, Int_t variant);
   BfldCache  *GetCache(VldContext& vldc);

   // cache unpacked values for quick lookup
   Int_t     GetDefaultRequireInZTest()     const {return fInZTest;           }
   Int_t     GetDefaultDoLocalTransform()   const {return fDoLocalTransform;  }
   Int_t     GetDefaultDoBHCorrection()     const {return fDoBHCorrection;    }
   Int_t     GetDefaultDoSlotCorrection()   const {return fDoSlotCorrection;  }
   Int_t     GetDefaultDoInterPlaneField()  const {return fDoInterPlaneField; }
   Int_t     GetDefaultDoSMGapAndEndField() const {return fDoSMGapAndEndField;}
   Int_t     GetDefaultUseDCSCoilDir()      const {return fUseDCSCoilDir;     }
   Int_t     GetDefaultUseDCSCurrent()      const {return fUseDCSCurrent;     }
   Int_t     GetDefaultGapLineSrc()         const {return fGapLineSrc;        }

   Int_t     GetDefaultApplyBdotScale()     const {return fApplyBdotScale;    }
   Double_t  GetDefaultZTolerance()         const {return fZTolerance;        }

   Double_t  GetDefaultNoFieldBeyondZ()     const {return fNoFieldBeyondZ;    }

   Int_t     GetForceUseEverywhere()       const {return fForceUseEverywhere; }
   Int_t     GetIgnoreUseEverywhere()      const {return fIgnoreUseEverywhere;}

   void ClearPool(Bool_t cache = true, Bool_t map = false, Bool_t mesh = false);
   void Print(Option_t *option = "") const;

private:
   BfldLoanPool();  // ctor - this is a singleton class make it private
   BfldLoanPool(const BfldLoanPool &bfl); // don't write copy ctor but
                                            // don't let user call it either
   virtual ~BfldLoanPool();
   // Helper class to handle deletion of singleton
   struct Cleaner {
      void ClassIsUsed() { }; // dummy method to keep compilers quiet
      ~Cleaner() {
         if (BfldLoanPool::fgInstance!=0) {
            delete BfldLoanPool::fgInstance;
            BfldLoanPool::fgInstance = 0;
         }
      }
   };
   friend struct Cleaner;

   static BfldLoanPool *fgInstance;        // only copy of self

   // These structures are _owned_ by BfldLoanPool and it is
   // responsible for deleting them as necessary
   // Intially the will be just one, but later one could start
   // managing a list of each if necessary.
   
   TObjArray       fBfldMeshList;
   TObjArray       fBfldMapList;
   TObjArray       fBfldCacheList;
   
   Int_t           fMaxUnrefCaches;

   // various configuration flags pulled from the Configuration
   // to avoid repeated string lookups (unpack on new config)

   Int_t           fInZTest;
   Int_t           fDoLocalTransform;
   Int_t           fDoBHCorrection;
   Int_t           fDoSlotCorrection;
   Int_t           fDoInterPlaneField;
   Int_t           fDoSMGapAndEndField;
   Int_t           fUseDCSCoilDir;
   Int_t           fUseDCSCurrent;
   Int_t           fGapLineSrc;
   Int_t           fApplyBdotScale;

   Double_t        fZTolerance;
   Double_t        fNoFieldBeyondZ;

   Int_t           fForceUseEverywhere;
   Int_t           fIgnoreUseEverywhere;

   ClassDef(BfldLoanPool,4)

};

#endif // BFLDLOANPOOL_H

---