Scine::Swoose  2.1.0
This is the SCINE module Swoose.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Scine::SwooseUtilities::AtomicInformationReader Class Reference
Collaboration diagram for Scine::SwooseUtilities::AtomicInformationReader:
Collaboration graph

Public Member Functions

 AtomicInformationReader (Core::Log &log)
 Constructor.
 
void read (const std::string &filename, std::map< int, int > &formalCharges, std::map< int, int > &unpairedElectrons, int numberOfAtoms)
 Reads the formal charges and number of unpaired electrons information from file and updates the ParametrizationData object accordingly. More...
 
std::pair< int, int > read (const std::string &filename, int numberOfAtoms)
 Reads the atomic information file and evaluates the total formal charge and number of unpaired electrons. More...
 

Member Function Documentation

void Scine::SwooseUtilities::AtomicInformationReader::read ( const std::string &  filename,
std::map< int, int > &  formalCharges,
std::map< int, int > &  unpairedElectrons,
int  numberOfAtoms 
)

Reads the formal charges and number of unpaired electrons information from file and updates the ParametrizationData object accordingly.

Parameters
filenamePath to the file with the information.
formalChargesInformation about formal charges to update in this function.
unpairedElectronsInformation about unpaired Electrons to update in this function.
numberOfAtomsNumber of atoms in the system.
std::pair< int, int > Scine::SwooseUtilities::AtomicInformationReader::read ( const std::string &  filename,
int  numberOfAtoms 
)

Reads the atomic information file and evaluates the total formal charge and number of unpaired electrons.

Parameters
filenamePath to the file with the information.
numberOfAtomsNumber of atoms in the system.
Returns
A pair of total charge and unpaired electrons.

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