FairField.h

Go to the documentation of this file.

/********************************************************************************
 *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/
// -------------------------------------------------------------------------
// -----                      FairField header file                     -----
// -----                Created 06/01/04  by M. Al-Turany              -----
// -----                Redesign 13/02/06  by V. Friese                -----
// -----                Redesign 04/08/06  by M. Al-Turany               -----
// -------------------------------------------------------------------------

#ifndef FAIRFIELD_H
#define FAIRFIELD_H 1

#include "FairLogger.h"

#include <Rtypes.h>   // for Double_t, Bool_t, etc
#include <TVirtualMagField.h>

class FairField : public TVirtualMagField
{
  public:
    FairField();

    FairField(const char* name, const char* title = "FAIR Magnetic Field");

    FairField& operator=(const FairField&) { return *this; }

    virtual ~FairField();

    virtual void Init(){};

    Bool_t IsConst();

    Bool_t IsMap();

    Int_t GetType() const { return fType; }

    virtual Double_t GetBx(Double_t, Double_t, Double_t)
    {
        LOG(warn) << "FairField::GetBx Should be implemented in User class";
        return 0;
    }

    virtual Double_t GetBy(Double_t, Double_t, Double_t)
    {
        LOG(warn) << "FairField::GetBy Should be implemented in User class";
        return 0;
    }

    virtual Double_t GetBz(Double_t, Double_t, Double_t)
    {
        LOG(warn) << "FairField::GetBz Should be implemented in User class";
        return 0;
    }

    virtual void GetFieldValue(const Double_t point[3], Double_t* bField);

    void Field(const Double_t point[3], Double_t* B) { GetFieldValue(point, B); }

    virtual void Print(Option_t*) const { ; }
    virtual void GetBxyz(const Double_t[3], Double_t*)
    {
        LOG(warn) << "FairField::GetBxyz Should be implemented in User class";
    }

    virtual void FillParContainer() { LOG(warn) << "FairField::FillParContainer Should be implemented in User class"; }

  protected:
    Int_t fType;

  private:
    FairField(const FairField&);
    //    FairField& operator=(const FairField&);
    // TODO: Check why the htrack needs this

    ClassDef(FairField, 4);
};

#endif