#include <G4GIDI.hh>

Public Member Functions
	G4GIDI (G4int a_ip, std::string const &a_dataDirectory)
	G4GIDI (G4int a_ip, std::list< std::string > const &a_dataDirectory)
	~G4GIDI ()
G4int	projectileIP () const
G4int	numberOfDataDirectories () const
G4int	addDataDirectory (std::string const &a_dataDirectory)
G4int	removeDataDirectory (std::string const &a_dataDirectory)
std::string const	getDataDirectoryAtIndex (G4int a_index) const
std::vector< std::string > *	getDataDirectories () const
bool	isThisDataAvailable (std::string const &a_lib_name, G4int a_Z, G4int a_A, G4int a_M=0) const
bool	isThisDataAvailable (std::string const &a_lib_name, std::string const &a_targetName) const
std::string	dataFilename (std::string const &lib_name, G4int a_Z, G4int a_A, G4int a_M=0) const
std::string	dataFilename (std::string const &lib_name, std::string const &a_targetName) const
std::vector< std::string > *	getNamesOfAvailableLibraries (G4int a_Z, G4int a_A, G4int a_M=0) const
std::vector< std::string > *	getNamesOfAvailableLibraries (std::string const &a_targetName) const
std::vector< std::string > *	getNamesOfAvailableTargets () const
G4GIDI_target *	readTarget (std::string const &lib_name, G4int a_Z, G4int a_A, G4int a_M=0, bool a_bind=true)
G4GIDI_target *	readTarget (std::string const &lib_name, std::string const &a_targetName, bool a_bind=true)
G4GIDI_target *	getAlreadyReadTarget (G4int a_Z, G4int a_A, G4int a_M=0)
G4GIDI_target *	getAlreadyReadTarget (std::string const &a_targetName)
G4int	freeTarget (G4int a_Z, G4int a_A, G4int a_M=0)
G4int	freeTarget (std::string const &a_targetSymbol)
G4int	freeTarget (G4GIDI_target *a_target)
std::vector< std::string > *	getListOfReadTargetsNames ()

Detailed Description

A class to store map files for a particular projectile.

Definition at line 124 of file G4GIDI.hh.

Constructor & Destructor Documentation

◆ G4GIDI() [1/2]

G4GIDI::G4GIDI	(	G4int	a_ip,
		std::string const &	a_dataDirectory )

Parameters

a_ip	[in] One of the following ids for the projectile (0:photon, 1:neutron, 2:proton, 3:deutron, 4:triton, 5:helion or 6:alpha).
a_dataDirectory	[in] A path to a map file to load.

Definition at line 84 of file G4GIDI.cc.

                                                           :
        m_projectileIP( a_ip ),
        m_projectile( projectileStringFromID( a_ip ) ) {
 
    addDataDirectory( a_dataDirectory );
}

◆ G4GIDI() [2/2]

G4GIDI::G4GIDI	(	G4int	a_ip,
		std::list< std::string > const &	a_dataDirectories )

Parameters

a_id	[in] This argument is ignored but needed for backwards compatibility.
a_dataDirectories	[in] A list of paths to a map files to load.

Definition at line 97 of file G4GIDI.cc.

                                                                      :
        m_projectileIP( a_ip ),
        m_projectile( projectileStringFromID( a_ip ) ) {
 
    for( auto mapIter = a_dataDirectories.begin( ); mapIter != a_dataDirectories.end( ); ++mapIter ) {
        addDataDirectory( *mapIter );
    }
}

◆ ~G4GIDI()

G4GIDI::~G4GIDI ( )

Definition at line 109 of file G4GIDI.cc.

                 {
 
    for( auto mapIter = m_maps.begin( ); mapIter != m_maps.end( ); ++mapIter ) delete *mapIter;
    for( auto protareIter = m_protares.begin( ); protareIter != m_protares.end( ); ++protareIter ) delete *protareIter;
}

Member Function Documentation

◆ addDataDirectory()

int G4GIDI::addDataDirectory ( std::string const & a_dataDirectory )

Adds the map file a_dataDirectory to this.

Parameters

a_dataDirectory [in] A path to a map file to load.

Definition at line 121 of file G4GIDI.cc.

                                                               {
 
    for( auto mapIter = m_maps.begin( ); mapIter != m_maps.end( ); ++mapIter ) {
        if( (*mapIter)->fileName( ) == a_dataDirectory ) return( 0 );
    }
 
    m_maps.push_back( new GIDI::Map::Map( a_dataDirectory, G4GIDI_pops ) );
 
    return( 0 );
}

Referenced by G4GIDI().

◆ dataFilename() [1/2]

std::string G4GIDI::dataFilename	(	std::string const &	a_lib_name,
		G4int	a_Z,
		G4int	a_A,
		G4int	a_M = 0 ) const

Returns the file path to the specified target or nullptr if the target does not exists.

Parameters

a_lib_name	[in] The evaluation. Call be an empty string.
a_Z	[in] The atomic number of the target.
a_A	[in] The mass number of the taret.
a_M	[in] The meta-stable index of the target.

Returns: A std::string of the protare's path.

Definition at line 233 of file G4GIDI.cc.

                                                                                             {
 
    return( dataFilename( a_lib_name, G4GIDI_Misc_Z_A_m_ToName( a_Z, a_A, a_M ) ) );
}

Referenced by dataFilename().

◆ dataFilename() [2/2]

std::string G4GIDI::dataFilename	(	std::string const &	a_lib_name,
		std::string const &	a_targetName ) const

Returns the file path to the specified target or nullptr if the target does not exists.

Parameters

a_lib_name	[in] The evaluation. Call be an empty string.
a_targetName	[in] The target PoPs id.

Returns: Boolean value.

Definition at line 247 of file G4GIDI.cc.

                                                                                                 {
 
    for( auto mapIter = m_maps.begin( ); mapIter!= m_maps.end( ); ++mapIter ) {
        std::string path = (*mapIter)->protareFilename( m_projectile, a_targetName, "", a_lib_name );
        if( path != "" ) return( path );
    }
 
    return( "" );
}

◆ freeTarget() [1/3]

G4int G4GIDI::freeTarget ( G4GIDI_target * a_target )

If a_target is in member m_protares, removed it from m_protares, delete it and return 0. Otherwise, do nothing and return 1.

Parameters

a_target [in] The evaluation. Call be an empty std::string.

Returns: Integer value.

Definition at line 430 of file G4GIDI.cc.

                                                  {
 
    for( auto iter_protare = m_protares.cbegin( ); iter_protare != m_protares.cend( ); ++iter_protare ) {
        if( *iter_protare == a_target ) {
            m_protares.erase( iter_protare );
            delete a_target;
            return( 0 );
        }
    }
    return( 1 );
}

◆ freeTarget() [2/3]

G4int G4GIDI::freeTarget	(	G4int	a_Z,
		G4int	a_A,
		G4int	a_M = 0 )

Determines target name from a_Z, a_A and a_M and calls freeTarget with target's name, and returns its return value.

Parameters

a_Z	[in] The atomic number of the target.
a_A	[in] The mass number of the taret.
a_M	[in] The meta-stable index of the target.

Returns: Integer value.

Definition at line 453 of file G4GIDI.cc.

                                                          {
 
    return( freeTarget( G4GIDI_Misc_Z_A_m_ToName( a_Z, a_A, a_M ) ) );
}

Referenced by freeTarget(), and freeTarget().

◆ freeTarget() [3/3]

G4int G4GIDI::freeTarget ( std::string const & targetSymbol )

If target with name targetSymbol is in member m_protares, call freeTarget with target's pointer and return freeTarget's return value. Otherwise, return 1.

Returns: Integer value.

Definition at line 465 of file G4GIDI.cc.

                                                        {
 
    for( auto iter_protare = m_protares.cbegin( ); iter_protare != m_protares.cend( ); ++iter_protare ) {
        if( *(*iter_protare)->getName( ) == targetSymbol ) return( freeTarget( *iter_protare ) );
    }
    return( 1 );
}

◆ getAlreadyReadTarget() [1/2]

G4GIDI_target * G4GIDI::getAlreadyReadTarget	(	G4int	a_Z,
		G4int	a_A,
		G4int	a_M = 0 )

Determines target name from a_Z, a_A and a_M and calls getAlreadyReadTarget with target's name, and returns its return value.

Parameters

a_Z	[in] The atomic number of the target.
a_A	[in] The mass number of the taret.
a_M	[in] The meta-stable index of the target.

Returns: Pointer to an G4GIDI_target instance of nullptr.

Definition at line 398 of file G4GIDI.cc.

                                                                             {
 
    return( getAlreadyReadTarget( G4GIDI_Misc_Z_A_m_ToName( a_Z, a_A, a_M ) ) );
}

Referenced by getAlreadyReadTarget().

◆ getAlreadyReadTarget() [2/2]

G4GIDI_target * G4GIDI::getAlreadyReadTarget ( std::string const & a_targetName )

Returns the pointer to the G4GIDI_target with name a_targetName in member m_protares or nullptr if one does not exists in m_protares.

Parameters

a_targetName [in] The name of the target.

Returns: Pointer to an G4GIDI_target instance of nullptr.

Definition at line 412 of file G4GIDI.cc.

                                                                           {
 
    for( auto iter_protare = m_protares.cbegin( ); iter_protare != m_protares.cend( ); ++iter_protare ) {
        if( *(*iter_protare)->getName( ) == a_targetName ) return( *iter_protare );
    }
 
    return( nullptr );
}

◆ getDataDirectories()

std::vector< std::string > * G4GIDI::getDataDirectories ( ) const

Returns a list of paths to all loaded map files.

Returns: Returns a pointer that the user owns (i.e., the user is responsible for free-ing).

Definition at line 177 of file G4GIDI.cc.

                                                        {
 
    std::vector<std::string> *list = new std::vector<std::string>( );
 
    for( auto mapIter = m_maps.begin( ); mapIter!= m_maps.end( ); ++mapIter ) {
        list->push_back( (*mapIter)->fileName( ) );
    }
 
    return( list );
}

◆ getDataDirectoryAtIndex()

std::string const G4GIDI::getDataDirectoryAtIndex ( G4int a_index ) const

Removes the map file with path a_dataDirectory from this.

Parameters

a_dataDirectory [in] A path to a map file to unload.

Definition at line 162 of file G4GIDI.cc.

                                                                   {
 
    std::string nullString;
 
    if( ( a_index < 0 ) || ( a_index >= static_cast<int>( m_maps.size( ) ) ) ) return( nullString );
 
    return( m_maps[a_index]->fileName( ) );
}

◆ getListOfReadTargetsNames()

std::vector< std::string > * G4GIDI::getListOfReadTargetsNames ( void )

If target with name targetSymbol is in member m_protares, call freeTarget with target's pointer and return freeTarget's return value. Otherwise, return 1.

Returns: Integer value.

Definition at line 480 of file G4GIDI.cc.

                                                              {
 
    std::vector<std::string> *listOfTargets = new std::vector<std::string>( );
 
    for( auto iter_protare = m_protares.cbegin( ); iter_protare != m_protares.cend( ); ++iter_protare ) {
        listOfTargets->push_back( *(*iter_protare)->getName( ) );
    }
 
    return( listOfTargets );
}

◆ getNamesOfAvailableLibraries() [1/2]

std::vector< std::string > * G4GIDI::getNamesOfAvailableLibraries	(	G4int	a_Z,
		G4int	a_A,
		G4int	a_M = 0 ) const

Determines target name from a_Z, a_A and a_M and calls getNamesOfAvailableLibraries with target's name, and returns its return value.

Parameters

a_Z	[in] The atomic number of the target.
a_A	[in] The mass number of the taret.
a_M	[in] The meta-stable index of the target.

Returns: Pointer to vector<string>.

Definition at line 268 of file G4GIDI.cc.

                                                                                                  {
 
    return( getNamesOfAvailableLibraries( G4GIDI_Misc_Z_A_m_ToName( a_Z, a_A, a_M ) ) );
}

Referenced by G4LENDManager::GetLENDTarget(), getNamesOfAvailableLibraries(), and G4LENDManager::IsLENDTargetAvailable().

◆ getNamesOfAvailableLibraries() [2/2]

std::vector< std::string > * G4GIDI::getNamesOfAvailableLibraries ( std::string const & a_targetName ) const

Returns the list of all evaluations that have a target named a_targetName. User is responsible for freeing the returned list.

Returns: Pointer to vector<string>.

Definition at line 279 of file G4GIDI.cc.

                                                                                                {
 
    std::vector<std::string> *listOfLibraries = new std::vector<std::string>( );
 
    for( auto mapIter = m_maps.cbegin( ); mapIter != m_maps.cend( ); ++mapIter ) {
        std::vector<GIDI::Map::ProtareBase const *> entries;
        (*mapIter)->findProtareEntries( entries, std::regex( m_projectile ), std::regex( a_targetName ) );
        for( auto entryIter = entries.begin( ); entryIter != entries.end( ); ++entryIter ) {
            listOfLibraries->push_back( (*entryIter)->evaluation( ) );
        }
    }
 
    return( listOfLibraries );
}

◆ getNamesOfAvailableTargets()

std::vector< std::string > * G4GIDI::getNamesOfAvailableTargets ( ) const

Returns the list of available targets for this.

Returns: Returns a pointer that the user owns (i.e., the user is responsible for free-ing).

Definition at line 300 of file G4GIDI.cc.

                                                                {
 
    std::vector<std::string> *list = new std::vector<std::string>( );
    std::set<std::string> targetIDs;
 
    for( auto mapIter = m_maps.begin( ); mapIter!= m_maps.end( ); ++mapIter ) {
        auto protareBases = (*mapIter)->directory( m_projectile );
 
        for( auto protareBaseIter = protareBases.begin( ); protareBaseIter != protareBases.end( ); ++protareBaseIter ) {
            targetIDs.insert( (*protareBaseIter)->targetID( ) );
        }
    }
 
    for( auto targetIter = targetIDs.begin( ); targetIter != targetIDs.end( ); ++targetIter ) {
        (*list).push_back( (*targetIter) );
    }
 
    return( list );
}

◆ isThisDataAvailable() [1/2]

bool G4GIDI::isThisDataAvailable	(	std::string const &	a_lib_name,
		G4int	a_Z,
		G4int	a_A,
		G4int	a_M = 0 ) const

Returns true if the specified target exists in a map file and false otherwise.

Parameters

a_lib_name	[in] The evaluation. Call be an empty string.
a_Z	[in] The atomic number of the target.
a_A	[in] The mass number of the taret.
a_M	[in] The meta-stable index of the target.

Returns: Boolean value.

Definition at line 199 of file G4GIDI.cc.

                                                                                               {
 
    return( isThisDataAvailable( a_lib_name, G4GIDI_Misc_Z_A_m_ToName( a_Z, a_A, a_M ) ) );
}

Referenced by G4LENDManager::GetLENDTarget(), and isThisDataAvailable().

◆ isThisDataAvailable() [2/2]

bool G4GIDI::isThisDataAvailable	(	std::string const &	a_lib_name,
		std::string const &	a_targetName ) const

Returns true if the specified target exists in a map file and false otherwise.

Parameters

a_lib_name	[in] The evaluation. Call be an empty string.
a_targetName	[in] The target PoPs id.

Returns: Boolean value.

Definition at line 213 of file G4GIDI.cc.

                                                                                                   {
 
    for( auto mapIter = m_maps.begin( ); mapIter!= m_maps.end( ); ++mapIter ) {
        if( (*mapIter)->isProtareAvailable( m_projectile, a_targetName, "", a_lib_name ) ) return( true );
    }
 
    return( false );
}

◆ numberOfDataDirectories()

G4int G4GIDI::numberOfDataDirectories ( ) const

inline

Definition at line 139 of file G4GIDI.hh.

139{ return( static_cast<G4int>( m_maps.size( ) ) ); }

G4int

int G4int

Definition G4Types.hh:85

◆ projectileIP()

G4int G4GIDI::projectileIP ( ) const

inline

Definition at line 137 of file G4GIDI.hh.

137{ return( m_projectileIP ); }

◆ readTarget() [1/2]

G4GIDI_target * G4GIDI::readTarget	(	std::string const &	a_lib_name,
		G4int	a_Z,
		G4int	a_A,
		G4int	a_M = 0,
		bool	bind = true )

Returns the specified target or nullptr if the target does not exists.

Parameters

a_lib_name	[in] The evaluation. Call be an empty string.
a_Z	[in] The atomic number of the target.
a_A	[in] The mass number of the taret.
a_M	[in] The meta-stable index of the target.

Returns: Boolean value.

Definition at line 331 of file G4GIDI.cc.

                                                                                                     {
 
    return( readTarget( a_lib_name, G4GIDI_Misc_Z_A_m_ToName( a_Z, a_A, a_M ), bind ) );
}

Referenced by G4LENDManager::GetLENDTarget(), and readTarget().

◆ readTarget() [2/2]

G4GIDI_target * G4GIDI::readTarget	(	std::string const &	a_lib_name,
		std::string const &	a_targetName,
		bool	a_bind = true )

Returns the protare specified by a_targetName and the projectile for this.

Parameters

a_lib_name	[in] The evaluation. Call be an empty std::string.
a_targetName	[in] The target PoPs id.
a_bind	[in] If true, read target is added to member m_protares.

Returns: Boolean value.

Definition at line 346 of file G4GIDI.cc.

                                                                                                           {
 
    for( auto iter_protare = m_protares.cbegin( ); iter_protare != m_protares.cend( ); ++iter_protare ) {
        if( *(*iter_protare)->getName( ) == a_targetName ) return( nullptr );
    }
 
    GIDI::Construction::Settings construction( GIDI::Construction::ParseMode::all, GIDI::Construction::PhotoMode::nuclearOnly );
    construction.setGRIN_continuumGammas( true );
 
    for( auto mapIter = m_maps.begin( ); mapIter!= m_maps.end( ); ++mapIter ) {
        GIDI::Protare *GIDI_protare = (*mapIter)->protare( construction, G4GIDI_pops, m_projectile, a_targetName, "", a_lib_name );
        if( GIDI_protare != nullptr ) {
            LUPI::StatusMessageReporting smr;
            GIDI::Styles::TemperatureInfos temperatures = GIDI_protare->temperatures( );
            std::string label( temperatures[0].griddedCrossSection( ) );
            MCGIDI::Transporting::MC MC( G4GIDI_pops, m_projectile, &GIDI_protare->styles( ), label, GIDI::Transporting::DelayedNeutrons::off, 20 ); // FIXME: 20
            MC.setThrowOnError( false );
            MC.setSampleNonTransportingParticles( true );
            MCGIDI::DomainHash domainHash( 4000, 1e-8, 10 );
            std::set<size_t> reactionsToExclude;
 
            GIDI::Transporting::Particles particles;
            GIDI::Transporting::Particle neutron( PoPI::IDs::neutron );
            particles.add( neutron );
 
            GIDI::Styles::TemperatureInfos temperatures1;
            temperatures1.push_back( temperatures[0] );
            MCGIDI::Protare *MCGIDI_protare = MCGIDI::protareFromGIDIProtare( smr, *GIDI_protare, G4GIDI_pops, MC, particles, domainHash, 
                    temperatures1, reactionsToExclude );
            //if( !smr.isOk( ) ) throw LUPI::Exception( smr.constructFullMessage( "G4GIDI::readTarget:" ) );
 
            G4GIDI_target *protare = new G4GIDI_target( G4GIDI_pops, domainHash, *GIDI_protare, MCGIDI_protare );
            delete GIDI_protare;
            if( a_bind ) m_protares.push_back( protare );
            return( protare );
        }
    }
 
    return( nullptr );
}

◆ removeDataDirectory()

int G4GIDI::removeDataDirectory ( std::string const & a_dataDirectory )

Removes the map file with path a_dataDirectory from this.

Parameters

a_dataDirectory [in] A path to a map file to unload.

Definition at line 138 of file G4GIDI.cc.

                                                                  {
 
    std::size_t index = 0;
 
    for( auto mapIter = m_maps.begin( ); mapIter!= m_maps.end( ); ++mapIter, ++index ) {
        if( a_dataDirectory == (*mapIter)->fileName( ) ) {
            delete *mapIter;
   
            ++index;         
            for( ; index < m_maps.size( ); ++index )  m_maps[index-1] = m_maps[index];
            m_maps[index-1] = nullptr;
            m_maps.resize( m_maps.size( ) - 1 );
        }
    }
 
    return( 0 );
}

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ G4GIDI() [1/2]

◆ G4GIDI() [2/2]

◆ ~G4GIDI()

Member Function Documentation

◆ addDataDirectory()

◆ dataFilename() [1/2]

◆ dataFilename() [2/2]

◆ freeTarget() [1/3]

◆ freeTarget() [2/3]

◆ freeTarget() [3/3]

◆ getAlreadyReadTarget() [1/2]

◆ getAlreadyReadTarget() [2/2]

◆ getDataDirectories()

◆ getDataDirectoryAtIndex()

◆ getListOfReadTargetsNames()

◆ getNamesOfAvailableLibraries() [1/2]

◆ getNamesOfAvailableLibraries() [2/2]

◆ getNamesOfAvailableTargets()

◆ isThisDataAvailable() [1/2]

◆ isThisDataAvailable() [2/2]

◆ numberOfDataDirectories()

◆ projectileIP()

◆ readTarget() [1/2]

◆ readTarget() [2/2]

◆ removeDataDirectory()