BDSInterpolator3D.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSINTERPOLATOR3D_H
#define BDSINTERPOLATOR3D_H
#include "BDSArray3DCoords.hh"
#include "BDSDimensionType.hh"
#include "BDSExtent.hh"
#include "BDSFieldValue.hh"
#include "BDSInterpolator.hh"
 
#include "G4Types.hh"
#include "G4ThreeVector.hh"
 
class BDSInterpolator3D: public BDSInterpolator
{
public:
  BDSInterpolator3D() = delete;
  explicit BDSInterpolator3D(BDSArray3DCoords* arrayIn);
  virtual ~BDSInterpolator3D(){;}
 
  G4ThreeVector GetInterpolatedValue(G4double x, G4double y, G4double z) const;
 
  inline const BDSArray3DCoords* Array() const {return array;}
 
  inline BDSDimensionType FirstDimension() const {return array->FirstDimension();}
 
  inline BDSDimensionType SecondDimension() const {return array->SecondDimension();}
 
  inline BDSDimensionType ThirdDimension() const {return array->ThirdDimension();}
  
  virtual BDSExtent Extent() const {return array->Extent();}
  
  virtual G4bool TimeVarying() const {return array->TimeVarying();}
  
protected:
  virtual BDSFieldValue GetInterpolatedValueT(G4double x, G4double y, G4double z) const = 0;
 
  BDSArray3DCoords* array;
};
 
#endif