G4RootMpiNtupleFileManager Class Reference

#include <G4RootMpiNtupleFileManager.hh>

Inheritance diagram for G4RootMpiNtupleFileManager:

Public Member Functions
	G4RootMpiNtupleFileManager (const G4AnalysisManagerState &state)
virtual	~G4RootMpiNtupleFileManager ()
void	SetMpiNtupleMerging (tools::impi *impi, G4int mpiRank, G4int mpiSize, G4int nofReducedNtupleFiles=0)
virtual G4bool	ActionAtOpenFile (const G4String &fileName) final
virtual G4bool	ActionAtWrite () final
virtual G4bool	ActionAtCloseFile () final
virtual G4bool	Reset () final
virtual std::shared_ptr< G4VNtupleManager >	CreateNtupleManager () override
std::shared_ptr< G4RootMpiNtupleManager >	GetMpiNtupleManager () const

Private Member Functions
void	SetMpiNtupleMergingMode (G4int nofNtupleFiles)
void	CreateMpiNtupleManagers (tools::impi *impi, G4int mpiRank, G4int mpiSize)

Private Attributes
tools::impi *	fImpi
G4int	fMpiRank
G4int	fMpiSize
std::shared_ptr< G4RootMpiPNtupleManager >	fMpiSlaveNtupleManager
G4bool	fNtupleBooked

Detailed Description

Definition at line 45 of file G4RootMpiNtupleFileManager.hh.

Constructor & Destructor Documentation

G4RootMpiNtupleFileManager()

G4RootMpiNtupleFileManager::G4RootMpiNtupleFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 40 of file G4RootMpiNtupleFileManager.cc.

 : G4RootNtupleFileManager(state),
   fImpi(nullptr),
   fMpiRank(-1),
   fMpiSize(0),
   fMpiSlaveNtupleManager(nullptr),
   fNtupleBooked(false)
{}

~G4RootMpiNtupleFileManager()

G4RootMpiNtupleFileManager::~G4RootMpiNtupleFileManager ( )

virtual

Definition at line 50 of file G4RootMpiNtupleFileManager.cc.

{}

Member Function Documentation

SetMpiNtupleMerging()

void G4RootMpiNtupleFileManager::SetMpiNtupleMerging	(	tools::impi *	impi,
		G4int	mpiRank,
		G4int	mpiSize,
		G4int	nofReducedNtupleFiles = 0
	)

Definition at line 107 of file G4RootMpiNtupleFileManager.cc.

{
  if ( fIsInitialized ) {
      G4ExceptionDescription description;
      description 
        << "Cannot change merging mode." << G4endl
        << "The function must be called before OpenFile().";
      G4Exception("G4RootMpiNtupleFileManager::SetMpiNtupleMerging",
                  "Analysis_W013", JustWarning, description);
      return;
  }
 
  // Save MPI merging parameters
  fImpi = impi;
  fMpiRank = mpiRank;
  fMpiSize = mpiSize;
 
  // Set ntuple merging mode 
  SetMpiNtupleMergingMode(nofNtupleFiles);
}

ActionAtOpenFile()

G4bool G4RootMpiNtupleFileManager::ActionAtOpenFile ( const G4String &  fileName )

finalvirtual

Definition at line 184 of file G4RootMpiNtupleFileManager.cc.

{
  // No MPI merging, call base class
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone )  {
    return G4RootNtupleFileManager::ActionAtOpenFile(fileName);
  }
 
  if ( ! fNtupleBooked ) {
 
    G4String objectType = "analysis file";
    if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) {
      objectType = "main analysis file";
    }
    Message(kVL4, "open", objectType, fileName);
 
 
    if ( fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
      // Creating files is triggered from CreateNtuple   
      fNtupleManager->CreateNtuplesFromBooking(
        fBookingManager->GetNtupleBookingVector());
    }
 
    if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave )  {
      // G4cout << "Slave: Go to create ntuples from booking" << G4endl;
      // No file is open by Slave manager
      fMpiSlaveNtupleManager->CreateNtuplesFromBooking(
        fBookingManager->GetNtupleBookingVector());
    }
 
    Message(kVL1, "open", objectType, fileName);
 
    fNtupleBooked = true;
  }
 
  return true;
}  

ActionAtWrite()

G4bool G4RootMpiNtupleFileManager::ActionAtWrite ( )

finalvirtual

Definition at line 222 of file G4RootMpiNtupleFileManager.cc.

{
  // No MPI merging, call base class
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone  ) {
    return G4RootNtupleFileManager::ActionAtWrite();
  }
  
  auto result = true;
 
  G4String ntupleType;
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) ntupleType = "main ntuples";
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) ntupleType = "slave ntuples";
 
  Message(kVL4, "merge", ntupleType);
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    result &= fNtupleManager->Merge();
  }  
  
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) {
    result &= fMpiSlaveNtupleManager->Merge();
  }
 
  Message(kVL1, "merge", ntupleType, "", result);
 
  return result;
}

ActionAtCloseFile()

G4bool G4RootMpiNtupleFileManager::ActionAtCloseFile ( )

finalvirtual

Definition at line 251 of file G4RootMpiNtupleFileManager.cc.

{ 
  // No MPI merging, call base class
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone )  {
    return G4RootNtupleFileManager::ActionAtCloseFile();
  }
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave)  {
    fMpiSlaveNtupleManager->SetNewCycle(false);
    return true;
  }
 
  return CloseNtupleFiles();
}

Reset()

G4bool G4RootMpiNtupleFileManager::Reset ( )

finalvirtual

Definition at line 267 of file G4RootMpiNtupleFileManager.cc.

{
// Reset ntuples
 
  // No MPI merging, call base class
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone  ) {
    return G4RootNtupleFileManager::Reset();
  }
  
  auto result = true;
  
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    result &= fNtupleManager->Reset();
  }  
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave )  {
    result &= fMpiSlaveNtupleManager->Reset();
  }  
 
  return result;
}

CreateNtupleManager()

std::shared_ptr< G4VNtupleManager > G4RootMpiNtupleFileManager::CreateNtupleManager ( )

overridevirtual

Definition at line 131 of file G4RootMpiNtupleFileManager.cc.

{
  Message(kVL4, "create", "mpi ntuple manager");
 
  std::shared_ptr<G4VNtupleManager> activeNtupleManager = nullptr;
  switch ( fNtupleMergeMode )
  {
    case G4NtupleMergeMode::kNone:
      fNtupleManager 
        = make_shared<G4RootNtupleManager>(fState, fBookingManager,
                        0, 0, fNtupleRowWise, fNtupleRowMode);
      fNtupleManager->SetFileManager(fFileManager);
      activeNtupleManager = fNtupleManager;
      break;
 
    case G4NtupleMergeMode::kMain: {
      fNtupleManager 
        = make_shared<G4RootMpiNtupleManager>(fState, fBookingManager,
                        fNtupleRowWise, fNtupleRowMode, fImpi, fMpiSize);
      fNtupleManager->SetFileManager(fFileManager);
      activeNtupleManager = fNtupleManager;
      break;
    }
 
    case G4NtupleMergeMode::kSlave: {
      auto destinationRank = fMpiSize;
      fMpiSlaveNtupleManager 
        = make_shared<G4RootMpiPNtupleManager>(fState, fImpi, fMpiRank, destinationRank);
      activeNtupleManager = fMpiSlaveNtupleManager;
      break;
    }
  }
 
  G4String mergeMode;
  switch ( fNtupleMergeMode ) {
    case G4NtupleMergeMode::kNone:
      mergeMode = "";
      break;
    case G4NtupleMergeMode::kMain:
      mergeMode = "main ";
      break;
    case G4NtupleMergeMode::kSlave:
      mergeMode = "slave ";
      break;
  }
  Message(kVL3, "create", mergeMode + "mpi ntuple manager");
 
  fIsInitialized = true;
 
  return activeNtupleManager;
}

GetMpiNtupleManager()

std::shared_ptr< G4RootMpiNtupleManager > G4RootMpiNtupleFileManager::GetMpiNtupleManager

(

)

const

SetMpiNtupleMergingMode()

void G4RootMpiNtupleFileManager::SetMpiNtupleMergingMode ( G4int  nofNtupleFiles )

private

Definition at line 58 of file G4RootMpiNtupleFileManager.cc.

{
  Message(kVL2, "set", "mpi ntuple merging mode");
 
  auto canMerge = true;
 
  // Illegal situations
  if ( fMpiSize < 2 ) {
    G4ExceptionDescription description;
    description 
      << "Merging ntuples is not applicable on a single rank." << G4endl 
      << "Setting was ignored.";
      G4Exception("G4RootMpiNtupleFileManager::SetMpiNtupleMergingMode()",
                  "Analysis_W013", JustWarning, description);
    canMerge = false;      
  }
 
  G4String mergingMode;
  if ( ! canMerge ) {
    fNtupleMergeMode = G4NtupleMergeMode::kNone;
    mergingMode = "G4NtupleMergeMode::kNone";      
  }
  else {
    // Set the number of reduced ntuple files
    // (multiple output files are not yet supported)
    fNofNtupleFiles = nofNtupleFiles;
  
    // Forced merging mode
    // MPI
    if ( fMpiRank >= fMpiSize ) {
      // the extra worker
      fNtupleMergeMode = G4NtupleMergeMode::kMain;
      mergingMode = "G4NtupleMergeMode::kMain";
    } else {
      // processing worker
      fNtupleMergeMode = G4NtupleMergeMode::kSlave;
      mergingMode = "G4NtupleMergeMode::kSlave";
    }
  }
 
  Message(kVL1, "set", "mpi ntuple merging mode", mergingMode);
}

CreateMpiNtupleManagers()

void G4RootMpiNtupleFileManager::CreateMpiNtupleManagers ( tools::impi *  impi, G4int  mpiRank, G4int  mpiSize  )

private

Member Data Documentation

fImpi

tools::impi* G4RootMpiNtupleFileManager::fImpi

private

Definition at line 72 of file G4RootMpiNtupleFileManager.hh.

fMpiRank

G4int G4RootMpiNtupleFileManager::fMpiRank

private

Definition at line 73 of file G4RootMpiNtupleFileManager.hh.

fMpiSize

G4int G4RootMpiNtupleFileManager::fMpiSize

private

Definition at line 74 of file G4RootMpiNtupleFileManager.hh.

fMpiSlaveNtupleManager

std::shared_ptr<G4RootMpiPNtupleManager> G4RootMpiNtupleFileManager::fMpiSlaveNtupleManager

private

Definition at line 76 of file G4RootMpiNtupleFileManager.hh.

fNtupleBooked

G4bool G4RootMpiNtupleFileManager::fNtupleBooked

private

Definition at line 77 of file G4RootMpiNtupleFileManager.hh.

---

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

• extended/parallel/MPI/source/analysis/include/G4RootMpiNtupleFileManager.hh
• extended/parallel/MPI/source/analysis/src/G4RootMpiNtupleFileManager.cc