nnp::Dataset Class Reference

Collect and process large data sets. More...

#include <Dataset.h>

Inheritance diagram for nnp::Dataset:

Collaboration diagram for nnp::Dataset:

Public Member Functions
	Dataset ()
	Constructor, initialize members. More...
	~Dataset ()
	Destructor. More...
void	setupMPI ()
	Initialize MPI with MPI_COMM_WORLD. More...
void	setupMPI (MPI_Comm *communicator)
	Initialize MPI with given communicator. More...
void	setupRandomNumberGenerator ()
	Initialize random number generator. More...
std::size_t	getNumStructures (std::ifstream &dataFile)
	Get number of structures in data file. More...
int	calculateBufferSize (Structure const &structure) const
	Calculate buffer size required to communicate structure via MPI. More...
int	sendStructure (Structure const &structure, int dest) const
	Send one structure to destination process. More...
int	recvStructure (Structure *structure, int src)
	Receive one structure from source process. More...
int	distributeStructures (bool randomize, bool excludeRank0=false, std::string const &fileName="input.data")
	Read data file and distribute structures among processors. More...
std::size_t	prepareNumericForces (Structure &original, double delta)
	Prepare numeric force check for a single structure. More...
void	toNormalizedUnits ()
	Switch all structures to normalized units. More...
void	toPhysicalUnits ()
	Switch all structures to physical units. More...
void	collectSymmetryFunctionStatistics ()
	Collect symmetry function statistics from all processors. More...
void	writeSymmetryFunctionScaling (std::string const &fileName="scaling.data")
	Write symmetry function scaling values to file. More...
void	writeSymmetryFunctionHistograms (std::size_t numBins, std::string fileNameFormat="sf.%03zu.%04zu.histo")
	Calculate and write symmetry function histograms. More...
void	writeSymmetryFunctionFile (std::string fileName="function.data")
	Write symmetry function legacy file ("function.data"). More...
std::size_t	writeNeighborHistogram (std::string const &fileNameHisto="neighbors.histo", std::string const &fileNameStructure="neighbors.out")
	Calculate and write neighbor histogram and per-structure statistics. More...
void	sortNeighborLists ()
	Sort all neighbor lists according to element and distance. More...
void	writeNeighborLists (std::string const &fileName="neighbor-list.data")
	Write neighbor list file. More...
void	writeAtomicEnvironmentFile (std::vector< std::vector< std::size_t > > neighCutoff, bool derivatives, std::string const &fileNamePrefix="atomic-env")
	Write atomic environment file. More...
void	collectError (std::string const &property, std::map< std::string, double > &error, std::size_t &count) const
	Collect error metrics of a property over all MPI procs. More...
void	combineFiles (std::string filePrefix) const
	Combine individual MPI proc files to one. More...
Public Member Functions inherited from nnp::Mode
	Mode ()
void	initialize ()
	Write welcome message with version information. More...
void	loadSettingsFile (std::string const &fileName="input.nn")
	Open settings file and load all keywords into memory. More...
void	setupGeneric (std::string const &nnpDir="", bool skipNormalize=false, bool initialHardness=false)
	Combine multiple setup routines and provide a basic NNP setup. More...
void	setupNormalization (bool standalone=true)
	Set up normalization. More...
virtual void	setupElementMap ()
	Set up the element map. More...
virtual void	setupElements ()
	Set up all Element instances. More...
void	setupCutoff ()
	Set up cutoff function for all symmetry functions. More...
virtual void	setupSymmetryFunctions ()
	Set up all symmetry functions. More...
void	setupSymmetryFunctionScalingNone ()
	Set up "empy" symmetry function scaling. More...
virtual void	setupSymmetryFunctionScaling (std::string const &fileName="scaling.data")
	Set up symmetry function scaling from file. More...
virtual void	setupSymmetryFunctionGroups ()
	Set up symmetry function groups. More...
virtual void	setupSymmetryFunctionCache (bool verbose=false)
	Set up symmetry function cache. More...
void	setupSymmetryFunctionMemory (bool verbose=false)
	Extract required memory dimensions for symmetry function derivatives. More...
void	setupSymmetryFunctionStatistics (bool collectStatistics, bool collectExtrapolationWarnings, bool writeExtrapolationWarnings, bool stopOnExtrapolationWarnings)
	Set up symmetry function statistics collection. More...
void	setupCutoffMatrix ()
	Setup matrix storing all symmetry function cut-offs for each element. More...
virtual void	setupNeuralNetwork ()
	Set up neural networks for all elements. More...
virtual void	setupNeuralNetworkWeights (std::map< std::string, std::string > fileNameFormats=std::map< std::string, std::string >())
	Set up neural network weights from files with given name format. More...
virtual void	setupNeuralNetworkWeights (std::string directoryPrefix, std::map< std::string, std::string > fileNameFormats=std::map< std::string, std::string >())
	Set up neural network weights from files with given name format. More...
virtual void	setupElectrostatics (bool initialHardness=false, std::string directoryPrefix="", std::string fileNameFormat="hardness.%03zu.data")
	Set up electrostatics related stuff (hardness, screening, ...). More...
void	calculateSymmetryFunctions (Structure &structure, bool const derivatives)
	Calculate all symmetry functions for all atoms in given structure. More...
void	calculateSymmetryFunctionGroups (Structure &structure, bool const derivatives)
	Calculate all symmetry function groups for all atoms in given structure. More...
void	calculateAtomicNeuralNetworks (Structure &structure, bool const derivatives, std::string id="")
	Calculate atomic neural networks for all atoms in given structure. More...
void	chargeEquilibration (Structure &structure, bool const derivativesElec)
	Perform global charge equilibration method. More...
void	calculateEnergy (Structure &structure) const
	Calculate potential energy for a given structure. More...
void	calculateCharge (Structure &structure) const
	Calculate total charge for a given structure. More...
void	calculateForces (Structure &structure) const
	Calculate forces for all atoms in given structure. More...
void	evaluateNNP (Structure &structure, bool useForces=true, bool useDEdG=true)
	Evaluate neural network potential (includes total energy, optionally forces and in some cases charges. More...
void	addEnergyOffset (Structure &structure, bool ref=true)
	Add atomic energy offsets to reference energy. More...
void	removeEnergyOffset (Structure &structure, bool ref=true)
	Remove atomic energy offsets from reference energy. More...
double	getEnergyOffset (Structure const &structure) const
	Get atomic energy offset for given structure. More...
double	getEnergyWithOffset (Structure const &structure, bool ref=true) const
	Add atomic energy offsets and return energy. More...
double	normalized (std::string const &property, double value) const
	Apply normalization to given property. More...
double	normalizedEnergy (Structure const &structure, bool ref=true) const
	Apply normalization to given energy of structure. More...
double	physical (std::string const &property, double value) const
	Undo normalization for a given property. More...
double	physicalEnergy (Structure const &structure, bool ref=true) const
	Undo normalization for a given energy of structure. More...
void	convertToNormalizedUnits (Structure &structure) const
	Convert one structure to normalized units. More...
void	convertToPhysicalUnits (Structure &structure) const
	Convert one structure to physical units. More...
void	logEwaldCutoffs ()
	Logs Ewald params whenever they change. More...
std::size_t	getNumExtrapolationWarnings () const
	Count total number of extrapolation warnings encountered for all elements and symmetry functions. More...
void	resetExtrapolationWarnings ()
	Erase all extrapolation warnings and reset counters. More...
NNPType	getNnpType () const
	Getter for Mode::nnpType. More...
double	getMeanEnergy () const
	Getter for Mode::meanEnergy. More...
double	getConvEnergy () const
	Getter for Mode::convEnergy. More...
double	getConvLength () const
	Getter for Mode::convLength. More...
double	getConvCharge () const
	Getter for Mode::convCharge. More...
double	getMaxCutoffRadius () const
	Getter for Mode::maxCutoffRadius. More...
std::size_t	getNumElements () const
	Getter for Mode::numElements. More...
std::vector< std::size_t >	getNumSymmetryFunctions () const
	Get number of symmetry functions per element. More...
bool	useNormalization () const
	Check if normalization is enabled. More...
bool	settingsKeywordExists (std::string const &keyword) const
	Check if keyword was found in settings file. More...
std::string	settingsGetValue (std::string const &keyword) const
	Get value for given keyword in Settings instance. More...
std::vector< std::size_t >	pruneSymmetryFunctionsRange (double threshold)
	Prune symmetry functions according to their range and write settings file. More...
std::vector< std::size_t >	pruneSymmetryFunctionsSensitivity (double threshold, std::vector< std::vector< double > > sensitivity)
	Prune symmetry functions with sensitivity analysis data. More...
void	writePrunedSettingsFile (std::vector< std::size_t > prune, std::string fileName="output.nn") const
	Copy settings file but comment out lines provided. More...
void	writeSettingsFile (std::ofstream *const &file) const
	Write complete settings file. More...

Public Attributes
std::vector< Structure >	structures
	All structures in this dataset. More...
Public Attributes inherited from nnp::Mode
ElementMap	elementMap
	Global element map, populated by setupElementMap(). More...
Log	log
	Global log file. More...

Protected Attributes
int	myRank
	My process ID. More...
int	numProcs
	Total number of MPI processors. More...
std::size_t	numStructures
	Total number of structures in dataset. More...
std::string	myName
	My processor name. More...
MPI_Comm	comm
	Global MPI communicator. More...
gsl_rng *	rng
	GSL random number generator (different seed for each MPI process). More...
gsl_rng *	rngGlobal
	Global GSL random number generator (equal seed for each MPI process). More...
Protected Attributes inherited from nnp::Mode
NNPType	nnpType
bool	normalize
bool	checkExtrapolationWarnings
std::size_t	numElements
std::vector< std::size_t >	minNeighbors
std::vector< double >	minCutoffRadius
double	maxCutoffRadius
double	cutoffAlpha
double	meanEnergy
double	convEnergy
double	convLength
double	convCharge
double	fourPiEps
EwaldSetup	ewaldSetup
settings::Settings	settings
SymFnc::ScalingType	scalingType
CutoffFunction::CutoffType	cutoffType
ScreeningFunction	screeningFunction
std::vector< Element >	elements
std::vector< std::string >	nnk
std::map< std::string, NNSetup >	nns
std::vector< std::vector< double > >	cutoffs
	Matrix storing all symmetry function cut-offs for all elements. More...
ErfcBuf	erfcBuf

Additional Inherited Members
Public Types inherited from nnp::Mode
enum class	NNPType { HDNNP_2G = 2 , HDNNP_4G = 4 , HDNNP_Q = 10 }
Protected Member Functions inherited from nnp::Mode
void	readNeuralNetworkWeights (std::string const &id, std::string const &fileName)
	Read in weights for a specific type of neural network. More...

Detailed Description

Collect and process large data sets.

Definition at line 34 of file Dataset.h.

Constructor & Destructor Documentation

Dataset()

Dataset::Dataset

(

)

Constructor, initialize members.

Definition at line 36 of file Dataset.cpp.

                 : Mode(),
                     myRank       (0   ),
                     numProcs     (0   ),
                     numStructures(0   ),
                     myName       (""  ),
                     rng          (NULL),
                     rngGlobal    (NULL)
{
}

~Dataset()

Dataset::~Dataset

(

)

Destructor.

Definition at line 46 of file Dataset.cpp.

{
    if (rng != NULL) gsl_rng_free(rng);
    if (rngGlobal != NULL) gsl_rng_free(rngGlobal);
}

References rng, and rngGlobal.

Member Function Documentation

setupMPI() [1/2]

void Dataset::setupMPI

(

)

Initialize MPI with MPI_COMM_WORLD.

Definition at line 52 of file Dataset.cpp.

{
    MPI_Comm tmpComm;
    MPI_Comm_dup(MPI_COMM_WORLD, &tmpComm);
    setupMPI(&tmpComm);
    MPI_Comm_free(&tmpComm);
 
    return;
}

References setupMPI().

Referenced by main(), and setupMPI().

Here is the call graph for this function:

Here is the caller graph for this function:

setupMPI() [2/2]

void Dataset::setupMPI

(

MPI_Comm *

communicator

)

Initialize MPI with given communicator.

Parameters

[in]

communicator

Provided communicator which should be used.

Definition at line 62 of file Dataset.cpp.

{
    log << "\n";
    log << "*** SETUP: MPI **************************"
           "**************************************\n";
    log << "\n";
 
    int        bufferSize = 0;
    char       line[MPI_MAX_PROCESSOR_NAME];
    MPI_Status ms;
 
    MPI_Comm_dup(*communicator, &comm);
    MPI_Comm_rank(comm, &myRank);
    MPI_Comm_size(comm, &numProcs);
    MPI_Get_processor_name(line, &bufferSize);
    myName = line;
 
    log << strpr("Number of processors: %d\n", numProcs);
    log << strpr("Process %d of %d (rank %d): %s\n",
                 myRank + 1,
                 numProcs,
                 myRank,
                 myName.c_str());
    for (int i = 1; i < numProcs; ++i)
    {
        if (myRank == 0)
        {
            MPI_Recv(&bufferSize, 1, MPI_INT, i, 0, comm, &ms);
            MPI_Recv(line, bufferSize, MPI_CHAR, i, 0, comm, &ms);
            log << strpr("Process %d of %d (rank %d): %s\n",
                         i + 1,
                         numProcs,
                         i,
                         line);
        }
        else if (myRank == i)
        {
            MPI_Send(&bufferSize, 1, MPI_INT, 0, 0, comm);
            MPI_Send(line, bufferSize, MPI_CHAR, 0, 0, comm);
        }
    }
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References comm, nnp::Mode::log, myName, myRank, numProcs, and nnp::strpr().

Here is the call graph for this function:

setupRandomNumberGenerator()

void Dataset::setupRandomNumberGenerator

(

)

Initialize random number generator.

CAUTION: MPI communicator required, call setupMPI() before!

Definition at line 110 of file Dataset.cpp.

{
    log << "\n";
    log << "*** SETUP: RANDOM NUMBER GENERATOR ******"
           "**************************************\n";
    log << "\n";
 
    // Get random seed from settings file.
    unsigned long seed = atoi(settings["random_seed"].c_str());
    unsigned long seedGlobal = 0;
 
    if (myRank == 0)
    {
        log << strpr("Random number generator seed: %d\n", seed);
        if (seed == 0)
        {
            log << "WARNING: Seed set to 0. This is a special value for the "
                   "gsl_rng_set() routine (see GSL docs).\n";
        }
        // Initialize personal RNG of process 0 with the given seed.
        rng = gsl_rng_alloc(gsl_rng_mt19937);
        gsl_rng_set(rng, seed);
        log << strpr("Seed for rank %d: %lu\n", 0, seed);
        for (int i = 1; i < numProcs; ++i)
        {
            // Get new seeds for all remaining processes with the RNG.
            seed = gsl_rng_get(rng);
            log << strpr("Seed for rank %d: %lu\n", i, seed);
            MPI_Send(&seed, 1, MPI_UNSIGNED_LONG, i, 0, comm);
        }
        // Set seed for global RNG.
        seedGlobal = gsl_rng_get(rng);
    }
    else
    {
        // Receive seed for personal RNG.
        MPI_Status ms;
        MPI_Recv(&seed, 1, MPI_UNSIGNED_LONG, 0, 0, comm, &ms);
        log << strpr("Seed for rank %d: %lu\n", myRank, seed);
        rng = gsl_rng_alloc(gsl_rng_taus);
        gsl_rng_set(rng, seed);
    }
    // Rank 0 broadcasts global seed.
    MPI_Bcast(&seedGlobal, 1, MPI_UNSIGNED_LONG, 0, comm);
    log << strpr("Seed for global RNG: %lu\n", seedGlobal);
    // All processes initialize global RNG.
    rngGlobal = gsl_rng_alloc(gsl_rng_taus);
    gsl_rng_set(rngGlobal, seedGlobal);
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References comm, nnp::Mode::log, myRank, numProcs, rng, rngGlobal, nnp::Mode::settings, and nnp::strpr().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

getNumStructures()

size_t Dataset::getNumStructures

(

std::ifstream &

dataFile

)

Get number of structures in data file.

Parameters

[in,out]

dataFile

Data file name.

Returns

Number of structures.

Definition at line 709 of file Dataset.cpp.

{
    size_t count = 0;
    string line;
    vector<string> splitLine;
 
    while (getline(dataFile, line))
    {
        splitLine = split(reduce(line));
        if (!splitLine.empty() && splitLine.at(0) == "begin") count++;
    }
 
    return count;
}

References nnp::reduce(), and nnp::split().

Referenced by distributeStructures(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

calculateBufferSize()

int Dataset::calculateBufferSize

(

Structure const &

structure

)

const

Calculate buffer size required to communicate structure via MPI.

Parameters

[in]

structure

Input structure.

Returns

Buffer size in bytes.

Definition at line 165 of file Dataset.cpp.

{
    int              bs   = 0;         // Send buffer size.
    int              is   = 0;         // int size.
    int              i64s = 0;         // int64_t size.
    int              ss   = 0;         // size_t size.
    int              ds   = 0;         // double size.
    int              cs   = 0;         // char size.
    Structure const& s   = structure; // Shortcut for structure.
 
    MPI_Pack_size(1, MPI_INT    , comm, &is  );
    MPI_Pack_size(1, MPI_INT64_T, comm, &i64s);
    MPI_Pack_size(1, MPI_SIZE_T , comm, &ss  );
    MPI_Pack_size(1, MPI_DOUBLE , comm, &ds  );
    MPI_Pack_size(1, MPI_CHAR   , comm, &cs  );
 
    // Structure
    bs += 5 * cs + 4 * ss + 4 * is + 5 * ds;
    // Structure.comment
    bs += ss;
    bs += (s.comment.length() + 1) * cs;
    // Structure.box
    bs += 9 * ds;
    // Structure.invbox
    bs += 9 * ds;
    // Structure.numAtomsPerElement
    bs += ss;
    bs += s.numAtomsPerElement.size() * ss;
    // Structure.atoms
    bs += ss;
    bs += s.atoms.size() * (4 * cs + 6 * ss + i64s + 4 * ds + 3 * 3 * ds);
    for (vector<Atom>::const_iterator it = s.atoms.begin();
         it != s.atoms.end(); ++it)
    {
        // Atom.neighborsUnique
        bs += ss;
        bs += it->neighborsUnique.size() * ss;
        // Atom.numNeighborsPerElement
        bs += ss;
        bs += it->numNeighborsPerElement.size() * ss;
        // Atom.numSymmetryFunctionDerivatives
        bs += ss;
        bs += it->numSymmetryFunctionDerivatives.size() * ss;
#ifndef N2P2_NO_SF_CACHE
        // Atom.cacheSizePerElement
        bs += ss;
        bs += it->cacheSizePerElement.size() * ss;
#endif
        // Atom.G
        bs += ss;
        bs += it->G.size() * ds;
        // Atom.dEdG
        bs += ss;
        bs += it->dEdG.size() * ds;
        // Atom.dQdG
        bs += ss;
        bs += it->dQdG.size() * ds;
#ifdef N2P2_FULL_SFD_MEMORY
        // Atom.dGdxia
        bs += ss;
        bs += it->dGdxia.size() * ds;
#endif
        // Atom.dGdr
        bs += ss;
        bs += it->dGdr.size() * 3 * ds;
        // Atom.neighbors
        bs += ss;
        for (vector<Atom::Neighbor>::const_iterator it2 =
             it->neighbors.begin(); it2 != it->neighbors.end(); ++it2)
        {
            // Neighbor
            bs += 2 * ss + i64s + ds + 3 * ds;
#ifndef N2P2_NO_SF_CACHE
            // Neighbor.cache
            bs += ss;
            bs += it2->cache.size() * ds;
#endif
            // Neighbor.dGdr
            bs += ss;
            bs += it2->dGdr.size() * 3 * ds;
        }
    }
 
    return bs;
}

References nnp::Structure::atoms, comm, nnp::Structure::comment, MPI_SIZE_T, and nnp::Structure::numAtomsPerElement.

Referenced by main(), and sendStructure().

Here is the caller graph for this function:

sendStructure()

int Dataset::sendStructure	(	Structure const &	structure,
		int	dest
	)		const

Send one structure to destination process.

Parameters

[in]	structure	Source structure.
[in]	dest	MPI rank of destination process.

Returns

Number of bytes sent.

Definition at line 251 of file Dataset.cpp.

{
    unsigned char*   buf = 0;         // Send buffer.
    int              bs  = 0;         // Send buffer size.
    int              p   = 0;         // Send buffer position.
    int              ts  = 0;         // Size for temporary stuff.
    Structure const& s   = structure; // Shortcut for structure.
 
    bs = calculateBufferSize(s);
    buf = new unsigned char[bs];
 
    // Structure
    MPI_Pack(&(s.isPeriodic                    ), 1, MPI_CHAR  , buf, bs, &p, comm);
    MPI_Pack(&(s.isTriclinic                   ), 1, MPI_CHAR  , buf, bs, &p, comm);
    MPI_Pack(&(s.hasNeighborList               ), 1, MPI_CHAR  , buf, bs, &p, comm);
    MPI_Pack(&(s.hasSymmetryFunctions          ), 1, MPI_CHAR  , buf, bs, &p, comm);
    MPI_Pack(&(s.hasSymmetryFunctionDerivatives), 1, MPI_CHAR  , buf, bs, &p, comm);
    MPI_Pack(&(s.index                         ), 1, MPI_SIZE_T, buf, bs, &p, comm);
    MPI_Pack(&(s.numAtoms                      ), 1, MPI_SIZE_T, buf, bs, &p, comm);
    MPI_Pack(&(s.numElements                   ), 1, MPI_SIZE_T, buf, bs, &p, comm);
    MPI_Pack(&(s.numElementsPresent            ), 1, MPI_SIZE_T, buf, bs, &p, comm);
    MPI_Pack(&(s.pbc                           ), 3, MPI_INT   , buf, bs, &p, comm);
    MPI_Pack(&(s.energy                        ), 1, MPI_DOUBLE, buf, bs, &p, comm);
    MPI_Pack(&(s.energyRef                     ), 1, MPI_DOUBLE, buf, bs, &p, comm);
    MPI_Pack(&(s.charge                        ), 1, MPI_DOUBLE, buf, bs, &p, comm);
    MPI_Pack(&(s.chargeRef                     ), 1, MPI_DOUBLE, buf, bs, &p, comm);
    MPI_Pack(&(s.volume                        ), 1, MPI_DOUBLE, buf, bs, &p, comm);
    MPI_Pack(&(s.sampleType                    ), 1, MPI_INT   , buf, bs, &p, comm);
 
    // Strucuture.comment
    ts = s.comment.length() + 1;
    MPI_Pack(&ts, 1, MPI_SIZE_T, buf, bs, &p, comm);
    MPI_Pack(s.comment.c_str(), ts, MPI_CHAR, buf, bs, &p, comm);
 
    // Structure.box
    for (size_t i = 0; i < 3; ++i)
    {
        MPI_Pack(s.box[i].r, 3, MPI_DOUBLE, buf, bs, &p, comm);
    }
 
    // Structure.invbox
    for (size_t i = 0; i < 3; ++i)
    {
        MPI_Pack(s.invbox[i].r, 3, MPI_DOUBLE, buf, bs, &p, comm);
    }
 
    // Structure.numAtomsPerElement
    ts = s.numAtomsPerElement.size();
    MPI_Pack(&ts, 1, MPI_SIZE_T, buf, bs, &p, comm);
    if (ts > 0)
    {
        MPI_Pack(&(s.numAtomsPerElement.front()), ts, MPI_SIZE_T, buf, bs, &p, comm);
    }
 
    // Structure.atoms
    ts = s.atoms.size();
    MPI_Pack(&ts, 1, MPI_SIZE_T, buf, bs, &p, comm);
    if (ts > 0)
    {
        for (vector<Atom>::const_iterator it = s.atoms.begin();
             it != s.atoms.end(); ++it)
        {
            // Atom
            MPI_Pack(&(it->hasNeighborList               ), 1, MPI_CHAR,    buf, bs, &p, comm);
            MPI_Pack(&(it->hasSymmetryFunctions          ), 1, MPI_CHAR,    buf, bs, &p, comm);
            MPI_Pack(&(it->hasSymmetryFunctionDerivatives), 1, MPI_CHAR,    buf, bs, &p, comm);
            MPI_Pack(&(it->useChargeNeuron               ), 1, MPI_CHAR,    buf, bs, &p, comm);
            MPI_Pack(&(it->index                         ), 1, MPI_SIZE_T,  buf, bs, &p, comm);
            MPI_Pack(&(it->indexStructure                ), 1, MPI_SIZE_T,  buf, bs, &p, comm);
            MPI_Pack(&(it->tag                           ), 1, MPI_INT64_T, buf, bs, &p, comm);
            MPI_Pack(&(it->element                       ), 1, MPI_SIZE_T,  buf, bs, &p, comm);
            MPI_Pack(&(it->numNeighbors                  ), 1, MPI_SIZE_T,  buf, bs, &p, comm);
            MPI_Pack(&(it->numNeighborsUnique            ), 1, MPI_SIZE_T,  buf, bs, &p, comm);
            MPI_Pack(&(it->numSymmetryFunctions          ), 1, MPI_SIZE_T,  buf, bs, &p, comm);
            MPI_Pack(&(it->energy                        ), 1, MPI_DOUBLE,  buf, bs, &p, comm);
            MPI_Pack(&(it->chi                           ), 1, MPI_DOUBLE,  buf, bs, &p, comm);
            MPI_Pack(&(it->charge                        ), 1, MPI_DOUBLE,  buf, bs, &p, comm);
            MPI_Pack(&(it->chargeRef                     ), 1, MPI_DOUBLE,  buf, bs, &p, comm);
            MPI_Pack(&(it->r.r                           ), 3, MPI_DOUBLE,  buf, bs, &p, comm);
            MPI_Pack(&(it->f.r                           ), 3, MPI_DOUBLE,  buf, bs, &p, comm);
            MPI_Pack(&(it->fRef.r                        ), 3, MPI_DOUBLE,  buf, bs, &p, comm);
 
            // Atom.neighborsUnique
            size_t ts2 = it->neighborsUnique.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->neighborsUnique.front()), ts2, MPI_SIZE_T, buf, bs, &p, comm);
            }
 
            // Atom.numNeighborsPerElement
            ts2 = it->numNeighborsPerElement.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->numNeighborsPerElement.front()), ts2, MPI_SIZE_T, buf, bs, &p, comm);
            }
 
            // Atom.numSymmetryFunctionDerivatives
            ts2 = it->numSymmetryFunctionDerivatives.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->numSymmetryFunctionDerivatives.front()), ts2, MPI_SIZE_T, buf, bs, &p, comm);
            }
 
#ifndef N2P2_NO_SF_CACHE
            // Atom.cacheSizePerElement
            ts2 = it->cacheSizePerElement.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->cacheSizePerElement.front()), ts2, MPI_SIZE_T, buf, bs, &p, comm);
            }
#endif
 
            // Atom.G
            ts2 = it->G.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->G.front()), ts2, MPI_DOUBLE, buf, bs, &p, comm);
            }
 
            // Atom.dEdG
            ts2 = it->dEdG.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->dEdG.front()), ts2, MPI_DOUBLE, buf, bs, &p, comm);
            }
 
            // Atom.dQdG
            ts2 = it->dQdG.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->dQdG.front()), ts2, MPI_DOUBLE, buf, bs, &p, comm);
            }
 
#ifdef N2P2_FULL_SFD_MEMORY
            // Atom.dGdxia
            ts2 = it->dGdxia.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                MPI_Pack(&(it->dGdxia.front()), ts2, MPI_DOUBLE, buf, bs, &p, comm);
            }
#endif
 
            // Atom.dGdr
            ts2 = it->dGdr.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                for (vector<Vec3D>::const_iterator it2 = it->dGdr.begin();
                     it2 != it->dGdr.end(); ++it2)
                {
                    MPI_Pack(it2->r, 3, MPI_DOUBLE, buf, bs, &p, comm);
                }
            }
 
            // Atom.neighbors
            ts2 = it->neighbors.size();
            MPI_Pack(&ts2, 1, MPI_SIZE_T, buf, bs, &p, comm);
            if (ts2 > 0)
            {
                for (vector<Atom::Neighbor>::const_iterator it2 =
                     it->neighbors.begin(); it2 != it->neighbors.end(); ++it2)
                {
                    // Neighbor
                    MPI_Pack(&(it2->index      ), 1, MPI_SIZE_T , buf, bs, &p, comm);
                    MPI_Pack(&(it2->tag        ), 1, MPI_INT64_T, buf, bs, &p, comm);
                    MPI_Pack(&(it2->element    ), 1, MPI_SIZE_T , buf, bs, &p, comm);
                    MPI_Pack(&(it2->d          ), 1, MPI_DOUBLE , buf, bs, &p, comm);
                    MPI_Pack(  it2->dr.r        , 3, MPI_DOUBLE , buf, bs, &p, comm);
 
                    size_t ts3 = 0;
#ifndef N2P2_NO_SF_CACHE
                    // Neighbor.cache
                    ts3 = it2->cache.size();
                    MPI_Pack(&ts3, 1, MPI_SIZE_T, buf, bs, &p, comm);
                    if (ts3 > 0)
                    {
                        MPI_Pack(&(it2->cache.front()), ts3, MPI_DOUBLE, buf, bs, &p, comm);
                    }
#endif
 
                    // Neighbor.dGdr
                    ts3 = it2->dGdr.size();
                    MPI_Pack(&ts3, 1, MPI_SIZE_T, buf, bs, &p, comm);
                    if (ts3 > 0)
                    {
                        for (vector<Vec3D>::const_iterator it3 =
                             it2->dGdr.begin(); it3 != it2->dGdr.end(); ++it3)
                        {
                            MPI_Pack(it3->r, 3, MPI_DOUBLE, buf, bs, &p, comm);
                        }
                    }
                }
            }
        }
    }
 
    MPI_Send(&bs, 1, MPI_INT, dest, 0, comm);
    MPI_Send(buf, bs, MPI_PACKED, dest, 0, comm);
 
    delete[] buf;
 
    return bs;
}

References nnp::Structure::atoms, nnp::Structure::box, calculateBufferSize(), nnp::Structure::charge, nnp::Structure::chargeRef, comm, nnp::Structure::comment, nnp::Structure::energy, nnp::Structure::energyRef, nnp::Structure::hasNeighborList, nnp::Structure::hasSymmetryFunctionDerivatives, nnp::Structure::hasSymmetryFunctions, nnp::Structure::index, nnp::Structure::invbox, nnp::Structure::isPeriodic, nnp::Structure::isTriclinic, MPI_SIZE_T, nnp::Structure::numAtoms, nnp::Structure::numAtomsPerElement, nnp::Structure::numElements, nnp::Structure::numElementsPresent, p, nnp::Structure::pbc, nnp::Vec3D::r, nnp::Structure::sampleType, and nnp::Structure::volume.

Referenced by distributeStructures(), and prepareNumericForces().

Here is the call graph for this function:

Here is the caller graph for this function:

recvStructure()

int Dataset::recvStructure	(	Structure *	structure,
		int	src
	)

Receive one structure from source process.

Parameters

[in]	structure	Source structure.
[in]	src	MPI rank of source process.

Returns

Number of bytes received.

Definition at line 463 of file Dataset.cpp.

{
    unsigned char*   buf = 0;         // Receive buffer.
    int              bs  = 0;         // Receive buffer size.
    int              p   = 0;         // Receive buffer position.
    int              ts  = 0;         // Size for temporary stuff.
    Structure* const s   = structure; // Shortcut for structure.
    MPI_Status       ms;
 
    // Receive buffer size and extract source.
    MPI_Recv(&bs, 1, MPI_INT, src, 0, comm, &ms);
    src = ms.MPI_SOURCE;
 
    buf = new unsigned char[bs];
 
    MPI_Recv(buf, bs, MPI_PACKED, src, 0, comm, &ms);
 
    // Structure
    MPI_Unpack(buf, bs, &p, &(s->isPeriodic                    ), 1, MPI_CHAR  , comm);
    MPI_Unpack(buf, bs, &p, &(s->isTriclinic                   ), 1, MPI_CHAR  , comm);
    MPI_Unpack(buf, bs, &p, &(s->hasNeighborList               ), 1, MPI_CHAR  , comm);
    MPI_Unpack(buf, bs, &p, &(s->hasSymmetryFunctions          ), 1, MPI_CHAR  , comm);
    MPI_Unpack(buf, bs, &p, &(s->hasSymmetryFunctionDerivatives), 1, MPI_CHAR  , comm);
    MPI_Unpack(buf, bs, &p, &(s->index                         ), 1, MPI_SIZE_T, comm);
    MPI_Unpack(buf, bs, &p, &(s->numAtoms                      ), 1, MPI_SIZE_T, comm);
    MPI_Unpack(buf, bs, &p, &(s->numElements                   ), 1, MPI_SIZE_T, comm);
    MPI_Unpack(buf, bs, &p, &(s->numElementsPresent            ), 1, MPI_SIZE_T, comm);
    MPI_Unpack(buf, bs, &p, &(s->pbc                           ), 3, MPI_INT   , comm);
    MPI_Unpack(buf, bs, &p, &(s->energy                        ), 1, MPI_DOUBLE, comm);
    MPI_Unpack(buf, bs, &p, &(s->energyRef                     ), 1, MPI_DOUBLE, comm);
    MPI_Unpack(buf, bs, &p, &(s->charge                        ), 1, MPI_DOUBLE, comm);
    MPI_Unpack(buf, bs, &p, &(s->chargeRef                     ), 1, MPI_DOUBLE, comm);
    MPI_Unpack(buf, bs, &p, &(s->volume                        ), 1, MPI_DOUBLE, comm);
    MPI_Unpack(buf, bs, &p, &(s->sampleType                    ), 1, MPI_INT   , comm);
 
    // Strucuture.comment
    ts = 0;
    MPI_Unpack(buf, bs, &p, &ts, 1, MPI_SIZE_T, comm);
    char* comment = new char[ts];
    MPI_Unpack(buf, bs, &p, comment, ts, MPI_CHAR, comm);
    s->comment = comment;
    delete[] comment;
 
    // Structure.box
    for (size_t i = 0; i < 3; ++i)
    {
        MPI_Unpack(buf, bs, &p, s->box[i].r, 3, MPI_DOUBLE, comm);
    }
 
    // Structure.invbox
    for (size_t i = 0; i < 3; ++i)
    {
        MPI_Unpack(buf, bs, &p, s->invbox[i].r, 3, MPI_DOUBLE, comm);
    }
 
    // Structure.numAtomsPerElement
    ts = 0;
    MPI_Unpack(buf, bs, &p, &ts, 1, MPI_SIZE_T, comm);
    if (ts > 0)
    {
        s->numAtomsPerElement.clear();
        s->numAtomsPerElement.resize(ts, 0);
        MPI_Unpack(buf, bs, &p, &(s->numAtomsPerElement.front()), ts, MPI_SIZE_T, comm);
    }
 
    // Structure.atoms
    ts = 0;
    MPI_Unpack(buf, bs, &p, &ts, 1, MPI_SIZE_T, comm);
    if (ts > 0)
    {
        s->atoms.clear();
        s->atoms.resize(ts);
        for (vector<Atom>::iterator it = s->atoms.begin();
             it != s->atoms.end(); ++it)
        {
            // Atom
            MPI_Unpack(buf, bs, &p, &(it->hasNeighborList               ), 1, MPI_CHAR,    comm);
            MPI_Unpack(buf, bs, &p, &(it->hasSymmetryFunctions          ), 1, MPI_CHAR,    comm);
            MPI_Unpack(buf, bs, &p, &(it->hasSymmetryFunctionDerivatives), 1, MPI_CHAR,    comm);
            MPI_Unpack(buf, bs, &p, &(it->useChargeNeuron               ), 1, MPI_CHAR,    comm);
            MPI_Unpack(buf, bs, &p, &(it->index                         ), 1, MPI_SIZE_T,  comm);
            MPI_Unpack(buf, bs, &p, &(it->indexStructure                ), 1, MPI_SIZE_T,  comm);
            MPI_Unpack(buf, bs, &p, &(it->tag                           ), 1, MPI_INT64_T, comm);
            MPI_Unpack(buf, bs, &p, &(it->element                       ), 1, MPI_SIZE_T,  comm);
            MPI_Unpack(buf, bs, &p, &(it->numNeighbors                  ), 1, MPI_SIZE_T,  comm);
            MPI_Unpack(buf, bs, &p, &(it->numNeighborsUnique            ), 1, MPI_SIZE_T,  comm);
            MPI_Unpack(buf, bs, &p, &(it->numSymmetryFunctions          ), 1, MPI_SIZE_T,  comm);
            MPI_Unpack(buf, bs, &p, &(it->energy                        ), 1, MPI_DOUBLE,  comm);
            MPI_Unpack(buf, bs, &p, &(it->chi                           ), 1, MPI_DOUBLE,  comm);
            MPI_Unpack(buf, bs, &p, &(it->charge                        ), 1, MPI_DOUBLE,  comm);
            MPI_Unpack(buf, bs, &p, &(it->chargeRef                     ), 1, MPI_DOUBLE,  comm);
            MPI_Unpack(buf, bs, &p, &(it->r.r                           ), 3, MPI_DOUBLE,  comm);
            MPI_Unpack(buf, bs, &p, &(it->f.r                           ), 3, MPI_DOUBLE,  comm);
            MPI_Unpack(buf, bs, &p, &(it->fRef.r                        ), 3, MPI_DOUBLE,  comm);
 
            // Atom.neighborsUnique
            size_t ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->neighborsUnique.clear();
                it->neighborsUnique.resize(ts2, 0);
                MPI_Unpack(buf, bs, &p, &(it->neighborsUnique.front()), ts2, MPI_SIZE_T, comm);
            }
 
            // Atom.numNeighborsPerElement
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->numNeighborsPerElement.clear();
                it->numNeighborsPerElement.resize(ts2, 0);
                MPI_Unpack(buf, bs, &p, &(it->numNeighborsPerElement.front()), ts2, MPI_SIZE_T, comm);
            }
 
            // Atom.numSymmetryFunctionDerivatives
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->numSymmetryFunctionDerivatives.clear();
                it->numSymmetryFunctionDerivatives.resize(ts2, 0);
                MPI_Unpack(buf, bs, &p, &(it->numSymmetryFunctionDerivatives.front()), ts2, MPI_SIZE_T, comm);
            }
 
#ifndef N2P2_NO_SF_CACHE
            // Atom.cacheSizePerElement
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->cacheSizePerElement.clear();
                it->cacheSizePerElement.resize(ts2, 0);
                MPI_Unpack(buf, bs, &p, &(it->cacheSizePerElement.front()), ts2, MPI_SIZE_T, comm);
            }
#endif
 
            // Atom.G
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->G.clear();
                it->G.resize(ts2, 0.0);
                MPI_Unpack(buf, bs, &p, &(it->G.front()), ts2, MPI_DOUBLE, comm);
            }
 
            // Atom.dEdG
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->dEdG.clear();
                it->dEdG.resize(ts2, 0.0);
                MPI_Unpack(buf, bs, &p, &(it->dEdG.front()), ts2, MPI_DOUBLE, comm);
            }
 
            // Atom.dQdG
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->dQdG.clear();
                it->dQdG.resize(ts2, 0.0);
                MPI_Unpack(buf, bs, &p, &(it->dQdG.front()), ts2, MPI_DOUBLE, comm);
            }
 
#ifdef N2P2_FULL_SFD_MEMORY
            // Atom.dGdxia
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->dGdxia.clear();
                it->dGdxia.resize(ts2, 0.0);
                MPI_Unpack(buf, bs, &p, &(it->dGdxia.front()), ts2, MPI_DOUBLE, comm);
            }
#endif
 
            // Atom.dGdr
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->dGdr.clear();
                it->dGdr.resize(ts2);
                for (vector<Vec3D>::iterator it2 = it->dGdr.begin();
                     it2 != it->dGdr.end(); ++it2)
                {
                    MPI_Unpack(buf, bs, &p, it2->r, 3, MPI_DOUBLE, comm);
                }
            }
 
            // Atom.neighbors
            ts2 = 0;
            MPI_Unpack(buf, bs, &p, &ts2, 1, MPI_SIZE_T, comm);
            if (ts2 > 0)
            {
                it->neighbors.clear();
                it->neighbors.resize(ts2);
                for (vector<Atom::Neighbor>::iterator it2 =
                     it->neighbors.begin(); it2 != it->neighbors.end(); ++it2)
                {
                    // Neighbor
                    MPI_Unpack(buf, bs, &p, &(it2->index      ), 1, MPI_SIZE_T , comm);
                    MPI_Unpack(buf, bs, &p, &(it2->tag        ), 1, MPI_INT64_T, comm);
                    MPI_Unpack(buf, bs, &p, &(it2->element    ), 1, MPI_SIZE_T , comm);
                    MPI_Unpack(buf, bs, &p, &(it2->d          ), 1, MPI_DOUBLE , comm);
                    MPI_Unpack(buf, bs, &p,   it2->dr.r        , 3, MPI_DOUBLE , comm);
 
                    size_t ts3 = 0;
#ifndef N2P2_NO_SF_CACHE
                    // Neighbor.cache
                    ts3 = 0;
                    MPI_Unpack(buf, bs, &p, &ts3, 1, MPI_SIZE_T, comm);
                    if (ts3 > 0)
                    {
                        it2->cache.clear();
                        it2->cache.resize(ts3, 0.0);
                        MPI_Unpack(buf, bs, &p, &(it2->cache.front()), ts3, MPI_DOUBLE, comm);
                    }
#endif
 
                    // Neighbor.dGdr
                    ts3 = 0;
                    MPI_Unpack(buf, bs, &p, &ts3, 1, MPI_SIZE_T, comm);
                    if (ts3 > 0)
                    {
                        it2->dGdr.clear();
                        it2->dGdr.resize(ts3);
                        for (vector<Vec3D>::iterator it3 = it2->dGdr.begin();
                             it3 != it2->dGdr.end(); ++it3)
                        {
                            MPI_Unpack(buf, bs, &p, it3->r, 3, MPI_DOUBLE, comm);
                        }
                    }
                }
            }
        }
    }
 
    delete[] buf;
 
    return bs;
}

References nnp::Structure::atoms, nnp::Structure::box, nnp::Structure::charge, nnp::Structure::chargeRef, comm, nnp::Structure::comment, nnp::Structure::energy, nnp::Structure::energyRef, nnp::Structure::hasNeighborList, nnp::Structure::hasSymmetryFunctionDerivatives, nnp::Structure::hasSymmetryFunctions, nnp::Structure::index, nnp::Structure::invbox, nnp::Structure::isPeriodic, nnp::Structure::isTriclinic, MPI_SIZE_T, nnp::Structure::numAtoms, nnp::Structure::numAtomsPerElement, nnp::Structure::numElements, nnp::Structure::numElementsPresent, p, nnp::Structure::pbc, nnp::Vec3D::r, nnp::Structure::sampleType, and nnp::Structure::volume.

Referenced by distributeStructures(), and prepareNumericForces().

Here is the caller graph for this function:

distributeStructures()

int Dataset::distributeStructures	(	bool	randomize,
		bool	excludeRank0 = false,
		std::string const &	fileName = "input.data"
	)

Read data file and distribute structures among processors.

Parameters

[in]	randomize	If true randomly distribute structures, otherwise they are distributed in order.
[in]	excludeRank0	If true no structures are distributed to MPI process with rank 0.
[in]	fileName	Data file name, e.g. "input.data".

Returns

Number of bytes transferred.

Definition at line 724 of file Dataset.cpp.

{
    log << "\n";
    log << "*** STRUCTURE DISTRIBUTION **************"
           "**************************************\n";
    log << "\n";
 
    ifstream dataFile;
    vector<size_t> numStructuresPerProc;
 
    if (excludeRank0)
    {
        log << "No structures will be distributed to rank 0.\n";
        if (numProcs == 1)
        {
            throw runtime_error("ERROR: Can not distribute structures, "
                                "at least 2 MPI tasks are required.\n");
        }
    }
    size_t numReceivers = numProcs;
    if (excludeRank0) numReceivers--;
 
    if (myRank == 0)
    {
        log << strpr("Reading configurations from data file: %s.\n",
                     fileName.c_str());
        dataFile.open(fileName.c_str());
        numStructures = getNumStructures(dataFile);
        log << strpr("Total number of structures: %zu\n", numStructures);
        dataFile.clear();
        dataFile.seekg(0);
    }
    MPI_Bcast(&numStructures, 1, MPI_SIZE_T, 0, comm);
    if (numStructures < numReceivers)
    {
        throw runtime_error("ERROR: More receiving processors than "
                            "structures.\n");
    }
 
    numStructuresPerProc.resize(numProcs, 0);
    if (myRank == 0)
    {
        size_t quotient = numStructures / numReceivers;
        size_t remainder = numStructures % numReceivers;
        for (size_t i = 0; i < (size_t) numProcs; i++)
        {
            if (i != 0 || (!excludeRank0))
            {
                numStructuresPerProc.at(i) = quotient;
                if (remainder > 0 && i > 0 && i <= remainder)
                {
                    numStructuresPerProc.at(i)++;
                }
            }
        }
        if (remainder == 0)
        {
            log << strpr("Number of structures per processor: %d\n", quotient);
        }
        else
        {
            log << strpr("Number of structures per"
                         " processor: %d (%d) or %d (%d)\n",
                         quotient,
                         numReceivers - remainder,
                         quotient + 1,
                         remainder);
        }
    }
    MPI_Bcast(&(numStructuresPerProc.front()), numProcs, MPI_SIZE_T, 0, comm);
 
    int bytesTransferred = 0;
    size_t numMyStructures = numStructuresPerProc.at(myRank);
    if (myRank == 0)
    {
        size_t countStructures = 0;
        vector<size_t> countStructuresPerProc;
 
        countStructuresPerProc.resize(numProcs, 0);
 
        if (randomize)
        {
            while (countStructures < numStructures)
            {
                int proc = gsl_rng_uniform_int(rng, numProcs);
                if (countStructuresPerProc.at(proc)
                    < numStructuresPerProc.at(proc))
                {
                    if (proc == 0)
                    {
                        structures.push_back(Structure());
                        structures.back().setElementMap(elementMap);
                        structures.back().index = countStructures;
                        structures.back().readFromFile(dataFile);
                        removeEnergyOffset(structures.back());
                    }
                    else
                    {
                        Structure tmpStructure;
                        tmpStructure.setElementMap(elementMap);
                        tmpStructure.index = countStructures;
                        tmpStructure.readFromFile(dataFile);
                        removeEnergyOffset(tmpStructure);
                        bytesTransferred += sendStructure(tmpStructure, proc);
                    }
                    countStructuresPerProc.at(proc)++;
                    countStructures++;
                }
            }
        }
        else
        {
            for (int proc = 0; proc < numProcs; ++proc)
            {
                for (size_t i = 0; i < numStructuresPerProc.at(proc); ++i)
                {
                    if (proc == 0)
                    {
                        structures.push_back(Structure());
                        structures.back().setElementMap(elementMap);
                        structures.back().index = countStructures;
                        structures.back().readFromFile(dataFile);
                        removeEnergyOffset(structures.back());
                    }
                    else
                    {
                        Structure tmpStructure;
                        tmpStructure.setElementMap(elementMap);
                        tmpStructure.index = countStructures;
                        tmpStructure.readFromFile(dataFile);
                        removeEnergyOffset(tmpStructure);
                        bytesTransferred += sendStructure(tmpStructure, proc);
                    }
                    countStructuresPerProc.at(proc)++;
                    countStructures++;
                }
            }
        }
        dataFile.close();
    }
    else
    {
        for (size_t i = 0; i < numMyStructures; i++)
        {
            structures.push_back(Structure());
            structures.back().setElementMap(elementMap);
            bytesTransferred += recvStructure(&(structures.back()), 0);
        }
    }
 
    log << strpr("Distributed %zu structures,"
                 " %d bytes (%.2f MiB) transferred.\n",
                 numStructures,
                 bytesTransferred,
                 bytesTransferred / 1024. / 1024.);
    log << strpr("Number of local structures: %zu\n", structures.size());
    log << "*****************************************"
           "**************************************\n";
 
    return bytesTransferred;
}

References comm, nnp::Mode::elementMap, getNumStructures(), nnp::Structure::index, nnp::Mode::log, MPI_SIZE_T, myRank, numProcs, numStructures, nnp::Structure::readFromFile(), recvStructure(), nnp::Mode::removeEnergyOffset(), rng, sendStructure(), nnp::Structure::setElementMap(), nnp::strpr(), and structures.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

prepareNumericForces()

size_t Dataset::prepareNumericForces	(	Structure &	original,
		double	delta
	)

Prepare numeric force check for a single structure.

Parameters

[in,out]	original	The structure under investigation.
[in]	delta	Central difference delta for positions

Returns

Number of structures distributed (= 1 + 6 * numAtoms).

Distributes copies of original structure among all processors and modifies positions for central difference.

Definition at line 888 of file Dataset.cpp.

{
    // Be sure that structure memory is cleared.
    vector<Structure>().swap(structures);
 
    // Send original to all processors.
    for (int p = 1; p < numProcs; ++p)
    {
        if (myRank == 0) sendStructure(original, p);
        else if (myRank == p) recvStructure(&original, 0);
    }
 
    vector<size_t> numStructuresPerProc(numProcs, 0);
    // Number of structures that need to be calculated:
    // - Original structure +
    // - Two times for each force component.
    numStructures = 1 + 6 * original.numAtoms;
    size_t quotient = numStructures / numProcs;
    size_t remainder = numStructures % numProcs;
    for (size_t i = 0; i < (size_t) numProcs; i++)
    {
        numStructuresPerProc.at(i) = quotient;
        if (remainder > 0 && i < remainder) numStructuresPerProc.at(i)++;
    }
 
    // Rank 0 needs an unaltered version.
    if (myRank == 0)
    {
        structures.push_back(original);
        structures.back().setElementMap(elementMap);
        structures.back().comment = "original";
    }
    // Now make as many copies as each processor needs.
    size_t count = 0;
    size_t iAtom = 0;
    size_t ixyz = 0;
    int sign = 0;
    for (int p = 0; p < numProcs; ++p)
    {
        size_t istart = 0;
        if (p == 0) istart = 1;
        for (size_t i = istart; i < numStructuresPerProc.at(p); ++i)
        {
            iAtom = count / 6;
            ixyz = count % 3;
            sign = 2 * ((count % 6) / 3) - 1;
            if (p == myRank)
            {
                structures.push_back(original);
                Structure& s = structures.back();
                s.setElementMap(elementMap);
                // Write identifiers to comment field.
                s.comment = strpr("%zu %zu %zu %d", count, iAtom, ixyz, sign);
                // Modify atom position.
                s.atoms.at(iAtom).r[ixyz] += sign * delta;
                if (s.isPeriodic) s.remap(s.atoms.at(iAtom));
            }
            count++;
        }
    }
 
    return numStructures;
}

References nnp::Structure::atoms, nnp::Structure::comment, nnp::Mode::elementMap, nnp::Structure::isPeriodic, myRank, nnp::Structure::numAtoms, numProcs, numStructures, p, recvStructure(), nnp::Structure::remap(), sendStructure(), nnp::Structure::setElementMap(), nnp::strpr(), and structures.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

toNormalizedUnits()

void Dataset::toNormalizedUnits

(

)

Switch all structures to normalized units.

Definition at line 952 of file Dataset.cpp.

{
    for (vector<Structure>::iterator it = structures.begin();
         it != structures.end(); ++it)
    {
        it->toNormalizedUnits(meanEnergy, convEnergy, convLength, convCharge);
    }
 
    return;
}

References nnp::Mode::convCharge, nnp::Mode::convEnergy, nnp::Mode::convLength, nnp::Mode::meanEnergy, and structures.

Referenced by main().

Here is the caller graph for this function:

toPhysicalUnits()

void Dataset::toPhysicalUnits

(

)

Switch all structures to physical units.

Definition at line 963 of file Dataset.cpp.

{
    for (vector<Structure>::iterator it = structures.begin();
         it != structures.end(); ++it)
    {
        it->toPhysicalUnits(meanEnergy, convEnergy, convLength, convCharge);
    }
 
    return;
}

References nnp::Mode::convCharge, nnp::Mode::convEnergy, nnp::Mode::convLength, nnp::Mode::meanEnergy, and structures.

Referenced by main().

Here is the caller graph for this function:

collectSymmetryFunctionStatistics()

void Dataset::collectSymmetryFunctionStatistics

(

)

Collect symmetry function statistics from all processors.

Definition at line 974 of file Dataset.cpp.

{
    for (vector<Element>::iterator it = elements.begin();
         it != elements.end(); ++it)
    {
        // If no atoms of this element exist on this proc, create empty
        // statistics.
        if (it->statistics.data.size() == 0)
        {
            log << strpr("WARNING: No statistics for element %zu (%2s) found, "
                         "process %d has no corresponding atoms, creating "
                         "empty statistics.\n",
                         it->getIndex(),
                         it->getSymbol().c_str(),
                         myRank);
        }
        for (size_t i = 0; i < it->numSymmetryFunctions(); ++i)
        {
            SymFncStatistics::Container& c = it->statistics.data[i];
            MPI_Allreduce(MPI_IN_PLACE, &(c.count), 1, MPI_SIZE_T, MPI_SUM, comm);
            MPI_Allreduce(MPI_IN_PLACE, &(c.min  ), 1, MPI_DOUBLE, MPI_MIN, comm);
            MPI_Allreduce(MPI_IN_PLACE, &(c.max  ), 1, MPI_DOUBLE, MPI_MAX, comm);
            MPI_Allreduce(MPI_IN_PLACE, &(c.sum  ), 1, MPI_DOUBLE, MPI_SUM, comm);
            MPI_Allreduce(MPI_IN_PLACE, &(c.sum2 ), 1, MPI_DOUBLE, MPI_SUM, comm);
        }
    }
 
    return;
}

References comm, nnp::SymFncStatistics::Container::count, nnp::Mode::elements, nnp::Mode::log, nnp::SymFncStatistics::Container::max, nnp::SymFncStatistics::Container::min, MPI_SIZE_T, myRank, nnp::strpr(), nnp::SymFncStatistics::Container::sum, and nnp::SymFncStatistics::Container::sum2.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

writeSymmetryFunctionScaling()

void Dataset::writeSymmetryFunctionScaling

(

std::string const &

fileName = "scaling.data"

)

Write symmetry function scaling values to file.

Parameters

[in]

fileName

Scaling data file name (e.g. "scaling.data").

Definition at line 1004 of file Dataset.cpp.

{
    log << "\n";
    log << "*** SYMMETRY FUNCTION SCALING ***********"
           "**************************************\n";
    log << "\n";
 
    if (myRank == 0)
    {
        log << strpr("Writing symmetry function scaling file: %s.\n",
                     fileName.c_str());
        ofstream sFile;
        sFile.open(fileName.c_str());
 
        // File header.
        vector<string> title;
        vector<string> colName;
        vector<string> colInfo;
        vector<size_t> colSize;
        title.push_back("Symmetry function scaling data.");
        colSize.push_back(10);
        colName.push_back("e_index");
        colInfo.push_back("Element index.");
        colSize.push_back(10);
        colName.push_back("sf_index");
        colInfo.push_back("Symmetry function index.");
        colSize.push_back(24);
        colName.push_back("sf_min");
        colInfo.push_back("Symmetry function minimum.");
        colSize.push_back(24);
        colName.push_back("sf_max");
        colInfo.push_back("Symmetry function maximum.");
        colSize.push_back(24);
        colName.push_back("sf_mean");
        colInfo.push_back("Symmetry function mean.");
        colSize.push_back(24);
        colName.push_back("sf_sigma");
        colInfo.push_back("Symmetry function sigma.");
        appendLinesToFile(sFile,
                          createFileHeader(title, colSize, colName, colInfo));
 
        log << "\n";
        log << "Abbreviations:\n";
        log << "--------------\n";
        log << "ind ...... Symmetry function index.\n";
        log << "min ...... Minimum symmetry function value.\n";
        log << "max ...... Maximum symmetry function value.\n";
        log << "mean ..... Mean symmetry function value.\n";
        log << "sigma .... Standard deviation of symmetry function values.\n";
        log << "spread ... (max - min) / sigma.\n";
        log << "\n";
        for (vector<Element>::const_iterator it = elements.begin();
             it != elements.end(); ++it)
        {
            log << strpr("Scaling data for symmetry functions element %2s :\n",
                         it->getSymbol().c_str());
            log << "-----------------------------------------"
                   "--------------------------------------\n";
            log << " ind       min       max      mean     sigma    spread\n";
            log << "-----------------------------------------"
                   "--------------------------------------\n";
            for (size_t i = 0; i < it->numSymmetryFunctions(); ++i)
            {
                SymFncStatistics::Container const& c
                    = it->statistics.data.at(i);
                size_t n = c.count;
                double const mean = c.sum / n;
                double const sigma = sqrt((c.sum2 - c.sum * c.sum / n)
                                          / (n - 1));
                double const spread = (c.max - c.min) / sigma;
                sFile << strpr("%10d %10d %24.16E %24.16E %24.16E %24.16E\n",
                               it->getIndex() + 1,
                               i + 1,
                               c.min,
                               c.max,
                               mean,
                               sigma);
                log << strpr("%4zu %9.2E %9.2E %9.2E %9.2E %9.2E\n",
                             i + 1,
                             c.min,
                             c.max,
                             mean,
                             sigma,
                             spread);
            }
            log << "-----------------------------------------"
                   "--------------------------------------\n";
        }
        // Finally decided to remove this legacy line...
        //sFile << strpr("%f %f\n", 0.0, 0.0);
        sFile.close();
    }
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References nnp::appendLinesToFile(), nnp::SymFncStatistics::Container::count, nnp::createFileHeader(), nnp::Mode::elements, nnp::Mode::log, nnp::SymFncStatistics::Container::max, nnp::SymFncStatistics::Container::min, myRank, nnp::strpr(), nnp::SymFncStatistics::Container::sum, and nnp::SymFncStatistics::Container::sum2.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

writeSymmetryFunctionHistograms()

void Dataset::writeSymmetryFunctionHistograms	(	std::size_t	numBins,
		std::string	fileNameFormat = "sf.%03zu.%04zu.histo"
	)

Calculate and write symmetry function histograms.

Parameters

[in]	numBins	Number of histogram bins used.
[in]	fileNameFormat	Format for histogram file names, must include placeholders for element and symmetry function number.

Definition at line 1103 of file Dataset.cpp.

{
    log << "\n";
    log << "*** SYMMETRY FUNCTION HISTOGRAMS ********"
           "**************************************\n";
    log << "\n";
 
    // Initialize histograms.
    numBins--;
    vector<vector<gsl_histogram*> > histograms;
    for (vector<Element>::const_iterator it = elements.begin();
         it != elements.end(); ++it)
    {
        histograms.push_back(vector<gsl_histogram*>());
        for (size_t i = 0; i < it->numSymmetryFunctions(); ++i)
        {
            double l = safeFind(it->statistics.data, i).min;
            double h = safeFind(it->statistics.data, i).max;
            if (l < h)
            {
                // Add an extra bin at the end to cover complete range.
                h += (h - l) / numBins;
                histograms.back().push_back(gsl_histogram_alloc(numBins + 1));
                gsl_histogram_set_ranges_uniform(histograms.back().back(),
                                                 l,
                                                 h);
            }
            else
            {
                // Use nullptr so signalize non-existing histogram.
                histograms.back().push_back(nullptr);
                log << strpr("WARNING: Symmetry function min equals max, "
                             "ommitting histogram (Element %2s SF %4zu "
                             "(line %4zu).\n",
                             it->getSymbol().c_str(),
                             i,
                             it->getSymmetryFunction(i).getLineNumber() + 1);
            }
        }
    }
 
    // Increment histograms with symmetry function values.
    for (vector<Structure>::const_iterator it = structures.begin();
         it != structures.end(); ++it)
    {
        for (vector<Atom>::const_iterator it2 = it->atoms.begin();
             it2 != it->atoms.end(); ++it2)
        {
            size_t e = it2->element;
            vector<gsl_histogram*>& h = histograms.at(e);
            for (size_t s = 0; s < it2->G.size(); ++s)
            {
                if (h.at(s) == nullptr) continue;
                gsl_histogram_increment(h.at(s), it2->G.at(s));
            }
        }
    }
 
    // Collect histograms from all processes.
    for (vector<vector<gsl_histogram*> >::const_iterator it =
         histograms.begin(); it != histograms.end(); ++it)
    {
        for (vector<gsl_histogram*>::const_iterator it2 = it->begin();
             it2 != it->end(); ++it2)
        {
            if ((*it2) == nullptr) continue;
            MPI_Allreduce(MPI_IN_PLACE, (*it2)->bin, numBins + 1, MPI_DOUBLE, MPI_SUM, comm);
        }
    }
 
    // Write histogram to file.
    if (myRank == 0)
    {
        log << strpr("Writing histograms with %zu bins.\n", numBins + 1);
        for (size_t e = 0; e < elements.size(); ++e)
        {
            for (size_t s = 0; s < elements.at(e).numSymmetryFunctions(); ++s)
            {
                gsl_histogram*& h = histograms.at(e).at(s);
                if (h == nullptr) continue;
                FILE* fp = 0;
                string fileName = strpr(fileNameFormat.c_str(),
                                        elementMap.atomicNumber(e),
                                        s + 1);
                fp = fopen(fileName.c_str(), "w");
                if (fp == 0)
                {
                    throw runtime_error(strpr("ERROR: Could not open file:"
                                              " %s.\n", fileName.c_str()));
                }
                vector<string> info = elements.at(e).infoSymmetryFunction(s);
                for (vector<string>::const_iterator it = info.begin();
                     it != info.end(); ++it)
                {
                    fprintf(fp, "#SFINFO %s\n", it->c_str());
                }
                SymFncStatistics::Container const& c
                    = elements.at(e).statistics.data.at(s);
                size_t n = c.count;
                fprintf(fp, "#SFINFO min         %15.8E\n", c.min);
                fprintf(fp, "#SFINFO max         %15.8E\n", c.max);
                fprintf(fp, "#SFINFO mean        %15.8E\n", c.sum / n);
                fprintf(fp, "#SFINFO sigma       %15.8E\n",
                        sqrt(1.0 / (n - 1) * (c.sum2 - c.sum * c.sum / n)));
 
                // File header.
                vector<string> title;
                vector<string> colName;
                vector<string> colInfo;
                vector<size_t> colSize;
                title.push_back("Symmetry function histogram.");
                colSize.push_back(16);
                colName.push_back("symfunc_l");
                colInfo.push_back("Symmetry function value, left bin limit.");
                colSize.push_back(16);
                colName.push_back("symfunc_r");
                colInfo.push_back("Symmetry function value, right bin limit.");
                colSize.push_back(16);
                colName.push_back("hist");
                colInfo.push_back("Histogram count.");
                appendLinesToFile(fp,
                                  createFileHeader(title,
                                                   colSize,
                                                   colName,
                                                   colInfo));
 
                gsl_histogram_fprintf(fp, h, "%16.8E", "%16.8E");
                fflush(fp);
                fclose(fp);
                fp = 0;
            }
        }
    }
 
    for (vector<vector<gsl_histogram*> >::const_iterator it =
         histograms.begin(); it != histograms.end(); ++it)
    {
        for (vector<gsl_histogram*>::const_iterator it2 = it->begin();
             it2 != it->end(); ++it2)
        {
            if ((*it2) == nullptr) continue;
            gsl_histogram_free(*it2);
        }
    }
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References nnp::appendLinesToFile(), nnp::ElementMap::atomicNumber(), comm, nnp::SymFncStatistics::Container::count, nnp::createFileHeader(), nnp::Mode::elementMap, nnp::Mode::elements, nnp::Mode::log, nnp::SymFncStatistics::Container::max, nnp::SymFncStatistics::Container::min, myRank, nnp::safeFind(), nnp::strpr(), structures, nnp::SymFncStatistics::Container::sum, and nnp::SymFncStatistics::Container::sum2.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

writeSymmetryFunctionFile()

void Dataset::writeSymmetryFunctionFile

(

std::string

fileName = "function.data"

)

Write symmetry function legacy file ("function.data").

Parameters

[in]

fileName

File name for symmetry function file.

Definition at line 1255 of file Dataset.cpp.

{
    log << "\n";
    log << "*** SYMMETRY FUNCTION FILE **************"
           "**************************************\n";
    log << "\n";
 
    // Create empty file.
    log << strpr("Writing symmetry functions to file: %s\n", fileName.c_str());
    if (myRank == 0)
    {
        ofstream file;
        file.open(fileName.c_str());
        file.close();
    }
    MPI_Barrier(comm);
 
    // Prepare structure iterator.
    vector<Structure>::const_iterator it = structures.begin();
    // Loop over all structures (on each proc the local structures are stored
    // with increasing index).
    for (size_t i = 0; i < numStructures; ++i)
    {
        // If this proc holds structure with matching index,
        // open file and write symmetry functions.
        if (it != structures.end() && i == it->index)
        {
            ofstream file;
            file.open(fileName.c_str(), ios_base::app);
            file << strpr("%6zu\n", it->numAtoms);
            // Loop over atoms.
            for (vector<Atom>::const_iterator it2 = it->atoms.begin();
                 it2 != it->atoms.end(); ++it2)
            {
                // Loop over symmetry functions.
                file << strpr("%3zu ", elementMap.atomicNumber(it2->element));
                for (vector<double>::const_iterator it3 = it2->G.begin();
                     it3 != it2->G.end(); ++it3)
                {
                    file << strpr(" %14.10f", *it3);
                }
                file << '\n';
            }
            // There is no charge NN, so first and last entry is zero.
            double energy = 0.0;
            if (normalize) energy = physicalEnergy(*it);
            else energy = it->energyRef;
            energy += getEnergyOffset(*it);
            energy /= it->numAtoms;
            file << strpr(" %19.10f %19.10f %19.10f %19.10f\n",
                          0.0, energy, energy, 0.0);
            file.flush();
            file.close();
            // Iterate to next structure.
            ++it;
        }
        MPI_Barrier(comm);
    }
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References nnp::ElementMap::atomicNumber(), comm, nnp::Mode::elementMap, nnp::Mode::getEnergyOffset(), nnp::Mode::log, myRank, nnp::Mode::normalize, numStructures, nnp::Mode::physicalEnergy(), nnp::strpr(), and structures.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

writeNeighborHistogram()

size_t Dataset::writeNeighborHistogram	(	std::string const &	fileNameHisto = "neighbors.histo",
		std::string const &	fileNameStructure = "neighbors.out"
	)

Calculate and write neighbor histogram and per-structure statistics.

Parameters

[in]	fileNameHisto	Name of histogram file.
[in]	fileNameStructure	Name of per-structure file.

Returns

Maximum number of neighbors.

Definition at line 1320 of file Dataset.cpp.

{
    log << "\n";
    log << "*** NEIGHBOR STATISTICS/HISTOGRAM *******"
           "**************************************\n";
    log << "\n";
 
    ofstream statFile;
    string fileNameLocal = strpr("%s.%04d", fileNameStructure.c_str(), myRank);
    statFile.open(fileNameLocal.c_str());
    if (myRank == 0)
    {
        // File header.
        vector<string> title;
        vector<string> colName;
        vector<string> colInfo;
        vector<size_t> colSize;
        title.push_back("Neighbor statistics for each structure.");
        colSize.push_back(10);
        colName.push_back("struct");
        colInfo.push_back("Index of structure (starting with 1).");
        colSize.push_back(10);
        colName.push_back("natoms");
        colInfo.push_back("Number of atoms in structure.");
        colSize.push_back(10);
        colName.push_back("min");
        colInfo.push_back("Minimum number of neighbors over all atoms.");
        colSize.push_back(10);
        colName.push_back("max");
        colInfo.push_back("Maximum number of neighbors over all atoms.");
        colSize.push_back(16);
        colName.push_back("mean");
        colInfo.push_back("Mean number of neighbors over all atoms.");
        appendLinesToFile(statFile,
                          createFileHeader(title, colSize, colName, colInfo));
    }
 
    // Compute per-structure statistics and prepare histogram boundaries.
    size_t numAtomsGlobal = 0;
    size_t minNeighborsGlobal = numeric_limits<size_t>::max();
    size_t maxNeighborsGlobal = 0;
    double meanNeighborsGlobal = 0.0;
    for (auto const& s : structures)
    {
    size_t minNeighbors = numeric_limits<size_t>::max();
    size_t maxNeighbors = 0;
    double meanNeighbors = 0.0;
        for (auto const& a : s.atoms)
    {
            size_t const n = a.numNeighbors;
            minNeighbors = min(minNeighbors, n);
            maxNeighbors = max(maxNeighbors, n);
            meanNeighbors += n;
        }
        numAtomsGlobal += s.numAtoms;
        minNeighborsGlobal = min(minNeighborsGlobal, minNeighbors);
        maxNeighborsGlobal = max(maxNeighborsGlobal, maxNeighbors);
        meanNeighborsGlobal += meanNeighbors;
        statFile << strpr("%10zu %10zu %10zu %10zu %16.8E\n",
                          s.index + 1,
                          s.numAtoms,
                          minNeighbors,
                          maxNeighbors,
                          meanNeighbors / s.numAtoms);
    }
    statFile.flush();
    statFile.close();
    MPI_Allreduce(MPI_IN_PLACE, &numAtomsGlobal     , 1, MPI_SIZE_T, MPI_SUM, comm);
    MPI_Allreduce(MPI_IN_PLACE, &minNeighborsGlobal , 1, MPI_SIZE_T, MPI_MIN, comm);
    MPI_Allreduce(MPI_IN_PLACE, &maxNeighborsGlobal , 1, MPI_SIZE_T, MPI_MAX, comm);
    MPI_Allreduce(MPI_IN_PLACE, &meanNeighborsGlobal, 1, MPI_DOUBLE, MPI_SUM, comm);
    log << strpr("Minimum number of neighbors: %d\n", minNeighborsGlobal);
    log << strpr("Mean    number of neighbors: %.1f\n",
                 meanNeighborsGlobal / numAtomsGlobal);
    log << strpr("Maximum number of neighbors: %d\n", maxNeighborsGlobal);
 
    // Calculate neighbor histogram.
    gsl_histogram* histNeighbors = NULL;
    histNeighbors = gsl_histogram_alloc(maxNeighborsGlobal + 1);
    gsl_histogram_set_ranges_uniform(histNeighbors,
                                     -0.5,
                                     maxNeighborsGlobal + 0.5);
    for (vector<Structure>::const_iterator it = structures.begin();
         it != structures.end(); ++it)
    {
        for (vector<Atom>::const_iterator it2 = it->atoms.begin();
             it2 != it->atoms.end(); ++it2)
        {
            gsl_histogram_increment(histNeighbors, it2->numNeighbors);
        }
    }
    MPI_Allreduce(MPI_IN_PLACE, histNeighbors->bin, maxNeighborsGlobal + 1, MPI_DOUBLE, MPI_SUM, comm);
 
    // Write histogram to file.
    if (myRank == 0)
    {
        log << strpr("Neighbor histogram file: %s.\n", fileNameHisto.c_str());
        FILE* fp = 0;
        fp = fopen(fileNameHisto.c_str(), "w");
        if (fp == 0)
        {
            throw runtime_error(strpr("ERROR: Could not open file: %s.\n",
                                      fileNameHisto.c_str()));
        }
 
        // File header.
        vector<string> title;
        vector<string> colName;
        vector<string> colInfo;
        vector<size_t> colSize;
        title.push_back("Neighbor count histogram.");
        colSize.push_back(9);
        colName.push_back("neigh_l");
        colInfo.push_back("Number of neighbors, left bin limit.");
        colSize.push_back(9);
        colName.push_back("neigh_r");
        colInfo.push_back("Number of neighbors, right bin limit.");
        colSize.push_back(16);
        colName.push_back("hist");
        colInfo.push_back("Histogram count.");
        appendLinesToFile(fp,
                          createFileHeader(title, colSize, colName, colInfo));
 
        gsl_histogram_fprintf(fp, histNeighbors, "%9.1f", "%16.8E");
        fflush(fp);
        fclose(fp);
        fp = 0;
    }
 
    MPI_Barrier(comm);
    if (myRank == 0)
    {
        log << strpr("Combining per-structure neighbor statistics file: %s.\n",
                     fileNameStructure.c_str());
        combineFiles(fileNameStructure);
    }
 
    gsl_histogram_free(histNeighbors);
 
    log << "*****************************************"
           "**************************************\n";
 
    return maxNeighborsGlobal;
}

References nnp::appendLinesToFile(), combineFiles(), comm, nnp::createFileHeader(), nnp::Mode::log, nnp::Mode::minNeighbors, MPI_SIZE_T, myRank, nnp::strpr(), and structures.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

sortNeighborLists()

void Dataset::sortNeighborLists

(

)

Sort all neighbor lists according to element and distance.

Definition at line 1466 of file Dataset.cpp.

{
    log << "\n";
    log << "*** NEIGHBOR LIST ***********************"
           "**************************************\n";
    log << "\n";
 
    log << "Sorting neighbor lists according to element and distance.\n";
 
    for (vector<Structure>::iterator it = structures.begin();
         it != structures.end(); ++it)
    {
        for (vector<Atom>::iterator it2 = it->atoms.begin();
             it2 != it->atoms.end(); ++it2)
        {
            sort(it2->neighbors.begin(), it2->neighbors.end());
        }
    }
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References nnp::Mode::log, and structures.

Referenced by main().

Here is the caller graph for this function:

writeNeighborLists()

void Dataset::writeNeighborLists

(

std::string const &

fileName = "neighbor-list.data"

)

Write neighbor list file.

Parameters

[in]

fileName

Name for neighbor list file.

Definition at line 1490 of file Dataset.cpp.

{
    log << "\n";
    log << "*** NEIGHBOR LIST ***********************"
           "**************************************\n";
    log << "\n";
 
    string fileNameLocal = strpr("%s.%04d", fileName.c_str(), myRank);
    ofstream fileLocal;
    fileLocal.open(fileNameLocal.c_str());
 
    for (vector<Structure>::const_iterator it = structures.begin();
         it != structures.end(); ++it)
    {
        fileLocal << strpr("%zu\n", it->numAtoms);
        for (vector<Atom>::const_iterator it2 = it->atoms.begin();
             it2 != it->atoms.end(); ++it2)
        {
            fileLocal << strpr("%zu", elementMap.atomicNumber(it2->element));
            for (size_t i = 0; i < numElements; ++i)
            {
                fileLocal << strpr(" %zu", it2->numNeighborsPerElement.at(i));
            }
            for (vector<Atom::Neighbor>::const_iterator it3
                 = it2->neighbors.begin(); it3 != it2->neighbors.end(); ++it3)
            {
                fileLocal << strpr(" %zu", it3->index);
            }
            fileLocal << '\n';
        }
    }
 
    fileLocal.flush();
    fileLocal.close();
    MPI_Barrier(comm);
 
    log << strpr("Writing neighbor lists to file: %s.\n", fileName.c_str());
 
    if (myRank == 0) combineFiles(fileName);
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References nnp::ElementMap::atomicNumber(), combineFiles(), comm, nnp::Mode::elementMap, nnp::Mode::log, myRank, nnp::Mode::numElements, nnp::strpr(), and structures.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAtomicEnvironmentFile()

void Dataset::writeAtomicEnvironmentFile	(	std::vector< std::vector< std::size_t > >	neighCutoff,
		bool	derivatives,
		std::string const &	fileNamePrefix = "atomic-env"
	)

Write atomic environment file.

Parameters

[in]	neighCutoff	Maximum number of neighbor to consider (for each element combination).
[in]	derivatives	If true, write separate files for derivates.
[in]	fileNamePrefix	Prefix for atomic environment files.

This file is used for symmetry function clustering analysis.

Definition at line 1536 of file Dataset.cpp.

{
    log << "\n";
    log << "*** ATOMIC ENVIRONMENT ******************"
           "**************************************\n";
    log << "\n";
 
    string const fileNamePrefixG    = strpr("%s.G"   , fileNamePrefix.c_str());
    string const fileNamePrefixdGdx = strpr("%s.dGdx", fileNamePrefix.c_str());
    string const fileNamePrefixdGdy = strpr("%s.dGdy", fileNamePrefix.c_str());
    string const fileNamePrefixdGdz = strpr("%s.dGdz", fileNamePrefix.c_str());
 
    string const fileNameLocalG    = strpr("%s.%04d",
                                           fileNamePrefixG.c_str(), myRank);
    string const fileNameLocaldGdx = strpr("%s.%04d",
                                           fileNamePrefixdGdx.c_str(), myRank);
    string const fileNameLocaldGdy = strpr("%s.%04d",
                                           fileNamePrefixdGdy.c_str(), myRank);
    string const fileNameLocaldGdz = strpr("%s.%04d",
                                           fileNamePrefixdGdz.c_str(), myRank);
 
    ofstream fileLocalG;
    ofstream fileLocaldGdx;
    ofstream fileLocaldGdy;
    ofstream fileLocaldGdz;
 
    fileLocalG.open(fileNameLocalG.c_str());
    if (derivatives)
    {
        fileLocaldGdx.open(fileNameLocaldGdx.c_str());
        fileLocaldGdy.open(fileNameLocaldGdy.c_str());
        fileLocaldGdz.open(fileNameLocaldGdz.c_str());
    }
 
    log << "Preparing symmetry functions for atomic environment file(s).\n";
    for (size_t i = 0; i < numElements; ++i)
    {
        for (size_t j = 0; j < numElements; ++j)
        {
            log << strpr("Maximum number of %2s neighbors for central %2s "
                         "atoms: %zu\n",
                         elementMap[j].c_str(),
                         elementMap[i].c_str(),
                         neighCutoff.at(i).at(j));
        }
    }
 
    vector<size_t> neighCount(numElements, 0);
    for (vector<Structure>::const_iterator its = structures.begin();
         its != structures.end(); ++its)
    {
        for (vector<Atom>::const_iterator ita = its->atoms.begin();
             ita != its->atoms.end(); ++ita)
        {
            size_t const ea = ita->element;
            for (size_t i = 0; i < numElements; ++i)
            {
                if (ita->numNeighborsPerElement.at(i)
                    < neighCutoff.at(ea).at(i))
                {
                    throw runtime_error(strpr(
                        "ERROR: Not enough neighbor atoms, cannot create "
                        "atomic environment file. Reduce neighbor cutoff for "
                        "element %2s.\n", elementMap[i].c_str()).c_str());
                }
            }
            fileLocalG << strpr("%2s", elementMap[ita->element].c_str());
            fileLocaldGdx << strpr("%2s", elementMap[ita->element].c_str());
            fileLocaldGdy << strpr("%2s", elementMap[ita->element].c_str());
            fileLocaldGdz << strpr("%2s", elementMap[ita->element].c_str());
            // Write atom's own symmetry functions (and derivatives).
            for (vector<double>::const_iterator it = ita->G.begin();
                 it != ita->G.end(); ++it)
            {
                fileLocalG << strpr(" %16.8E", (*it));
            }
            if (derivatives)
            {
                for (vector<Vec3D>::const_iterator it = ita->dGdr.begin();
                     it != ita->dGdr.end(); ++it)
                {
                    fileLocaldGdx << strpr(" %16.8E", (*it)[0]);
                    fileLocaldGdy << strpr(" %16.8E", (*it)[1]);
                    fileLocaldGdz << strpr(" %16.8E", (*it)[2]);
                }
            }
            // Write symmetry functions of neighbors
            for (vector<Atom::Neighbor>::const_iterator itn
                 = ita->neighbors.begin(); itn != ita->neighbors.end(); ++itn)
            {
                size_t const i = itn->index;
                size_t const en = itn->element;
                if (neighCount.at(en) < neighCutoff.at(ea).at(en))
                {
                    // Look up symmetry function at Atom instance of neighbor.
                    Atom const& a = its->atoms.at(i);
                    for (vector<double>::const_iterator it = a.G.begin();
                         it != a.G.end(); ++it)
                    {
                        fileLocalG << strpr(" %16.8E", (*it));
                    }
                    // Log derivatives directly from Neighbor instance.
                    if (derivatives)
                    {
                        // Find atom in neighbor list of neighbor atom.
                        vector<Atom::Neighbor>::const_iterator itan = find_if(
                            a.neighbors.begin(), a.neighbors.end(),
                            [&ita](Atom::Neighbor const& n)
                            {
                                return n.index == ita->index;
                            });
                        for (vector<Vec3D>::const_iterator it
                             = itan->dGdr.begin();
                             it != itan->dGdr.end(); ++it)
                        {
                            fileLocaldGdx << strpr(" %16.8E", (*it)[0]);
                            fileLocaldGdy << strpr(" %16.8E", (*it)[1]);
                            fileLocaldGdz << strpr(" %16.8E", (*it)[2]);
                        }
                    }
                    neighCount.at(en)++;
                }
            }
            fileLocalG << '\n';
            if (derivatives)
            {
                fileLocaldGdx << '\n';
                fileLocaldGdy << '\n';
                fileLocaldGdz << '\n';
            }
            // Reset neighbor counter.
            fill(neighCount.begin(), neighCount.end(), 0);
        }
    }
 
    fileLocalG.flush();
    fileLocalG.close();
    if (derivatives)
    {
        fileLocaldGdx.flush();
        fileLocaldGdx.close();
        fileLocaldGdy.flush();
        fileLocaldGdy.close();
        fileLocaldGdz.flush();
        fileLocaldGdz.close();
    }
    MPI_Barrier(comm);
 
    if (myRank == 0)
    {
        log << strpr("Combining atomic environment file: %s.\n",
                     fileNamePrefixG.c_str());
        combineFiles(fileNamePrefixG);
        if (derivatives)
        {
            log << strpr("Combining atomic environment file: %s.\n",
                         fileNamePrefixdGdx.c_str());
            combineFiles(fileNamePrefixdGdx);
            log << strpr("Combining atomic environment file: %s.\n",
                         fileNamePrefixdGdy.c_str());
            combineFiles(fileNamePrefixdGdy);
            log << strpr("Combining atomic environment file: %s.\n",
                         fileNamePrefixdGdz.c_str());
            combineFiles(fileNamePrefixdGdz);
        }
    }
 
    log << "*****************************************"
           "**************************************\n";
 
    return;
}

References combineFiles(), comm, nnp::Mode::elementMap, nnp::Atom::G, nnp::Mode::log, myRank, nnp::Atom::neighbors, nnp::Mode::numElements, nnp::strpr(), and structures.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

collectError()

void Dataset::collectError	(	std::string const &	property,
		std::map< std::string, double > &	error,
		std::size_t &	count
	)		const

Collect error metrics of a property over all MPI procs.

Parameters

[in]	property	One of "energy", "force" or "charge".
[in,out]	error	Metric sums of this proc (in), global metric (out).
[in,out]	count	Count for this proc (in), global count (out).

Definition at line 1712 of file Dataset.cpp.

{
    if (property == "energy")
    {
        MPI_Allreduce(MPI_IN_PLACE, &count               , 1, MPI_SIZE_T, MPI_SUM, comm);
        MPI_Allreduce(MPI_IN_PLACE, &(error.at("RMSEpa")), 1, MPI_DOUBLE, MPI_SUM, comm);
        MPI_Allreduce(MPI_IN_PLACE, &(error.at("RMSE"))  , 1, MPI_DOUBLE, MPI_SUM, comm);
        MPI_Allreduce(MPI_IN_PLACE, &(error.at("MAEpa")) , 1, MPI_DOUBLE, MPI_SUM, comm);
        MPI_Allreduce(MPI_IN_PLACE, &(error.at("MAE"))   , 1, MPI_DOUBLE, MPI_SUM, comm);
        error.at("RMSEpa") = sqrt(error.at("RMSEpa") / count);
        error.at("RMSE") = sqrt(error.at("RMSE") / count);
        error.at("MAEpa") = error.at("MAEpa") / count;
        error.at("MAE") = error.at("MAE") / count;
    }
    else if (property == "force" || property == "charge")
    {
        MPI_Allreduce(MPI_IN_PLACE, &count             , 1, MPI_SIZE_T, MPI_SUM, comm);
        MPI_Allreduce(MPI_IN_PLACE, &(error.at("RMSE")), 1, MPI_DOUBLE, MPI_SUM, comm);
        MPI_Allreduce(MPI_IN_PLACE, &(error.at("MAE")) , 1, MPI_DOUBLE, MPI_SUM, comm);
        error.at("RMSE") = sqrt(error.at("RMSE") / count);
        error.at("MAE") = error.at("MAE") / count;
    }
    else
    {
        throw runtime_error("ERROR: Unknown property for error collection.\n");
    }
 
    return;
}

References comm, and MPI_SIZE_T.

Referenced by nnp::Training::calculateError(), and main().

Here is the caller graph for this function:

combineFiles()

void Dataset::combineFiles

(

std::string

filePrefix

)

const

Combine individual MPI proc files to one.

Parameters

[in]

filePrefix

File prefix without the ".0001" suffix.

CAUTION: Make sure files are completely written and closed.

Definition at line 1744 of file Dataset.cpp.

{
    ofstream combinedFile(filePrefix.c_str(), ios::binary);
    if (!combinedFile.is_open())
    {
        throw runtime_error(strpr("ERROR: Could not open file: %s.\n",
                                  filePrefix.c_str()));
    }
    for (int i = 0; i < numProcs; ++i)
    {
        string procFileName = strpr("%s.%04d", filePrefix.c_str(), i);
        ifstream procFile(procFileName.c_str(), ios::binary);
        if (!procFile.is_open())
        {
            throw runtime_error(strpr("ERROR: Could not open file: %s.\n",
                                      procFileName.c_str()));
        }
        // If file is empty, do not get rdbuf, otherwise combined file will be
        // closed!
        if (procFile.peek() != ifstream::traits_type::eof())
        {
            combinedFile << procFile.rdbuf();
        }
        procFile.close();
        remove(procFileName.c_str());
    }
    combinedFile.close();
 
    return;
}

References numProcs, and nnp::strpr().

Referenced by nnp::Training::calculateError(), nnp::Training::dataSetNormalization(), main(), writeAtomicEnvironmentFile(), writeNeighborHistogram(), writeNeighborLists(), and nnp::Training::writeSetsToFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

structures

std::vector<Structure> nnp::Dataset::structures

All structures in this dataset.

Definition at line 195 of file Dataset.h.

Referenced by nnp::Training::calculateError(), nnp::Training::calculateNeighborLists(), nnp::Training::dataSetNormalization(), distributeStructures(), main(), prepareNumericForces(), nnp::Training::selectSets(), sortNeighborLists(), nnp::Training::sortUpdateCandidates(), toNormalizedUnits(), toPhysicalUnits(), nnp::Training::update(), writeAtomicEnvironmentFile(), writeNeighborHistogram(), writeNeighborLists(), nnp::Training::writeSetsToFiles(), writeSymmetryFunctionFile(), and writeSymmetryFunctionHistograms().

myRank

int nnp::Dataset::myRank

protected

My process ID.

Definition at line 199 of file Dataset.h.

Referenced by nnp::Training::allocateArrays(), nnp::Training::calculateError(), collectSymmetryFunctionStatistics(), nnp::Training::dataSetNormalization(), distributeStructures(), nnp::Training::loop(), prepareNumericForces(), nnp::Training::selectSets(), setupMPI(), setupRandomNumberGenerator(), nnp::Training::setupTraining(), nnp::Training::setupUpdatePlan(), nnp::Training::update(), writeAtomicEnvironmentFile(), writeNeighborHistogram(), writeNeighborLists(), nnp::Training::writeNeuronStatistics(), nnp::Training::writeSetsToFiles(), writeSymmetryFunctionFile(), writeSymmetryFunctionHistograms(), and writeSymmetryFunctionScaling().

numProcs

int nnp::Dataset::numProcs

protected

Total number of MPI processors.

Definition at line 201 of file Dataset.h.

Referenced by combineFiles(), distributeStructures(), prepareNumericForces(), setupMPI(), setupRandomNumberGenerator(), nnp::Training::setupUpdatePlan(), and nnp::Training::update().

numStructures

std::size_t nnp::Dataset::numStructures

protected

Total number of structures in dataset.

Definition at line 203 of file Dataset.h.

Referenced by nnp::Training::dataSetNormalization(), distributeStructures(), prepareNumericForces(), and writeSymmetryFunctionFile().

myName

std::string nnp::Dataset::myName

protected

My processor name.

Definition at line 205 of file Dataset.h.

Referenced by setupMPI().

comm

MPI_Comm nnp::Dataset::comm

protected

Global MPI communicator.

Definition at line 207 of file Dataset.h.

Referenced by calculateBufferSize(), nnp::Training::calculateError(), collectError(), collectSymmetryFunctionStatistics(), distributeStructures(), recvStructure(), nnp::Training::selectSets(), sendStructure(), setupMPI(), setupRandomNumberGenerator(), nnp::Training::setupUpdatePlan(), nnp::Training::update(), writeAtomicEnvironmentFile(), writeNeighborHistogram(), writeNeighborLists(), nnp::Training::writeNeuronStatistics(), nnp::Training::writeSetsToFiles(), writeSymmetryFunctionFile(), and writeSymmetryFunctionHistograms().

rng

gsl_rng* nnp::Dataset::rng

protected

GSL random number generator (different seed for each MPI process).

Definition at line 209 of file Dataset.h.

Referenced by distributeStructures(), nnp::Training::selectSets(), setupRandomNumberGenerator(), nnp::Training::setupTraining(), and ~Dataset().

rngGlobal

gsl_rng* nnp::Dataset::rngGlobal

protected

Global GSL random number generator (equal seed for each MPI process).

Definition at line 211 of file Dataset.h.

Referenced by nnp::Training::randomizeNeuralNetworkWeights(), setupRandomNumberGenerator(), nnp::Training::setupTraining(), and ~Dataset().

---

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

• /home/runner/work/n2p2/n2p2/src/libnnptrain/Dataset.h
• /home/runner/work/n2p2/n2p2/src/libnnptrain/Dataset.cpp