#include <G4ParameterisedNavigation.hh>

Inheritance diagram for G4ParameterisedNavigation:

Public Member Functions
	G4ParameterisedNavigation ()

	~G4ParameterisedNavigation () override

G4SmartVoxelNode *	ParamVoxelLocate (G4SmartVoxelHeader *pHead, const G4ThreeVector &localPoint)

G4bool	LevelLocate (G4NavigationHistory &history, const G4VPhysicalVolume blockedVol, const G4int blockedNum, const G4ThreeVector &globalPoint, const G4ThreeVector globalDirection, const G4bool pLocatedOnEdge, G4ThreeVector &localPoint) override

G4double	ComputeStep (const G4ThreeVector &globalPoint, const G4ThreeVector &globalDirection, const G4double currentProposedStepLength, G4double &newSafety, G4NavigationHistory &history, G4bool &validExitNormal, G4ThreeVector &exitNormal, G4bool &exiting, G4bool &entering, G4VPhysicalVolume (pBlockedPhysical), G4int &blockedReplicaNo) override

G4double	ComputeSafety (const G4ThreeVector &localPoint, const G4NavigationHistory &history, const G4double pProposedMaxLength=DBL_MAX) override

void	RelocateWithinVolume (G4VPhysicalVolume *motherPhysical, const G4ThreeVector &localPoint) override

Public Member Functions inherited from G4VoxelNavigation
	G4VoxelNavigation ()

virtual	~G4VoxelNavigation ()

G4SmartVoxelNode *	VoxelLocate (G4SmartVoxelHeader *pHead, const G4ThreeVector &localPoint)

virtual G4int	GetVerboseLevel () const override

virtual void	SetVerboseLevel (G4int level) override

void	EnableBestSafety (G4bool flag=false)

Public Member Functions inherited from G4VNavigation
virtual	~G4VNavigation ()

void	CheckMode (G4bool mode)

Additional Inherited Members
Protected Member Functions inherited from G4VoxelNavigation
G4double	ComputeVoxelSafety (const G4ThreeVector &localPoint) const

G4bool	LocateNextVoxel (const G4ThreeVector &localPoint, const G4ThreeVector &localDirection, const G4double currentStep)

G4SmartVoxelNode *	VoxelLocateLight (G4SmartVoxelHeader *pHead, const G4ThreeVector &localPoint) const

Protected Attributes inherited from G4VoxelNavigation
G4BlockingList	fBList

G4int	fVoxelDepth = -1

std::vector< EAxis >	fVoxelAxisStack

std::vector< G4int >	fVoxelNoSlicesStack

std::vector< G4double >	fVoxelSliceWidthStack

std::vector< G4int >	fVoxelNodeNoStack

std::vector< G4SmartVoxelHeader * >	fVoxelHeaderStack

G4SmartVoxelNode *	fVoxelNode = nullptr

G4VoxelSafety *	fpVoxelSafety = nullptr

G4double	fHalfTolerance

G4bool	fBestSafety = false

G4NavigationLogger *	fLogger

Protected Attributes inherited from G4VNavigation
G4int	fVerbose = 0

G4bool	fCheck = false

Detailed Description

Definition at line 54 of file G4ParameterisedNavigation.hh.

Constructor & Destructor Documentation

◆ G4ParameterisedNavigation()

G4ParameterisedNavigation::G4ParameterisedNavigation ( )

default

◆ ~G4ParameterisedNavigation()

G4ParameterisedNavigation::~G4ParameterisedNavigation ( )

overridedefault

Member Function Documentation

◆ ComputeSafety()

G4double G4ParameterisedNavigation::ComputeSafety	(	const G4ThreeVector &	globalpoint,
		const G4NavigationHistory &	history,
		const G4double	pMaxLength = DBL_MAX )

overridevirtual

Compute the distance to the closest surface.

Parameters

[in]	globalPoint	Global point.
[in]	history	Navigation history.
[in]	pMaxLength	Maximum step length beyond which volumes need not be checked.

Returns: Length from current point to closest surface.

Reimplemented from G4VoxelNavigation.

Definition at line 404 of file G4ParameterisedNavigation.cc.

{
  G4VPhysicalVolume *motherPhysical, *samplePhysical;
  G4VPVParameterisation *sampleParam;
  G4LogicalVolume *motherLogical;
  G4VSolid *motherSolid, *sampleSolid;
  G4double motherSafety, ourSafety;
  G4int sampleNo, curVoxelNodeNo;
 
  G4SmartVoxelNode *curVoxelNode;
  G4long curNoVolumes, contentNo;
  G4double voxelSafety;
 
  // Replication data
  //
  EAxis axis;
  G4int nReplicas;
  G4double width, offset;
  G4bool consuming;
 
  motherPhysical = history.GetTopVolume();
  motherLogical = motherPhysical->GetLogicalVolume();
  motherSolid = motherLogical->GetSolid();
 
  //
  // Compute mother safety
  //
 
  motherSafety = motherSolid->DistanceToOut(localPoint);
  ourSafety = motherSafety;                     // Working isotropic safety
 
  //
  // Compute daughter safeties
  //
 
  // By definition, parameterised volumes exist as first
  // daughter of the mother volume
  //
  samplePhysical = motherLogical->GetDaughter(0);
  samplePhysical->GetReplicationData(axis, nReplicas,
                                     width, offset, consuming);
  sampleParam = samplePhysical->GetParameterisation();
 
  // Look inside the current Voxel only at the current point
  //
  if ( axis==kUndefined )      // 3D case: current voxel node is retrieved
  {                            //          from G4VoxelNavigation.
    curVoxelNode = fVoxelNode;
  }
  else                         // 1D case: current voxel node is computed here.
  {
    curVoxelNodeNo = G4int((localPoint(fVoxelAxis)
                           -fVoxelHeader->GetMinExtent()) / fVoxelSliceWidth );
    curVoxelNode = fVoxelHeader->GetSlice(curVoxelNodeNo)->GetNode();
    fVoxelNodeNo = curVoxelNodeNo;
    fVoxelNode = curVoxelNode;
  }
  curNoVolumes = curVoxelNode->GetNoContained();
 
  for ( contentNo=curNoVolumes-1; contentNo>=0; contentNo-- )
  {
    sampleNo = curVoxelNode->GetVolume((G4int)contentNo);
    
    // Call virtual methods, and copy information if needed
    //
    sampleSolid= IdentifyAndPlaceSolid( sampleNo,samplePhysical,sampleParam ); 
 
    G4AffineTransform sampleTf(samplePhysical->GetRotation(),
                               samplePhysical->GetTranslation());
    sampleTf.Invert();
    const G4ThreeVector samplePoint = sampleTf.TransformPoint(localPoint);
    G4double sampleSafety = sampleSolid->DistanceToIn(samplePoint);
    if ( sampleSafety<ourSafety )
    {
      ourSafety = sampleSafety;
    }
  }
 
  voxelSafety = ComputeVoxelSafety(localPoint,axis);
  if ( voxelSafety<ourSafety )
  {
    ourSafety=voxelSafety;
  }
 
  return ourSafety;
}

Referenced by G4ITNavigator1::ComputeSafety(), G4ITNavigator2::ComputeSafety(), and G4SafetyCalculator::SafetyInCurrentVolume().

◆ ComputeStep()

G4double G4ParameterisedNavigation::ComputeStep	(	const G4ThreeVector &	localPoint,
		const G4ThreeVector &	localDirection,
		const G4double	currentProposedStepLength,
		G4double &	newSafety,
		G4NavigationHistory &	history,
		G4bool &	validExitNormal,
		G4ThreeVector &	exitNormal,
		G4bool &	exiting,
		G4bool &	entering,
		G4VPhysicalVolume **	pBlockedPhysical,
		G4int &	blockedReplicaNo )

overridevirtual

Compute the length of a step to the next boundary. Do not test against pBlockedPhysical. Identify the next candidate volume (if a daughter of current volume), and return it in pBlockedPhysical, blockedReplicaNo.

Parameters

[in]	localPoint	Local point
[in]	localDirection	Pointer to local direction or null pointer.
[in]	currentProposedStepLength	Current proposed step length.
[in,out]	newSafety	New safety.
[in,out]	history	Navigation history.
[in,out]	validExitNormal	Flag to indicate whether exit normal is valid or not.
[in,out]	exitNormal	Exit normal.
[in,out]	entering	Flag to indicate whether we are entering a volume.
[in,out]	exiting	Flag to indicate whether we are exiting a volume.
[in,out]	pBlockedPhysical	Blocked physical volume that should be ignored in queries.
[in,out]	blockedReplicaNo	Copy number for blocked replica volumes.

Returns: Length from current point to next boundary surface along localDirection.

Reimplemented from G4VoxelNavigation.

Definition at line 70 of file G4ParameterisedNavigation.cc.

{
  G4VPhysicalVolume *motherPhysical, *samplePhysical;
  G4VPVParameterisation *sampleParam;
  G4LogicalVolume *motherLogical;
  G4VSolid *motherSolid, *sampleSolid;
  G4ThreeVector sampleDirection;
  G4double ourStep=currentProposedStepLength, ourSafety;
  G4double motherSafety, motherStep = DBL_MAX;
  G4bool motherValidExitNormal = false;
  G4ThreeVector motherExitNormal;
  
  G4int sampleNo;
 
  G4bool initialNode, noStep;
  G4SmartVoxelNode *curVoxelNode;
  G4long curNoVolumes, contentNo;
  G4double voxelSafety;
 
  // Replication data
  //
  EAxis axis;
  G4int nReplicas;
  G4double width, offset;
  G4bool consuming;
 
  motherPhysical = history.GetTopVolume();
  motherLogical = motherPhysical->GetLogicalVolume();
  motherSolid = motherLogical->GetSolid();
 
  //
  // Compute mother safety
  //
 
  motherSafety = motherSolid->DistanceToOut(localPoint);
  ourSafety = motherSafety;              // Working isotropic safety
 
#ifdef G4VERBOSE
  if ( fCheck )
  {
    if( motherSafety < 0.0 )
    {
      motherSolid->DumpInfo();
      std::ostringstream message;
      message << "Negative Safety In Voxel Navigation !" << G4endl
              << "        Current solid " << motherSolid->GetName()
              << " gave negative safety: " << motherSafety << G4endl
              << "        for the current (local) point " << localPoint;
      G4Exception("G4ParameterisedNavigation::ComputeStep()",
                  "GeomNav0003", FatalException, message); 
    }
    if( motherSolid->Inside(localPoint) == kOutside )
    { 
      std::ostringstream message;
      message << "Point is outside Current Volume !" << G4endl
              << "          Point " << localPoint
              << " is outside current volume " << motherPhysical->GetName()
              << G4endl;
      G4double estDistToSolid = motherSolid->DistanceToIn(localPoint); 
      G4cout << "          Estimated isotropic distance to solid (distToIn)= " 
             << estDistToSolid;
      if( estDistToSolid > 100.0 * motherSolid->GetTolerance() )
      {
        motherSolid->DumpInfo();
        G4Exception("G4ParameterisedNavigation::ComputeStep()",
                    "GeomNav0003", FatalException, message,
                    "Point is far outside Current Volume !"); 
      }
      else
      {
        G4Exception("G4ParameterisedNavigation::ComputeStep()",
                    "GeomNav1002", JustWarning, message,
                    "Point is a little outside Current Volume.");
      }
    }
 
    // Compute early:
    //  a) to check whether point is (wrongly) outside
    //               (signaled if step < 0 or step == kInfinity )
    //  b) to check value against answer of daughters!
    //
    motherStep = motherSolid->DistanceToOut(localPoint,
                                            localDirection,
                                            true,
                                           &motherValidExitNormal,
                                           &motherExitNormal);
  
    if( (motherStep >= kInfinity) || (motherStep < 0.0) )
    {
      // Error - indication of being outside solid !!
      //
      fLogger->ReportOutsideMother(localPoint, localDirection, motherPhysical);
 
      ourStep = motherStep = 0.0;
      exiting = true;
      entering = false;
    
      // If we are outside the solid does the normal make sense?
      validExitNormal = motherValidExitNormal;
      exitNormal = motherExitNormal;
    
      *pBlockedPhysical = nullptr; // or motherPhysical ?
      blockedReplicaNo = 0;  // or motherReplicaNumber ?
    
      newSafety = 0.0;
      return ourStep;
    }
  }
#endif
 
  initialNode = true;
  noStep = true;
 
  // By definition, the parameterised volume is the first
  // (and only) daughter of the mother volume
  //
  samplePhysical = motherLogical->GetDaughter(0);
  samplePhysical->GetReplicationData(axis,nReplicas,width,offset,consuming);
  fBList.Enlarge(nReplicas);
  fBList.Reset();
 
  // Exiting normal optimisation
  //
  if (exiting && (*pBlockedPhysical==samplePhysical) && validExitNormal)
  {
    if (localDirection.dot(exitNormal)>=kMinExitingNormalCosine)
    {
      // Block exited daughter replica; Must be on boundary => zero safety
      //
      fBList.BlockVolume(blockedReplicaNo);
      ourSafety = 0;
    }
  }
  exiting = false;
  entering = false;
 
  sampleParam = samplePhysical->GetParameterisation();
 
  // Loop over voxels & compute daughter safeties & intersections
 
  do
  {
    curVoxelNode = fVoxelNode;
    curNoVolumes = curVoxelNode->GetNoContained();
 
    for ( contentNo=curNoVolumes-1; contentNo>=0; contentNo-- )
    {
      sampleNo = curVoxelNode->GetVolume((G4int)contentNo);
      if ( !fBList.IsBlocked(sampleNo) )
      {
        fBList.BlockVolume(sampleNo);
 
        // Call virtual methods, and copy information if needed
        //
        sampleSolid = IdentifyAndPlaceSolid( sampleNo, samplePhysical,
                                             sampleParam ); 
 
        G4AffineTransform sampleTf(samplePhysical->GetRotation(),
                                   samplePhysical->GetTranslation());
        sampleTf.Invert();
        const G4ThreeVector samplePoint = sampleTf.TransformPoint(localPoint);
        const G4double sampleSafety = sampleSolid->DistanceToIn(samplePoint);
        if ( sampleSafety<ourSafety )
        {
          ourSafety = sampleSafety;
        }
        if ( sampleSafety<=ourStep )
        {
          sampleDirection = sampleTf.TransformAxis(localDirection);
          G4double sampleStep =
                   sampleSolid->DistanceToIn(samplePoint, sampleDirection);
          if ( sampleStep<=ourStep )
          {
            ourStep = sampleStep;
            entering = true;
            exiting = false;
            *pBlockedPhysical = samplePhysical;
            blockedReplicaNo = sampleNo;
#ifdef G4VERBOSE
              // Check to see that the resulting point is indeed in/on volume.
              // This check could eventually be made only for successful
              // candidate.
 
              if ( ( fCheck ) && ( sampleStep < kInfinity ) )
              {
                G4ThreeVector intersectionPoint;
                intersectionPoint = samplePoint + sampleStep * sampleDirection;
                EInside insideIntPt = sampleSolid->Inside(intersectionPoint); 
                if( insideIntPt != kSurface )
                {
                  G4long oldcoutPrec = G4cout.precision(16); 
                  std::ostringstream message;
                  message << "Navigator gets conflicting response from Solid."
                          << G4endl
                          << "          Inaccurate solid DistanceToIn"
                          << " for solid " << sampleSolid->GetName() << G4endl
                          << "          Solid gave DistanceToIn = "
                          << sampleStep << " yet returns " ;
                  if( insideIntPt == kInside )
                  {
                    message << "-kInside-"; 
                  }
                  else if( insideIntPt == kOutside )
                  {
                    message << "-kOutside-";
                  }
                  else
                  {
                    message << "-kSurface-"; 
                  }
                  message << " for this point !" << G4endl
                          << "          Point = " << intersectionPoint
                          << G4endl;
                  if ( insideIntPt != kInside )
                  {
                    message << "        DistanceToIn(p) = " 
                            << sampleSolid->DistanceToIn(intersectionPoint);
                  }
                  if ( insideIntPt != kOutside )
                  { 
                    message << "        DistanceToOut(p) = " 
                            << sampleSolid->DistanceToOut(intersectionPoint);
                  }
                  G4Exception("G4ParameterisedNavigation::ComputeStep()", 
                              "GeomNav1002", JustWarning, message);
                  G4cout.precision(oldcoutPrec);
                }
              }
#endif
          }
        }
      }
    }
 
    if ( initialNode )
    {
      initialNode = false;
      voxelSafety = ComputeVoxelSafety(localPoint,axis);
      if ( voxelSafety<ourSafety )
      {
        ourSafety = voxelSafety;
      }
      if ( currentProposedStepLength<ourSafety )
      {
        // Guaranteed physics limited
        //      
        noStep = false;
        entering = false;
        exiting = false;
        *pBlockedPhysical = nullptr;
        ourStep = kInfinity;
      }
      else
      {
        // Consider intersection with mother solid
        //
        if ( motherSafety<=ourStep )
        {
          if ( !fCheck )           
          {
            motherStep = motherSolid->DistanceToOut(localPoint,
                                                   localDirection,
                                                   true,
                                                   &motherValidExitNormal,
                                                   &motherExitNormal);
          }
 
          if( ( motherStep < 0.0 ) || ( motherStep >= kInfinity) )
          {
#ifdef G4VERBOSE
            fLogger->ReportOutsideMother(localPoint, localDirection,
                                         motherPhysical);
#endif
            ourStep = motherStep = 0.0;
            // Rely on the code below to set the remaining state, i.e.
            // exiting, entering,  exitNormal & validExitNormal,
            // pBlockedPhysical etc.
          }
#ifdef G4VERBOSE
          if( motherValidExitNormal && ( fCheck || (motherStep<=ourStep)) )
          {
            fLogger->CheckAndReportBadNormal(motherExitNormal,
                                             localPoint, localDirection,
                                             motherStep, motherSolid,
                                             "From motherSolid::DistanceToOut");
          }
#endif
          if ( motherStep<=ourStep )
          {
            ourStep = motherStep;
            exiting = true;
            entering = false;
            if ( validExitNormal )
            {
              const G4RotationMatrix* rot = motherPhysical->GetRotation();
              if (rot != nullptr)
              {
                exitNormal *= rot->inverse();
              }
            }
          }
          else
          {
            validExitNormal = false;
          }
        }
      }
      newSafety = ourSafety;
    }
    if (noStep)
    {
      noStep = LocateNextVoxel(localPoint, localDirection, ourStep, axis);
    }
  } while (noStep);
 
  return ourStep;
}

Referenced by G4ITNavigator1::ComputeStep(), G4ITNavigator2::ComputeStep(), and G4Navigator::ComputeStep().

◆ LevelLocate()

G4bool G4ParameterisedNavigation::LevelLocate	(	G4NavigationHistory &	history,
		const G4VPhysicalVolume *	blockedVol,
		const G4int	blockedNum,
		const G4ThreeVector &	globalPoint,
		const G4ThreeVector *	globalDirection,
		const G4bool	pLocatedOnEdge,
		G4ThreeVector &	localPoint )

overridevirtual

Search positioned volumes in mother at current top level of history for volume containing globalPoint. Do not test against blockedVol. If a containing volume is found, push it onto navigation history state.

Parameters

[in,out]	history	Navigation history.
[in,out]	blockedVol	Blocked volume that should be ignored in queries.
[in,out]	blockedNum	Copy number for blocked replica volumes.
[in,out]	globalPoint	Global point
[in,out]	globalDirection	Pointer to global direction or null pointer.
[in,out]	localPoint	= global point in local system on entry, point in new system on exit.

Returns: Whether a containing volume has been found.

Reimplemented from G4VoxelNavigation.

Definition at line 610 of file G4ParameterisedNavigation.cc.

{
  G4SmartVoxelHeader *motherVoxelHeader;
  G4SmartVoxelNode *motherVoxelNode;
  G4VPhysicalVolume *motherPhysical, *pPhysical;
  G4VPVParameterisation *pParam;
  G4LogicalVolume *motherLogical;
  G4VSolid *pSolid;
  G4ThreeVector samplePoint;
  G4int voxelNoDaughters, replicaNo;
  
  motherPhysical = history.GetTopVolume();
  motherLogical = motherPhysical->GetLogicalVolume();
  motherVoxelHeader = motherLogical->GetVoxelHeader();
 
  // Find the voxel containing the point
  //
  motherVoxelNode = ParamVoxelLocate(motherVoxelHeader,localPoint);
  
  voxelNoDaughters = (G4int)motherVoxelNode->GetNoContained();
  if ( voxelNoDaughters==0 )  { return false; }
  
  pPhysical = motherLogical->GetDaughter(0);
  pParam = pPhysical->GetParameterisation();
 
  // Save parent history in touchable history
  //   ... for use as parent t-h in ComputeMaterial method of param
  //
  G4TouchableHistory parentTouchable( history ); 
 
  // Search replicated daughter volume
  //
  for ( auto sampleNo=voxelNoDaughters-1; sampleNo>=0; sampleNo-- )
  {
    replicaNo = motherVoxelNode->GetVolume(sampleNo);
    if ( (replicaNo!=blockedNum) || (pPhysical!=blockedVol) )
    {
      // Obtain solid (as it can vary) and obtain its parameters
      //
      pSolid = IdentifyAndPlaceSolid( replicaNo, pPhysical, pParam ); 
 
      // Setup history
      //
      history.NewLevel(pPhysical, kParameterised, replicaNo);
      samplePoint = history.GetTopTransform().TransformPoint(globalPoint);
      if ( !G4AuxiliaryNavServices::CheckPointOnSurface( pSolid, samplePoint,
            globalDirection, history.GetTopTransform(), pLocatedOnEdge) )
      {
        history.BackLevel();
      }
      else
      { 
        // Enter this daughter
        //
        localPoint = samplePoint;
        
        // Set the correct copy number in physical
        //
        pPhysical->SetCopyNo(replicaNo);
        
        // Set the correct solid and material in Logical Volume
        //
        G4LogicalVolume *pLogical = pPhysical->GetLogicalVolume();
        pLogical->SetSolid(pSolid);
        pLogical->UpdateMaterial(pParam->ComputeMaterial(replicaNo,
                                 pPhysical, &parentTouchable)  );
        return true;
      }
    }
  }
  return false;
}

Referenced by G4ITNavigator1::LocateGlobalPointAndSetup(), G4ITNavigator2::LocateGlobalPointAndSetup(), and G4Navigator::LocateGlobalPointAndSetup().

◆ ParamVoxelLocate()

G4SmartVoxelNode * G4ParameterisedNavigation::ParamVoxelLocate	(	G4SmartVoxelHeader *	pHead,
		const G4ThreeVector &	localPoint )

inline

Referenced by LevelLocate(), G4ITNavigator1::LocateGlobalPointWithinVolume(), G4ITNavigator2::LocateGlobalPointWithinVolume(), G4SafetyCalculator::QuickLocateWithinVolume(), and RelocateWithinVolume().

◆ RelocateWithinVolume()

void G4ParameterisedNavigation::RelocateWithinVolume	(	G4VPhysicalVolume *	,
		const G4ThreeVector &	)

overridevirtual

Update internal navigation state to take into account that location has been moved, but remains within the motherPhysical volume.

Parameters

[in]	motherPhysical	Current physical volume.
[in]	localPoint	Local point.

Reimplemented from G4VoxelNavigation.

Definition at line 689 of file G4ParameterisedNavigation.cc.

{
  auto motherLogical = motherPhysical->GetLogicalVolume();
 
  /* this should only be called on parameterized volumes, which always satisfy the conditions below */
  assert(motherPhysical->GetRegularStructureId() != 1);
  assert(motherLogical->GetNoDaughters() == 1);
 
  if ( auto pVoxelHeader = motherLogical->GetVoxelHeader() )
    ParamVoxelLocate( pVoxelHeader, localPoint );
}

Referenced by G4Navigator::LocateGlobalPointWithinVolume().

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4ParameterisedNavigation()

◆ ~G4ParameterisedNavigation()

Member Function Documentation

◆ ComputeSafety()

◆ ComputeStep()

◆ LevelLocate()

◆ ParamVoxelLocate()

◆ RelocateWithinVolume()