G4VCurvedTrajectoryFilter defines a filter for deciding which intermediate points on a curved trajectory merit being stored. It defines the compromise between accuracy of representation of the curved trajectory and memory use. Derived classes should implement the filtering algorithm. More...

#include <G4VCurvedTrajectoryFilter.hh>

Inheritance diagram for G4VCurvedTrajectoryFilter:

Public Member Functions
	G4VCurvedTrajectoryFilter ()=default
virtual	~G4VCurvedTrajectoryFilter ()=default
void	CreateNewTrajectorySegment ()
virtual void	TakeIntermediatePoint (G4ThreeVector newPoint)=0
std::vector< G4ThreeVector > *	GimmeThePointsAndForgetThem ()

Protected Attributes
std::vector< G4ThreeVector > *	fpFilteredPoints = nullptr

Detailed Description

G4VCurvedTrajectoryFilter defines a filter for deciding which intermediate points on a curved trajectory merit being stored. It defines the compromise between accuracy of representation of the curved trajectory and memory use. Derived classes should implement the filtering algorithm.

Definition at line 57 of file G4VCurvedTrajectoryFilter.hh.

Constructor & Destructor Documentation

◆ G4VCurvedTrajectoryFilter()

G4VCurvedTrajectoryFilter::G4VCurvedTrajectoryFilter ( )

default

Default Constructor & Destructor.

◆ ~G4VCurvedTrajectoryFilter()

virtual G4VCurvedTrajectoryFilter::~G4VCurvedTrajectoryFilter ( )

virtualdefault

Member Function Documentation

◆ CreateNewTrajectorySegment()

void G4VCurvedTrajectoryFilter::CreateNewTrajectorySegment ( )

Each segment stores the auxiliary points of a single step.

Definition at line 50 of file G4VCurvedTrajectoryFilter.cc.

{
  if (fpFilteredPoints != nullptr)
  {
    // GimmePoints has not been called (it would have set the
    // pointer to nullptr), therefore nobody has taken charge of the
    // points and they will never be deleted!
    G4cout << "!!!!!!!! Filter: auxiliary points are being memory leaked !!!!!"
           << G4endl;
  }
  fpFilteredPoints = new std::vector<G4ThreeVector>;
}    

◆ GimmeThePointsAndForgetThem()

std::vector< G4ThreeVector > * G4VCurvedTrajectoryFilter::GimmeThePointsAndForgetThem ( )

Returns the vector of points, transferring the ownership.

Definition at line 34 of file G4VCurvedTrajectoryFilter.cc.

{
  std::vector<G4ThreeVector>* tmp = fpFilteredPoints;
  // ParticleChangeForTransport invokes this method (via
  // PropagatorInField) at every Step, even if the step did not
  // involve PropagatorInField. Must, therefore, ensure that points
  // submitted by previous invocations of PIF are not
  // copied. Therefore the points must be cleared. (Note that the
  // responsibility for deleting the vector lies with the
  // SmoothTrajctoryPoint, which is the vector's final destination.)
  // (jacek 08/11/2002)
  fpFilteredPoints = nullptr;
  return tmp;
}

◆ TakeIntermediatePoint()

virtual void G4VCurvedTrajectoryFilter::TakeIntermediatePoint ( G4ThreeVector newPoint )

pure virtual

Submits intermediate points for the filter to consider keeping or rejecting. Derived classes should implement the filtering algorithm in this method.

Implemented in G4IdentityTrajectoryFilter.

Member Data Documentation

◆ fpFilteredPoints

std::vector<G4ThreeVector>* G4VCurvedTrajectoryFilter::fpFilteredPoints = nullptr

protected

Definition at line 89 of file G4VCurvedTrajectoryFilter.hh.

Referenced by CreateNewTrajectorySegment(), GimmeThePointsAndForgetThem(), and G4IdentityTrajectoryFilter::TakeIntermediatePoint().

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

Public Member Functions

Protected Attributes