G4PhysicsFreeVector.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4PhysicsFreeVector.hh

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
//
// 
//--------------------------------------------------------------------
//      GEANT 4 class header file
//
//  G4PhysicsFreeVector.hh
//
//  Class description:
//
//    A physics vector which has values of energy-loss, cross-section, 
//    and other physics values of a particle in matter in a given 
//    range of the energy, momentum, etc. The scale of energy/momentum
//    bins is in free, ie. it is NOT need to be linear or log. Only 
//    restrication is that bin values alway have to increase from
//    a lower bin to a higher bin. This is necessary for the binary
//    search to work correctly.

//  History:
//    02 Dec. 1995, G.Cosmo : Structure created based on object model
//    06 Jun. 1996, K.Amako : Implemented the 1st version
//    01 Jul. 1996, K.Amako : Cache mechanism and hidden bin from the 
//                            user introduced
//    26 Sep. 1996, K.Amako : Constructor with only 'bin size' added
//    11 Nov. 2000, H.Kurashige : Use STL vector for dataVector and binVector
//    02 Oct. 2013  V.Ivanchenko : Remove FindBinLocation method
//
//--------------------------------------------------------------------

#ifndef G4PhysicsFreeVector_h
#define G4PhysicsFreeVector_h 1

#include "globals.hh"
#include "G4PhysicsVector.hh"
#include "G4DataVector.hh"

class G4PhysicsFreeVector : public G4PhysicsVector  
{
public: // with description

  G4PhysicsFreeVector();
  // the vector will be filled from external file using Retrieve method

  explicit G4PhysicsFreeVector(size_t length);
  // the vector with 'length' elements will be filled using PutValue method 
  // by default the vector is initialized with zeros

  G4PhysicsFreeVector(const G4DataVector& eVector, 
          const G4DataVector& dataVector);
  // the vector is filled in this constructor 
  // 'eVector' and 'dataVector' need to have the same vector length
  // 'eVector' assumed to be ordered
  
  virtual ~G4PhysicsFreeVector();

  inline void PutValue(size_t index, G4double energy, G4double dataValue);   
  // user code is responsible for correct filling of all elements
};

inline
void G4PhysicsFreeVector::PutValue(size_t index, G4double e, G4double value)
{
  if(index >= numberOfNodes) { PrintPutValueError(index); }
  binVector[index] = e;
  dataVector[index] = value;
  if(index == 0)                       { edgeMin = e; }
  else if( numberOfNodes - 1 == index) { edgeMax = e; }
}

#endif