G4AdjointCrossSurfChecker Class Reference

#include <G4AdjointCrossSurfChecker.hh>

Public Member Functions
G4bool	CrossingASphere (const G4Step *aStep, G4double sphere_radius, G4ThreeVector sphere_center, G4ThreeVector &cross_pos, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	GoingInOrOutOfaVolume (const G4Step *aStep, const G4String &volume_name, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	GoingInOrOutOfaVolumeByExtSurface (const G4Step *aStep, const G4String &volume_name, const G4String &mother_lvol_name, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	CrossingAGivenRegisteredSurface (const G4Step *aStep, const G4String &surface_name, G4ThreeVector &cross_pos, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	CrossingAGivenRegisteredSurface (const G4Step *aStep, G4int ind, G4ThreeVector &cross_pos, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	CrossingOneOfTheRegisteredSurface (const G4Step *aStep, G4String &surface_name, G4ThreeVector &cross_pos, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	CrossingAnInterfaceBetweenTwoVolumes (const G4Step *aStep, const G4String &vol1_name, const G4String &vol2_name, G4ThreeVector &cross_pos, G4double &cos_to_surface, G4bool &GoingIn)
G4bool	AddaSphericalSurface (const G4String &SurfaceName, G4double radius, G4ThreeVector pos, G4double &area)
G4bool	AddaSphericalSurfaceWithCenterAtTheCenterOfAVolume (const G4String &SurfaceName, G4double radius, const G4String &volume_name, G4ThreeVector &center, G4double &area)
G4bool	AddanExtSurfaceOfAvolume (const G4String &SurfaceName, const G4String &volume_name, G4double &area)
G4bool	AddanInterfaceBetweenTwoVolumes (const G4String &SurfaceName, const G4String &volume_name1, const G4String &volume_name2, G4double &area)
void	ClearListOfSelectedSurface ()

Static Public Member Functions
static G4AdjointCrossSurfChecker *	GetInstance ()

Detailed Description

Definition at line 51 of file G4AdjointCrossSurfChecker.hh.

Member Function Documentation

AddanExtSurfaceOfAvolume()

G4bool G4AdjointCrossSurfChecker::AddanExtSurfaceOfAvolume	(	const G4String &	SurfaceName,
		const G4String &	volume_name,
		G4double &	area )

Definition at line 309 of file G4AdjointCrossSurfChecker.cc.

{
  G4int ind = FindRegisteredSurface(SurfaceName);
 
  G4VPhysicalVolume* thePhysicalVolume = nullptr;
  G4PhysicalVolumeStore* thePhysVolStore = G4PhysicalVolumeStore::GetInstance();
  thePhysicalVolume = thePhysVolStore->GetVolume(volume_name);
  if (thePhysicalVolume == nullptr) {
    return false;
  }
  Area = thePhysicalVolume->GetLogicalVolume()->GetSolid()->GetSurfaceArea();
  G4String mother_vol_name = "";
  G4LogicalVolume* theMother = thePhysicalVolume->GetMotherLogical();
 
  if (theMother != nullptr) mother_vol_name = theMother->GetName();
  if (ind >= 0) {
    ListOfSurfaceType[ind] = "ExternalSurfaceOfAVolume";
    ListOfSphereRadius[ind] = 0.;
    ListOfSphereCenter[ind] = G4ThreeVector(0., 0., 0.);
    ListOfVol1Name[ind] = volume_name;
    ListOfVol2Name[ind] = mother_vol_name;
    AreaOfSurface[ind] = Area;
  }
  else {
    ListOfSurfaceName.push_back(SurfaceName);
    ListOfSurfaceType.emplace_back("ExternalSurfaceOfAVolume");
    ListOfSphereRadius.push_back(0.);
    ListOfSphereCenter.emplace_back(0., 0., 0.);
    ListOfVol1Name.push_back(volume_name);
    ListOfVol2Name.push_back(mother_vol_name);
    AreaOfSurface.push_back(Area);
  }
  return true;
}

Referenced by G4AdjointSimManager::DefineAdjointSourceOnTheExtSurfaceOfAVolume(), and G4AdjointSimManager::DefineExtSourceOnTheExtSurfaceOfAVolume().

AddanInterfaceBetweenTwoVolumes()

G4bool G4AdjointCrossSurfChecker::AddanInterfaceBetweenTwoVolumes	(	const G4String &	SurfaceName,
		const G4String &	volume_name1,
		const G4String &	volume_name2,
		G4double &	area )

Definition at line 347 of file G4AdjointCrossSurfChecker.cc.

{
  G4int ind = FindRegisteredSurface(SurfaceName);
  Area = -1.;  // the way to compute the surface is not known yet
  if (ind >= 0) {
    ListOfSurfaceType[ind] = "BoundaryBetweenTwoVolumes";
    ListOfSphereRadius[ind] = 0.;
    ListOfSphereCenter[ind] = G4ThreeVector(0., 0., 0.);
    ListOfVol1Name[ind] = volume_name1;
    ListOfVol2Name[ind] = volume_name2;
    AreaOfSurface[ind] = Area;
  }
  else {
    ListOfSurfaceName.push_back(SurfaceName);
    ListOfSurfaceType.emplace_back("BoundaryBetweenTwoVolumes");
    ListOfSphereRadius.push_back(0.);
    ListOfSphereCenter.emplace_back(0., 0., 0.);
    ListOfVol1Name.push_back(volume_name1);
    ListOfVol2Name.push_back(volume_name2);
    AreaOfSurface.push_back(Area);
  }
  return true;
}

AddaSphericalSurface()

G4bool G4AdjointCrossSurfChecker::AddaSphericalSurface	(	const G4String &	SurfaceName,
		G4double	radius,
		G4ThreeVector	pos,
		G4double &	area )

Definition at line 248 of file G4AdjointCrossSurfChecker.cc.

{
  G4int ind = FindRegisteredSurface(SurfaceName);
  Area = 4. * pi * radius * radius;
  if (ind >= 0) {
    ListOfSurfaceType[ind] = "Sphere";
    ListOfSphereRadius[ind] = radius;
    ListOfSphereCenter[ind] = pos;
    ListOfVol1Name[ind] = "";
    ListOfVol2Name[ind] = "";
    AreaOfSurface[ind] = Area;
  }
  else {
    ListOfSurfaceName.push_back(SurfaceName);
    ListOfSurfaceType.emplace_back("Sphere");
    ListOfSphereRadius.push_back(radius);
    ListOfSphereCenter.push_back(pos);
    ListOfVol1Name.emplace_back("");
    ListOfVol2Name.emplace_back("");
    AreaOfSurface.push_back(Area);
  }
  return true;
}

Referenced by AddaSphericalSurfaceWithCenterAtTheCenterOfAVolume(), G4AdjointSimManager::DefineSphericalAdjointSource(), and G4AdjointSimManager::DefineSphericalExtSource().

AddaSphericalSurfaceWithCenterAtTheCenterOfAVolume()

G4bool G4AdjointCrossSurfChecker::AddaSphericalSurfaceWithCenterAtTheCenterOfAVolume	(	const G4String &	SurfaceName,
		G4double	radius,
		const G4String &	volume_name,
		G4ThreeVector &	center,
		G4double &	area )

Definition at line 275 of file G4AdjointCrossSurfChecker.cc.

{
  G4VPhysicalVolume* thePhysicalVolume = nullptr;
  G4PhysicalVolumeStore* thePhysVolStore = G4PhysicalVolumeStore::GetInstance();
  thePhysicalVolume = thePhysVolStore->GetVolume(volume_name);
  if (thePhysicalVolume != nullptr) {
    G4VPhysicalVolume* daughter = thePhysicalVolume;
    G4LogicalVolume* mother = thePhysicalVolume->GetMotherLogical();
    G4AffineTransform theTransformationFromPhysVolToWorld = G4AffineTransform();
    while (mother != nullptr) {
      theTransformationFromPhysVolToWorld *=
        G4AffineTransform(daughter->GetFrameRotation(), daughter->GetObjectTranslation());
      for (std::size_t i = 0; i < thePhysVolStore->size(); ++i) {
        if ((*thePhysVolStore)[i]->GetLogicalVolume() == mother) {
          daughter = (*thePhysVolStore)[i];
          mother = daughter->GetMotherLogical();
          break;
        }
      }
    }
    center = theTransformationFromPhysVolToWorld.NetTranslation();
    G4cout << "Center of the spherical surface is at the position: " << center / cm << " cm"
           << G4endl;
  }
  else {
    return false;
  }
  return AddaSphericalSurface(SurfaceName, radius, center, area);
}

Referenced by G4AdjointSimManager::DefineSphericalAdjointSourceWithCentreAtTheCentreOfAVolume(), and G4AdjointSimManager::DefineSphericalExtSourceWithCentreAtTheCentreOfAVolume().

ClearListOfSelectedSurface()

void G4AdjointCrossSurfChecker::ClearListOfSelectedSurface

(

)

Definition at line 374 of file G4AdjointCrossSurfChecker.cc.

{
  ListOfSurfaceName.clear();
  ListOfSurfaceType.clear();
  ListOfSphereRadius.clear();
  ListOfSphereCenter.clear();
  ListOfVol1Name.clear();
  ListOfVol2Name.clear();
}

CrossingAGivenRegisteredSurface() [1/2]

G4bool G4AdjointCrossSurfChecker::CrossingAGivenRegisteredSurface	(	const G4Step *	aStep,
		const G4String &	surface_name,
		G4ThreeVector &	cross_pos,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 162 of file G4AdjointCrossSurfChecker.cc.

{
  G4int ind = FindRegisteredSurface(surface_name);
  G4bool did_cross = false;
  if (ind >= 0) {
    did_cross = CrossingAGivenRegisteredSurface(aStep, ind, crossing_pos, cos_to_surface, GoingIn);
  }
  return did_cross;
}

Referenced by CrossingAGivenRegisteredSurface(), and CrossingOneOfTheRegisteredSurface().

CrossingAGivenRegisteredSurface() [2/2]

G4bool G4AdjointCrossSurfChecker::CrossingAGivenRegisteredSurface	(	const G4Step *	aStep,
		G4int	ind,
		G4ThreeVector &	cross_pos,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 176 of file G4AdjointCrossSurfChecker.cc.

{
  G4String surf_type = ListOfSurfaceType[ind];
  G4double radius = ListOfSphereRadius[ind];
  G4ThreeVector center = ListOfSphereCenter[ind];
  G4String vol1 = ListOfVol1Name[ind];
  G4String vol2 = ListOfVol2Name[ind];
 
  G4bool did_cross = false;
  if (surf_type == "Sphere") {
    did_cross = CrossingASphere(aStep, radius, center, crossing_pos, cos_to_surface, GoingIn);
  }
  else if (surf_type == "ExternalSurfaceOfAVolume") {
    did_cross = GoingInOrOutOfaVolumeByExtSurface(aStep, vol1, vol2, cos_to_surface, GoingIn);
    crossing_pos = aStep->GetPostStepPoint()->GetPosition();
  }
  else if (surf_type == "BoundaryBetweenTwoVolumes") {
    did_cross = CrossingAnInterfaceBetweenTwoVolumes(
      aStep, vol1, vol2, crossing_pos, cos_to_surface, GoingIn);
  }
  return did_cross;
}

CrossingAnInterfaceBetweenTwoVolumes()

G4bool G4AdjointCrossSurfChecker::CrossingAnInterfaceBetweenTwoVolumes	(	const G4Step *	aStep,
		const G4String &	vol1_name,
		const G4String &	vol2_name,
		G4ThreeVector &	cross_pos,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 216 of file G4AdjointCrossSurfChecker.cc.

{
  G4bool step_at_boundary = (aStep->GetPostStepPoint()->GetStepStatus() == fGeomBoundary);
  G4bool did_cross = false;
  if (step_at_boundary) {
    const G4VTouchable* postStepTouchable = aStep->GetPostStepPoint()->GetTouchable();
    const G4VTouchable* preStepTouchable = aStep->GetPreStepPoint()->GetTouchable();
    if ((preStepTouchable != nullptr) && (postStepTouchable != nullptr)) {
      G4String post_vol_name = postStepTouchable->GetVolume()->GetName();
      if (post_vol_name.empty()) {
        post_vol_name = postStepTouchable->GetVolume()->GetLogicalVolume()->GetName();
      }
      G4String pre_vol_name = preStepTouchable->GetVolume()->GetName();
      if (pre_vol_name.empty()) {
        pre_vol_name = preStepTouchable->GetVolume()->GetLogicalVolume()->GetName();
      }
      if (pre_vol_name == vol1_name && post_vol_name == vol2_name) {
        GoingIn = true;
        did_cross = true;
      }
      else if (pre_vol_name == vol2_name && post_vol_name == vol1_name) {
        GoingIn = false;
        did_cross = true;
      }
    }
  }
  return did_cross;  // still need to compute the cosine of the direction
}

Referenced by CrossingAGivenRegisteredSurface().

CrossingASphere()

G4bool G4AdjointCrossSurfChecker::CrossingASphere	(	const G4Step *	aStep,
		G4double	sphere_radius,
		G4ThreeVector	sphere_center,
		G4ThreeVector &	cross_pos,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 61 of file G4AdjointCrossSurfChecker.cc.

{
  G4ThreeVector pos1 = aStep->GetPreStepPoint()->GetPosition() - sphere_center;
  G4ThreeVector pos2 = aStep->GetPostStepPoint()->GetPosition() - sphere_center;
  G4double r1 = pos1.mag();
  G4double r2 = pos2.mag();
  G4bool did_cross = false;
 
  if (r1 <= sphere_radius && r2 > sphere_radius) {
    did_cross = true;
    GoingIn = false;
  }
  else if (r2 <= sphere_radius && r1 > sphere_radius) {
    did_cross = true;
    GoingIn = true;
  }
 
  if (did_cross) {
    G4ThreeVector dr = pos2 - pos1;
    G4double r12 = r1 * r1;
    G4double rdr = dr.mag();
    G4double a, b, c, d;
    a = rdr * rdr;
    b = 2. * pos1.dot(dr);
    c = r12 - sphere_radius * sphere_radius;
    d = std::sqrt(b * b - 4. * a * c);
    G4double l = (-b + d) / 2. / a;
    if (l > 1.) l = (-b - d) / 2. / a;
    crossing_pos = pos1 + l * dr;
    cos_th = std::abs(dr.cosTheta(crossing_pos));
  }
  return did_cross;
}

Referenced by CrossingAGivenRegisteredSurface().

CrossingOneOfTheRegisteredSurface()

G4bool G4AdjointCrossSurfChecker::CrossingOneOfTheRegisteredSurface	(	const G4Step *	aStep,
		G4String &	surface_name,
		G4ThreeVector &	cross_pos,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 202 of file G4AdjointCrossSurfChecker.cc.

{
  for (std::size_t i = 0; i < ListOfSurfaceName.size(); ++i) {
    if (CrossingAGivenRegisteredSurface(aStep, G4int(i), crossing_pos, cos_to_surface, GoingIn)) {
      surface_name = ListOfSurfaceName[i];
      return true;
    }
  }
  return false;
}

Referenced by G4AdjointSteppingAction::UserSteppingAction().

GetInstance()

G4AdjointCrossSurfChecker * G4AdjointCrossSurfChecker::GetInstance ( )

static

Definition at line 53 of file G4AdjointCrossSurfChecker.cc.

{
  if (instance == nullptr) instance = new G4AdjointCrossSurfChecker();
  return instance;
}

Referenced by G4AdjointSimManager::DefineAdjointSourceOnTheExtSurfaceOfAVolume(), G4AdjointSimManager::DefineExtSourceOnTheExtSurfaceOfAVolume(), G4AdjointSimManager::DefineSphericalAdjointSource(), G4AdjointSimManager::DefineSphericalAdjointSourceWithCentreAtTheCentreOfAVolume(), G4AdjointSimManager::DefineSphericalExtSource(), G4AdjointSimManager::DefineSphericalExtSourceWithCentreAtTheCentreOfAVolume(), and G4AdjointSteppingAction::G4AdjointSteppingAction().

GoingInOrOutOfaVolume()

G4bool G4AdjointCrossSurfChecker::GoingInOrOutOfaVolume	(	const G4Step *	aStep,
		const G4String &	volume_name,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 98 of file G4AdjointCrossSurfChecker.cc.

{
  G4bool step_at_boundary = (aStep->GetPostStepPoint()->GetStepStatus() == fGeomBoundary);
  G4bool did_cross = false;
  if (step_at_boundary) {
    const G4VTouchable* postStepTouchable = aStep->GetPostStepPoint()->GetTouchable();
    const G4VTouchable* preStepTouchable = aStep->GetPreStepPoint()->GetTouchable();
    if ((preStepTouchable != nullptr) && (postStepTouchable != nullptr) &&
        (postStepTouchable->GetVolume() != nullptr) && (preStepTouchable->GetVolume() != nullptr))
    {
      G4String post_vol_name = postStepTouchable->GetVolume()->GetName();
      G4String pre_vol_name = preStepTouchable->GetVolume()->GetName();
 
      if (post_vol_name == volume_name) {
        GoingIn = true;
        did_cross = true;
      }
      else if (pre_vol_name == volume_name) {
        GoingIn = false;
        did_cross = true;
      }
    }
  }
  return did_cross;  // still need to compute the cosine of the direction
}

GoingInOrOutOfaVolumeByExtSurface()

G4bool G4AdjointCrossSurfChecker::GoingInOrOutOfaVolumeByExtSurface	(	const G4Step *	aStep,
		const G4String &	volume_name,
		const G4String &	mother_lvol_name,
		G4double &	cos_to_surface,
		G4bool &	GoingIn )

Definition at line 127 of file G4AdjointCrossSurfChecker.cc.

{
  G4bool step_at_boundary = (aStep->GetPostStepPoint()->GetStepStatus() == fGeomBoundary);
  G4bool did_cross = false;
  if (step_at_boundary) {
    const G4VTouchable* postStepTouchable = aStep->GetPostStepPoint()->GetTouchable();
    const G4VTouchable* preStepTouchable = aStep->GetPreStepPoint()->GetTouchable();
    const G4VPhysicalVolume* postVol =
      (postStepTouchable != nullptr) ? postStepTouchable->GetVolume() : nullptr;
    const G4VPhysicalVolume* preVol =
      (preStepTouchable != nullptr) ? preStepTouchable->GetVolume() : nullptr;
    if (preStepTouchable != nullptr && postStepTouchable != nullptr && postVol != nullptr &&
        preVol != nullptr)
    {
      G4String post_vol_name = postVol->GetName();
      G4String post_log_vol_name = postVol->GetLogicalVolume()->GetName();
      G4String pre_vol_name = preVol->GetName();
      G4String pre_log_vol_name = preVol->GetLogicalVolume()->GetName();
      if (post_vol_name == volume_name && pre_log_vol_name == mother_logical_vol_name) {
        GoingIn = true;
        did_cross = true;
      }
      else if (pre_vol_name == volume_name && post_log_vol_name == mother_logical_vol_name) {
        GoingIn = false;
        did_cross = true;
      }
    }
  }
  return did_cross;  // still need to compute the cosine of the direction
}

Referenced by CrossingAGivenRegisteredSurface().

---

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

• G4AdjointCrossSurfChecker.hh
• G4AdjointCrossSurfChecker.cc