BDSArray4D.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 BDSARRAY4D_H
#define BDSARRAY4D_H
 
#include "BDSFieldValue.hh"
#include "BDSFourVector.hh"
 
#include <ostream>
#include <vector>
 
class BDSArray4D
{
public:
  BDSArray4D() = delete;
  BDSArray4D(G4int nXIn, G4int nYIn, G4int nZIn, G4int nTIn);
  virtual ~BDSArray4D(){;}
 
  inline G4int NX() const {return nX;}
  inline G4int NY() const {return nY;}
  inline G4int NZ() const {return nZ;}
  inline G4int NT() const {return nT;}
  inline BDSFourVector<G4int> NXYZT() const {return BDSFourVector<G4int>(NX(), NY(), NZ(), NT());}
 
  virtual BDSFieldValue& operator()(G4int x,
                                    G4int y = 0,
                                    G4int z = 0,
                                    G4int t = 0);
 
  const BDSFieldValue& operator()(BDSFourVector<G4int>& pos)
  {return operator()(pos.x(), pos.y(), pos.z(), pos.t());}
 
  virtual const BDSFieldValue& GetConst(G4int x,
                                        G4int y = 0,
                                        G4int z = 0,
                                        G4int t = 0) const;
 
  virtual const BDSFieldValue& operator()(G4int x,
                                          G4int y = 0,
                                          G4int z = 0,
                                          G4int t = 0) const;
 
  const BDSFieldValue& operator()(const BDSFourVector<G4int>& pos) const
  {return operator()(pos.x(), pos.y(), pos.z(), pos.t());}
 
  virtual G4bool Outside(G4int x,
                         G4int y,
                         G4int z,
                         G4int t) const;
 
  virtual void OutsideWarn(G4int x,
                           G4int y,
                           G4int z,
                           G4int t) const;
 
  virtual std::ostream& Print(std::ostream& out) const;
  
  friend std::ostream& operator<< (std::ostream& out, BDSArray4D const &a);
 
protected:
  
  const G4int nX;
  const G4int nY;
  const G4int nZ;
  const G4int nT;
 
  BDSFieldValue defaultValue;
  
private:
  std::vector<BDSFieldValue> data;
};
 
#endif