G4LineSection Class Reference

G4LineSection is a utility class that calculates the distance of a point from a line section. More...

#include <G4LineSection.hh>

Public Member Functions
	G4LineSection (const G4ThreeVector &PntA, const G4ThreeVector &PntB)
	~G4LineSection ()=default
G4double	Dist (const G4ThreeVector &OtherPnt) const
G4double	GetABdistanceSq () const

Static Public Member Functions
static G4double	Distline (const G4ThreeVector &OtherPnt, const G4ThreeVector &LinePntA, const G4ThreeVector &LinePntB)

Detailed Description

G4LineSection is a utility class that calculates the distance of a point from a line section.

Definition at line 47 of file G4LineSection.hh.

Constructor & Destructor Documentation

G4LineSection()

G4LineSection::G4LineSection	(	const G4ThreeVector &	PntA,
		const G4ThreeVector &	PntB )

Constructor for G4LineSection.

Parameters

[in]	PntA	Coordinates of point A defining the line.
[in]	PntB	Coordinates of point B defining the line.

Definition at line 33 of file G4LineSection.cc.

  : EndpointA(PntA), VecAtoB(PntB-PntA)
{ 
  fABdistanceSq = VecAtoB.mag2();  
}

Referenced by Distline().

~G4LineSection()

G4LineSection::~G4LineSection ( )

default

Default Destructor.

Member Function Documentation

Dist()

G4double G4LineSection::Dist

(

const G4ThreeVector &

OtherPnt

)

const

Returns the distance of point 'OtherPnt' from the line.

Definition at line 40 of file G4LineSection.cc.

{
  G4double       dist_sq;  
  G4ThreeVector  VecAZ;
  G4double sq_VecAZ, inner_prod, unit_projection ; 
 
  VecAZ= OtherPnt - EndpointA;
  sq_VecAZ = VecAZ.mag2();
 
  inner_prod= VecAtoB.dot( VecAZ );
   
  //  Determine  Projection(AZ on AB) / Length(AB) 
  //
  if( fABdistanceSq != 0.0 )
  {
    //  unit_projection= inner_prod * InvsqDistAB();
    unit_projection = inner_prod/fABdistanceSq;
 
    if( (0. <= unit_projection ) && (unit_projection <= 1.0 ) )
    {
      dist_sq= sq_VecAZ -  unit_projection * inner_prod ;
    }
    else
    {
     //  The perpendicular from the point to the line AB meets the line
     //   in a point outside the line segment!
     
      if( unit_projection < 0. ) // A is the closest point
      {
        dist_sq= sq_VecAZ;  
      }
      else                       // B is the closest point
      {
        G4ThreeVector   EndpointB = EndpointA + VecAtoB;
        G4ThreeVector   VecBZ =     OtherPnt - EndpointB;
        dist_sq =  VecBZ.mag2();
      }
    }
  }
  else
  {
     dist_sq = (OtherPnt - EndpointA).mag2() ;   
  }  
  if( dist_sq < 0.0 )
  {
    dist_sq = 0.0 ;
  }
 
  return std::sqrt(dist_sq) ;  
}

Referenced by Distline().

Distline()

G4double G4LineSection::Distline ( const G4ThreeVector & OtherPnt, const G4ThreeVector & LinePntA, const G4ThreeVector & LinePntB )

inlinestatic

Defines line and returns the distance of point 'OtherPnt' from it.

Definition at line 96 of file G4LineSection.hh.

{
  G4LineSection LineAB( LinePntA, LinePntB );  // Line from A to B
  return LineAB.Dist( OtherPnt );
}

Referenced by G4BogackiShampine23::DistChord(), G4BogackiShampine45::DistChord(), G4CashKarpRKF45::DistChord(), G4ConstRK4::DistChord(), G4DoLoMcPriRK34::DistChord(), G4DormandPrince745::DistChord(), G4DormandPrinceRK56::DistChord(), G4DormandPrinceRK78::DistChord(), G4FSALBogackiShampine45::DistChord(), G4FSALDormandPrince745::DistChord(), G4MagErrorStepper::DistChord(), G4NystromRK4::DistChord(), G4RK547FEq1::DistChord(), G4RK547FEq2::DistChord(), G4RK547FEq3::DistChord(), G4RKG3_Stepper::DistChord(), G4TCashKarpRKF45< T_Equation, N >::DistChord(), G4TDormandPrince45< T_Equation, N >::DistChord(), G4TMagErrorStepper< T_Stepper, T_Equation, N >::DistChord(), G4TsitourasRK45::DistChord(), and G4BorisDriver::QuickAdvance().

GetABdistanceSq()

G4double G4LineSection::GetABdistanceSq ( ) const

inline

Returns the distance squared.

Definition at line 90 of file G4LineSection.hh.

{
  return fABdistanceSq;
}

---

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

• G4LineSection.hh
• G4LineSection.cc