G4GeomSplitter< T > Class Template Reference

G4GeomSplitter is an utility class for splitting of R/W data for thread-safety from geometry classes. T is the private data from the object to be split. More...

#include <G4GeomSplitter.hh>

Public Member Functions
	G4GeomSplitter ()
T *	Reallocate (G4int size)
G4int	CreateSubInstance ()
void	CopyMasterContents ()
void	SlaveCopySubInstanceArray ()
void	SlaveInitializeSubInstance ()
void	SlaveReCopySubInstanceArray ()
void	FreeSlave ()
T *	GetOffset ()
void	UseWorkArea (T *newOffset)
T *	FreeWorkArea ()

Static Public Attributes
static G4GEOM_DLL G4ThreadLocal T *	offset

Detailed Description

template<class T>
class G4GeomSplitter< T >

G4GeomSplitter is an utility class for splitting of R/W data for thread-safety from geometry classes. T is the private data from the object to be split.

Definition at line 50 of file G4GeomSplitter.hh.

Constructor & Destructor Documentation

G4GeomSplitter()

template<class T>

G4GeomSplitter< T >::G4GeomSplitter ( )

inline

Constructor.

Definition at line 57 of file G4GeomSplitter.hh.

      :  sharedOffset(nullptr)
    {
      G4MUTEXINIT(mutex);
    }

Member Function Documentation

CopyMasterContents()

template<class T>

void G4GeomSplitter< T >::CopyMasterContents ( )

inline

Utility to copy data from master in memory.

Definition at line 96 of file G4GeomSplitter.hh.

    {
      G4AutoLock l(&mutex);
      std::memcpy(offset, sharedOffset, totalspace * sizeof(T));
    }

Referenced by G4GeomSplitter< G4LVData >::SlaveCopySubInstanceArray(), and G4GeomSplitter< G4LVData >::SlaveReCopySubInstanceArray().

CreateSubInstance()

template<class T>

G4int G4GeomSplitter< T >::CreateSubInstance ( )

inline

Invoked by the master or work thread to create a new subinstance whenever a new split class instance is created.

Definition at line 76 of file G4GeomSplitter.hh.

    {
      G4AutoLock l(&mutex);
      ++totalobj;
      if (totalobj > totalspace)
      {
        offset = Reallocate(totalspace+512);
        if (offset == nullptr)
        {
           G4Exception("G4GeomSPlitter::CreateSubInstance()",
                       "OutOfMemory", FatalException, "Cannot malloc space!");
        }
        sharedOffset = offset;
      }
      return (totalobj - 1);
    }

Referenced by G4PolyconeSide::G4PolyconeSide(), and G4PolyhedraSide::G4PolyhedraSide().

FreeSlave()

template<class T>

void G4GeomSplitter< T >::FreeSlave ( )

inline

Invoked by all threads to free the subinstance array.

Definition at line 164 of file G4GeomSplitter.hh.

    {
      if (offset == nullptr)  { return; }
      std::free( offset );
      offset = nullptr;
    }

FreeWorkArea()

template<class T>

T * G4GeomSplitter< T >::FreeWorkArea ( )

inline

Detaches the current thread from this location. The object which calls this method is responsible for it.

Definition at line 196 of file G4GeomSplitter.hh.

    {
      T* offsetRet = offset;
      offset = nullptr;
      return offsetRet;
    }

GetOffset()

template<class T>

T * G4GeomSplitter< T >::GetOffset ( )

inline

Returns a pointer to the split data.

Definition at line 176 of file G4GeomSplitter.hh.

{ return offset; }

Reallocate()

template<class T>

T * G4GeomSplitter< T >::Reallocate ( G4int size )

inline

Reallocates data for a given 'size'.

Definition at line 66 of file G4GeomSplitter.hh.

    {
       totalspace = size;
       return (T *) std::realloc(offset, totalspace * sizeof(T));
    }

Referenced by G4GeomSplitter< G4LVData >::CreateSubInstance(), G4GeomSplitter< G4LVData >::SlaveCopySubInstanceArray(), and G4GeomSplitter< G4LVData >::SlaveInitializeSubInstance().

SlaveCopySubInstanceArray()

template<class T>

void G4GeomSplitter< T >::SlaveCopySubInstanceArray ( )

inline

Invoked by each worker thread to copy all the subinstance array from the master thread.

Definition at line 106 of file G4GeomSplitter.hh.

    {
      G4AutoLock l(&mutex);
      if (offset != nullptr)  { return; }
      offset = Reallocate(totalspace);
      if (offset == nullptr)
      {
        G4Exception("G4GeomSplitter::SlaveCopySubInstanceArray()",
                    "OutOfMemory", FatalException, "Cannot malloc space!");
      }
      l.unlock();
      CopyMasterContents();
    }

SlaveInitializeSubInstance()

template<class T>

void G4GeomSplitter< T >::SlaveInitializeSubInstance ( )

inline

Invoked by each worker thread to create the subinstance array and initialize each subinstance using a particular method defined by the subclass.

Definition at line 125 of file G4GeomSplitter.hh.

    {
      G4AutoLock l(&mutex);
      if (offset != nullptr)  { return; }
      offset = Reallocate(totalspace);
 
      if (offset == nullptr)
      {
        G4Exception("G4GeomSplitter::SlaveInitializeSubInstance()",
                    "OutOfMemory", FatalException, "Cannot malloc space!");
      }
 
      for (G4int i=0 ; i<totalspace; ++i)
      {
        offset[i].initialize();
      }
    }

Referenced by G4GeomSplitter< G4LVData >::SlaveReCopySubInstanceArray().

SlaveReCopySubInstanceArray()

template<class T>

void G4GeomSplitter< T >::SlaveReCopySubInstanceArray ( )

inline

Invoked by each worker thread at start of a run (2nd or later) to copy again all the subinstance array from the master thread. To cope with user's changes in Geometry - e.g. change of material in a volume.

Definition at line 149 of file G4GeomSplitter.hh.

    {
      if (offset == nullptr)
      {
        SlaveInitializeSubInstance();
        G4Exception("G4GeomSPlitter::SlaveReCopySubInstance()",
                    "MissingInitialisation", JustWarning,
                    "Must be called after Initialisation or first Copy.");
      }
      CopyMasterContents();
    }

UseWorkArea()

template<class T>

void G4GeomSplitter< T >::UseWorkArea ( T * newOffset )

inline

Uses recycled work area - which was created previously.

Definition at line 181 of file G4GeomSplitter.hh.

    {
      if( (offset!=nullptr) && (offset!=newOffset) )
      {
         G4Exception("G4GeomSplitter::UseWorkspace()", 
                     "TwoWorkspaces", FatalException,
                     "Thread already has workspace - cannot use another.");
      }
      offset = newOffset;
    }

Member Data Documentation

offset

template<class T>

G4GEOM_DLL G4ThreadLocal T* G4GeomSplitter< T >::offset

static

Definition at line 205 of file G4GeomSplitter.hh.

---

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

• G4GeomSplitter.hh