G4PartialPhantomParameterisation.hh

Go to the documentation of this file.

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// G4PartialPhantomParameterisation
//
// Class description:
// 
// Describes partial regular parameterisations, i.e. the voxels do not 
// completely fill the container in the three dimensions.
 
// Author: Pedro Arce (CIEMAT), September 2010
// --------------------------------------------------------------------
#ifndef G4PartialPhantomParameterisation_hh
#define G4PartialPhantomParameterisation_hh 1
 
#include <map>
#include <set>
#include <utility>
#include <vector>
 
#include "G4Types.hh"
#include "G4PhantomParameterisation.hh"
#include "G4AffineTransform.hh"
#include "G4VTouchable.hh"
 
class G4VPhysicalVolume;
class G4VSolid;
class G4Material;
 
/**
 * @brief G4PartialPhantomParameterisation describes partial regular
 * parameterisations, i.e. the voxels do not completely fill the container
 * in the three dimensions.
 */
 
class G4PartialPhantomParameterisation : public G4PhantomParameterisation
{
  public:
 
    /**
     * Default Constructor and Destructor.
     */
    G4PartialPhantomParameterisation() = default;
   ~G4PartialPhantomParameterisation() override = default;
 
    void ComputeTransformation(const G4int, G4VPhysicalVolume *) const override;
  
    G4Material* ComputeMaterial(const G4int repNo, 
                                      G4VPhysicalVolume *currentVol,
                                const G4VTouchable *parentTouch = nullptr) override;
 
    /**
     * Gets the voxel number corresponding to the point in the container
     * frame. Use 'localDir' to avoid precision problems at the surfaces.
     *  @param[in] localPoint Point in local coordinates system.
     *  @param[in] localDir Local direction to overcome precision issues.
     *  @returns The voxel number for the specified point.
     */
    G4int GetReplicaNo( const G4ThreeVector& localPoint,
                        const G4ThreeVector& localDir ) override;
 
    G4ThreeVector GetTranslation(const G4int copyNo ) const;
 
    std::size_t GetMaterialIndex( std::size_t nx, std::size_t ny, std::size_t nz) const;
    std::size_t GetMaterialIndex( std::size_t copyNo) const;
 
    G4Material* GetMaterial( std::size_t nx, std::size_t ny, std::size_t nz) const;
    G4Material* GetMaterial( std::size_t copyNo ) const;
 
    inline void SetFilledIDs( std::multimap<G4int,G4int> fid )
    {
      fFilledIDs = std::move(fid); 
    }
 
    inline void SetFilledMins( std::map< G4int, std::map<G4int,G4int> > fmins )
    {
      fFilledMins = std::move(fmins);
    }
 
    void BuildContainerWalls();
 
  private:
 
    /**
     * Converts the copyNo to voxel numbers in x, y and z.
     */
    void ComputeVoxelIndices(const G4int copyNo, std::size_t& nx,
                                   std::size_t& ny, std::size_t& nz ) const;
 
    /**
     * Checks that the copy number is within limits.
     */
    void CheckCopyNo( const G4long copyNo ) const;
 
  private:
 
    std::multimap<G4int,G4int> fFilledIDs;
    std::map< G4int, std::map<G4int,G4int> > fFilledMins;
};
 
#endif