G4LogicalBorderSurface Class Reference

G4LogicalBorderSurface is a Logical Surface class for surfaces defined by the boundary of two physical volumes. More...

#include <G4LogicalBorderSurface.hh>

Inheritance diagram for G4LogicalBorderSurface:

Public Member Functions
	G4LogicalBorderSurface (const G4String &name, G4VPhysicalVolume *vol1, G4VPhysicalVolume *vol2, G4SurfaceProperty *surfaceProperty)
	~G4LogicalBorderSurface () override=default
	G4LogicalBorderSurface (const G4LogicalBorderSurface &)=delete
G4LogicalBorderSurface &	operator= (const G4LogicalBorderSurface &)=delete
G4bool	operator== (const G4LogicalBorderSurface &right) const
G4bool	operator!= (const G4LogicalBorderSurface &right) const
void	SetPhysicalVolumes (G4VPhysicalVolume *vol1, G4VPhysicalVolume *vol2)
const G4VPhysicalVolume *	GetVolume1 () const
const G4VPhysicalVolume *	GetVolume2 () const
std::size_t	GetIndex () const
void	SetVolume1 (G4VPhysicalVolume *vol1)
void	SetVolume2 (G4VPhysicalVolume *vol2)
Public Member Functions inherited from G4LogicalSurface
virtual	~G4LogicalSurface ()=default
	G4LogicalSurface (const G4LogicalSurface &)=delete
G4LogicalSurface &	operator= (const G4LogicalSurface &)=delete
G4SurfaceProperty *	GetSurfaceProperty () const
void	SetSurfaceProperty (G4SurfaceProperty *ptrSurfaceProperty)
const G4String &	GetName () const
void	SetName (const G4String &name)
G4TransitionRadiationSurface *	GetTransitionRadiationSurface () const
void	SetTransitionRadiationSurface (G4TransitionRadiationSurface *trs)
G4bool	operator== (const G4LogicalSurface &right) const
G4bool	operator!= (const G4LogicalSurface &right) const

Static Public Member Functions
static G4LogicalBorderSurface *	GetSurface (const G4VPhysicalVolume *vol1, const G4VPhysicalVolume *vol2)
static void	CleanSurfaceTable ()
static const G4LogicalBorderSurfaceTable *	GetSurfaceTable ()
static std::size_t	GetNumberOfBorderSurfaces ()
static void	DumpInfo ()

Additional Inherited Members
Protected Member Functions inherited from G4LogicalSurface
	G4LogicalSurface (const G4String &name, G4SurfaceProperty *prop)

Detailed Description

G4LogicalBorderSurface is a Logical Surface class for surfaces defined by the boundary of two physical volumes.

Definition at line 54 of file G4LogicalBorderSurface.hh.

Constructor & Destructor Documentation

G4LogicalBorderSurface() [1/2]

G4LogicalBorderSurface::G4LogicalBorderSurface	(	const G4String &	name,
		G4VPhysicalVolume *	vol1,
		G4VPhysicalVolume *	vol2,
		G4SurfaceProperty *	surfaceProperty )

Constructor and Destructor.

Definition at line 41 of file G4LogicalBorderSurface.cc.

  : G4LogicalSurface(name, surfaceProperty),
    Volume1(vol1), Volume2(vol2),
    Index(theBorderSurfaceTable != nullptr ? theBorderSurfaceTable->size() : 0)
{
  if (theBorderSurfaceTable == nullptr)
  {
    theBorderSurfaceTable = new G4LogicalBorderSurfaceTable;
  }
 
  // Store in the table of Surfaces
  //
  theBorderSurfaceTable->insert(std::make_pair(std::make_pair(vol1,vol2),this));
}

Referenced by DumpInfo(), operator!=(), operator=(), and operator==().

~G4LogicalBorderSurface()

G4LogicalBorderSurface::~G4LogicalBorderSurface ( )

overridedefault

G4LogicalBorderSurface() [2/2]

G4LogicalBorderSurface::G4LogicalBorderSurface ( const G4LogicalBorderSurface & )

delete

Copy constructor and assignment operator are not allowed.

Member Function Documentation

CleanSurfaceTable()

void G4LogicalBorderSurface::CleanSurfaceTable ( )

static

Handling of the table of surfaces.

Definition at line 130 of file G4LogicalBorderSurface.cc.

{
  if (theBorderSurfaceTable == nullptr) { return; }
 
  // Do nothing if geometry is closed
  if (G4GeometryManager::GetInstance()->IsGeometryClosed())
  {
    G4cout << "WARNING - Attempt to clear the border surface store"
           << " while geometry closed !" << G4endl;
    return;
  }
 
  for (const auto& pos : *theBorderSurfaceTable)
  {
    delete pos.second;
  }
  theBorderSurfaceTable->clear();
}

Referenced by G4RunManager::ReinitializeGeometry().

DumpInfo()

void G4LogicalBorderSurface::DumpInfo ( )

static

Definition at line 110 of file G4LogicalBorderSurface.cc.

{
  G4cout << "***** Surface Table : Nb of Surfaces = "
         << GetNumberOfBorderSurfaces() << " *****" << G4endl;
 
  if (theBorderSurfaceTable != nullptr)
  {
    for(const auto & pos : *theBorderSurfaceTable)
    {
      G4LogicalBorderSurface* pSurf = pos.second;
      G4cout << pSurf->GetName() << " : " << G4endl
             << " Border of volumes "
             << pSurf->GetVolume1()->GetName() << " and " 
             << pSurf->GetVolume2()->GetName() << G4endl;
    }
  }
  G4cout << G4endl;
}

GetIndex()

std::size_t G4LogicalBorderSurface::GetIndex ( ) const

inline

GetNumberOfBorderSurfaces()

std::size_t G4LogicalBorderSurface::GetNumberOfBorderSurfaces ( )

static

Definition at line 85 of file G4LogicalBorderSurface.cc.

{
  if (theBorderSurfaceTable != nullptr)
  {
    return theBorderSurfaceTable->size();
  }
  return 0;
}

Referenced by DumpInfo(), and G4GDMLWriteStructure::GetBorderSurface().

GetSurface()

G4LogicalBorderSurface * G4LogicalBorderSurface::GetSurface ( const G4VPhysicalVolume * vol1, const G4VPhysicalVolume * vol2 )

static

Generic accessors and setters.

Definition at line 96 of file G4LogicalBorderSurface.cc.

{
  if (theBorderSurfaceTable != nullptr)
  {
    auto pos = theBorderSurfaceTable->find(std::make_pair(vol1,vol2));
    if(pos != theBorderSurfaceTable->cend()) { return pos->second; }
  }
  return nullptr;
}

Referenced by G4MicroElecSurface::PostStepDoIt(), and G4OpBoundaryProcess::PostStepDoIt().

GetSurfaceTable()

const G4LogicalBorderSurfaceTable * G4LogicalBorderSurface::GetSurfaceTable ( )

static

Definition at line 75 of file G4LogicalBorderSurface.cc.

{
  if (theBorderSurfaceTable == nullptr)
  {
    theBorderSurfaceTable = new G4LogicalBorderSurfaceTable;
  }
  return theBorderSurfaceTable;
}

Referenced by G4GDMLWriteStructure::GetBorderSurface().

GetVolume1()

const G4VPhysicalVolume * G4LogicalBorderSurface::GetVolume1 ( ) const

inline

Referenced by G4GDMLWriteStructure::BorderSurfaceCache(), and DumpInfo().

GetVolume2()

const G4VPhysicalVolume * G4LogicalBorderSurface::GetVolume2 ( ) const

inline

Referenced by G4GDMLWriteStructure::BorderSurfaceCache(), and DumpInfo().

operator!=()

G4bool G4LogicalBorderSurface::operator!=

(

const G4LogicalBorderSurface &

right

)

const

Definition at line 69 of file G4LogicalBorderSurface.cc.

{
  return (this != (G4LogicalBorderSurface *) &right);
}

operator=()

G4LogicalBorderSurface & G4LogicalBorderSurface::operator= ( const G4LogicalBorderSurface & )

delete

operator==()

G4bool G4LogicalBorderSurface::operator==

(

const G4LogicalBorderSurface &

right

)

const

Equality operators.

Definition at line 62 of file G4LogicalBorderSurface.cc.

{
  return (this == (G4LogicalBorderSurface *) &right);
}

SetPhysicalVolumes()

void G4LogicalBorderSurface::SetPhysicalVolumes ( G4VPhysicalVolume * vol1, G4VPhysicalVolume * vol2 )

inline

SetVolume1()

void G4LogicalBorderSurface::SetVolume1 ( G4VPhysicalVolume * vol1 )

inline

SetVolume2()

void G4LogicalBorderSurface::SetVolume2 ( G4VPhysicalVolume * vol2 )

inline

---

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

• G4LogicalBorderSurface.hh
• G4LogicalBorderSurface.cc