//
// ********************************************************************
// * DISCLAIMER                                                       *
// *                                                                  *
// * The following disclaimer summarizes all the specific disclaimers *
// * of contributors to this software. The specific disclaimers,which *
// * govern, are listed with their locations in:                      *
// *   http://cern.ch/geant4/license                                  *
// *                                                                  *
// * 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.                                                             *
// *                                                                  *
// * This  code  implementation is the  intellectual property  of the *
// * GEANT4 collaboration.                                            *
// * By copying,  distributing  or modifying the Program (or any work *
// * based  on  the Program)  you indicate  your  acceptance of  this *
// * statement, and all its terms.                                    *
// ********************************************************************
//
//
// $Id: G4ReplicaNavigation.icc,v 1.8 2003/04/02 14:28:04 gcosmo Exp $
// GEANT4 tag $Name: geant4-05-01 $
//
// 
// class G4ReplicaNavigation Inline implementation
// ********************************************************************

// ********************************************************************
// VoxelLocate
// ********************************************************************
//
inline
G4int
G4ReplicaNavigation::VoxelLocate( const G4SmartVoxelHeader* pHead,
                                  const G4ThreeVector& localPoint,
                                  const G4int blocked ) const
{
  EAxis targetHeaderAxis;
  G4double coord=0.;
  G4double targetHeaderMin, targetHeaderMax;
  G4double targetHeaderNodeWidth, targetNodePos;
  G4int targetHeaderNoSlices, targetNodeNo;
  
  targetHeaderAxis = pHead->GetAxis();
  targetHeaderNoSlices = pHead->GetNoSlices();
  targetHeaderMin = pHead->GetMinExtent();
  targetHeaderMax = pHead->GetMaxExtent();
  targetHeaderNodeWidth = ( targetHeaderMax-targetHeaderMin )
                          / targetHeaderNoSlices;

  switch (targetHeaderAxis)
  {
    case kXAxis:
      coord = localPoint.x();
      break;
    case kYAxis:
      coord = localPoint.y();
      break;
    case kZAxis:
      coord = localPoint.z();
      break;
    case kRho:
      coord = localPoint.perp();
      break;
    case kPhi:
      coord = localPoint.phi();
      if ( (coord<0) && (coord<targetHeaderMin) ) coord += 2.0*M_PI;
      break;
    case kRadial3D:
    default:
      break;
  }
  targetNodePos = (coord-targetHeaderMin)/targetHeaderNodeWidth;
  targetNodeNo = (G4int) targetNodePos;

  if ( targetNodeNo==blocked )
  {
    targetNodeNo = (targetNodePos-targetNodeNo<0.5)
                   ? targetNodeNo-1 : targetNodeNo+1;
      
    // Do not need to check range: If on outer edge of zeroth
    // voxel & it is blocked => should have exited mother
    // (or similar)       P.Kent
    // assert(targetNodeNo>=0&&targetNodeNo<targetHeaderNoSlices);
    //
    // The assert above fails for simulation of high energy electrons 
    // It is not clear what is the cause for this failure.
    // The code below attempts to rectify this problem until a
    // complete resolution is possible.    
    //           J.Apostolakis, June 12, 1998

    if( (targetNodeNo<0) || (targetNodeNo>=targetHeaderNoSlices) )
    {

#ifdef G4DEBUG_NAVIGATION
      G4cerr << " WARNING: assert in G4ReplicaNavigation::VoxelLocate " 
             << " has failed : " << G4endl
             << " (targetNodeNo>=0&&targetNodeNo<targetHeaderNoSlices) " 
             << " targetNodeNo= " << targetNodeNo 
             << " Number of Slices =  " << targetHeaderNoSlices << G4endl;
#endif
      // In the case of rotational symmetry and an extent over the
      // whole 360 degrees, the above is not true and you can go from
      // the last voxel to the zeroth and vice versa
      //                                        H.Boie, April 30, 2001  
      if ( (targetHeaderAxis==kPhi)
           && (targetHeaderMin==0) && (targetHeaderMax==2*M_PI) )
      {
        if ( targetNodeNo<0 ) 
          targetNodeNo = targetHeaderNoSlices-1;
        else if ( targetNodeNo>=targetHeaderNoSlices )
          targetNodeNo = 0;
      }
      else 
      {
        if( targetNodeNo<0 )
          targetNodeNo = 0;
        else if ( targetNodeNo>=targetHeaderNoSlices )
          targetNodeNo = targetHeaderNoSlices-1;
      }
    }
  }
  else
  {
    // Rounding protection
    //
    if ( targetNodeNo<0 )
    {
      targetNodeNo = 0;
    }
    else if ( targetNodeNo>=targetHeaderNoSlices )
    {
      targetNodeNo = targetHeaderNoSlices-1;
    }
  }
  return targetNodeNo;
}

// ********************************************************************
// LevelLocate
// ********************************************************************
//
inline
G4bool
G4ReplicaNavigation::LevelLocate( G4NavigationHistory& history,
                            const G4VPhysicalVolume* blockedVol,
                            const G4int              blockedNum,
                            const G4ThreeVector&,     // globalPoint
                            const G4ThreeVector*,     // globalDirection
                            const G4bool,             // pLocatedOnEdge
                                  G4ThreeVector& localPoint )
{
  G4VPhysicalVolume *motherPhysical, *pPhysical;
  G4LogicalVolume *motherLogical;
  G4SmartVoxelHeader *motherVoxelHeader;
  G4int nodeNo;

  motherPhysical = history.GetTopVolume();
  motherLogical = motherPhysical->GetLogicalVolume();
  motherVoxelHeader = motherLogical->GetVoxelHeader();
  pPhysical = motherLogical->GetDaughter(0);

  if ( blockedVol==pPhysical )
  {
    nodeNo = VoxelLocate(motherVoxelHeader, localPoint, blockedNum);
  }
  else
  {
    nodeNo = VoxelLocate(motherVoxelHeader, localPoint);
  }

  ComputeTransformation(nodeNo, pPhysical, localPoint);
  pPhysical->Setup(motherPhysical);
  history.NewLevel(pPhysical, kReplica, nodeNo);
  pPhysical->SetCopyNo(nodeNo); 

  return true;
}

// ********************************************************************
// SetPhiTransformation
// ********************************************************************
//
inline
void
G4ReplicaNavigation::SetPhiTransformation( const G4double ang,
                                                 G4VPhysicalVolume* pVol ) const
{
  G4RotationMatrix rm;
  rm.rotateZ(ang);
  if ( pVol )
    *pVol->GetRotation() = rm;
}