| 1 | /** \file MoleculeListClass.cpp
 | 
|---|
| 2 |  * 
 | 
|---|
| 3 |  * Function implementations for the class MoleculeListClass.
 | 
|---|
| 4 |  * 
 | 
|---|
| 5 |  */
 | 
|---|
| 6 | 
 | 
|---|
| 7 | #include "molecules.hpp"
 | 
|---|
| 8 | 
 | 
|---|
| 9 | /*********************************** Functions for class MoleculeListClass *************************/
 | 
|---|
| 10 | 
 | 
|---|
| 11 | /** Constructor for MoleculeListClass.
 | 
|---|
| 12 |  */
 | 
|---|
| 13 | MoleculeListClass::MoleculeListClass()
 | 
|---|
| 14 | {
 | 
|---|
| 15 | };
 | 
|---|
| 16 | 
 | 
|---|
| 17 | /** constructor for MoleculeListClass.
 | 
|---|
| 18 |  * \param NumMolecules number of molecules to allocate for
 | 
|---|
| 19 |  * \param NumAtoms number of atoms to allocate for
 | 
|---|
| 20 |  */
 | 
|---|
| 21 | MoleculeListClass::MoleculeListClass(int NumMolecules, int NumAtoms)
 | 
|---|
| 22 | {
 | 
|---|
| 23 |   ListOfMolecules = (molecule **) Malloc(sizeof(molecule *)*NumMolecules, "MoleculeListClass:MoleculeListClass: **ListOfMolecules");
 | 
|---|
| 24 |   for (int i=NumMolecules;i--;)
 | 
|---|
| 25 |     ListOfMolecules[i] = NULL;
 | 
|---|
| 26 |   NumberOfMolecules = NumMolecules;
 | 
|---|
| 27 |   NumberOfTopAtoms = NumAtoms;
 | 
|---|
| 28 | };
 | 
|---|
| 29 | 
 | 
|---|
| 30 | 
 | 
|---|
| 31 | /** Destructor for MoleculeListClass.
 | 
|---|
| 32 |  */
 | 
|---|
| 33 | MoleculeListClass::~MoleculeListClass()
 | 
|---|
| 34 | {
 | 
|---|
| 35 |   cout << Verbose(3) << this << ": Freeing ListOfMolcules." << endl;
 | 
|---|
| 36 |   for (int i=NumberOfMolecules;i--;) {
 | 
|---|
| 37 |     if (ListOfMolecules[i] != NULL) { // if NULL don't free
 | 
|---|
| 38 |       cout << Verbose(4) << "ListOfMolecules: Freeing " << ListOfMolecules[i] << "." << endl;
 | 
|---|
| 39 |       delete(ListOfMolecules[i]);
 | 
|---|
| 40 |       ListOfMolecules[i] = NULL;
 | 
|---|
| 41 |     }
 | 
|---|
| 42 |   }
 | 
|---|
| 43 |   cout << Verbose(4) << "Freeing ListOfMolecules." << endl;
 | 
|---|
| 44 |   Free((void **)&ListOfMolecules, "MoleculeListClass:MoleculeListClass: **ListOfMolecules");
 | 
|---|
| 45 | };
 | 
|---|
| 46 | 
 | 
|---|
| 47 | /** Compare whether two molecules are equal.
 | 
|---|
| 48 |  * \param *a molecule one
 | 
|---|
| 49 |  * \param *n molecule two
 | 
|---|
| 50 |  * \return lexical value (-1, 0, +1)
 | 
|---|
| 51 |  */
 | 
|---|
| 52 | int MolCompare(const void *a, const void *b)
 | 
|---|
| 53 | {
 | 
|---|
| 54 |   int *aList = NULL, *bList = NULL;
 | 
|---|
| 55 |   int Count, Counter, aCounter, bCounter;
 | 
|---|
| 56 |   int flag;
 | 
|---|
| 57 |   atom *aWalker = NULL;
 | 
|---|
| 58 |   atom *bWalker = NULL;
 | 
|---|
| 59 |   
 | 
|---|
| 60 |   // sort each atom list and put the numbers into a list, then go through
 | 
|---|
| 61 |   //cout << "Comparing fragment no. " << *(molecule **)a << " to " << *(molecule **)b << "." << endl;
 | 
|---|
| 62 |   if ( (**(molecule **)a).AtomCount < (**(molecule **)b).AtomCount ) {
 | 
|---|
| 63 |     return -1;
 | 
|---|
| 64 |   } else { if ((**(molecule **)a).AtomCount > (**(molecule **)b).AtomCount)
 | 
|---|
| 65 |     return +1;
 | 
|---|
| 66 |     else {
 | 
|---|
| 67 |       Count = (**(molecule **)a).AtomCount;
 | 
|---|
| 68 |       aList = new int[Count];
 | 
|---|
| 69 |       bList = new int[Count];
 | 
|---|
| 70 |   
 | 
|---|
| 71 |       // fill the lists
 | 
|---|
| 72 |       aWalker = (**(molecule **)a).start;
 | 
|---|
| 73 |       bWalker = (**(molecule **)b).start;
 | 
|---|
| 74 |       Counter = 0;
 | 
|---|
| 75 |       aCounter = 0;
 | 
|---|
| 76 |       bCounter = 0;
 | 
|---|
| 77 |       while ((aWalker->next != (**(molecule **)a).end) && (bWalker->next != (**(molecule **)b).end)) {
 | 
|---|
| 78 |         aWalker = aWalker->next;
 | 
|---|
| 79 |         bWalker = bWalker->next;
 | 
|---|
| 80 |         if (aWalker->GetTrueFather() == NULL)
 | 
|---|
| 81 |           aList[Counter] = Count + (aCounter++);
 | 
|---|
| 82 |         else
 | 
|---|
| 83 |           aList[Counter] = aWalker->GetTrueFather()->nr;
 | 
|---|
| 84 |         if (bWalker->GetTrueFather() == NULL)
 | 
|---|
| 85 |           bList[Counter] = Count + (bCounter++);
 | 
|---|
| 86 |         else
 | 
|---|
| 87 |           bList[Counter] = bWalker->GetTrueFather()->nr;
 | 
|---|
| 88 |         Counter++;
 | 
|---|
| 89 |       }
 | 
|---|
| 90 |       // check if AtomCount was for real
 | 
|---|
| 91 |       flag = 0;
 | 
|---|
| 92 |       if ((aWalker->next == (**(molecule **)a).end) && (bWalker->next != (**(molecule **)b).end)) {
 | 
|---|
| 93 |         flag = -1;
 | 
|---|
| 94 |       } else {
 | 
|---|
| 95 |         if ((aWalker->next != (**(molecule **)a).end) && (bWalker->next == (**(molecule **)b).end))
 | 
|---|
| 96 |           flag = 1;
 | 
|---|
| 97 |       }
 | 
|---|
| 98 |       if (flag == 0) {
 | 
|---|
| 99 |         // sort the lists
 | 
|---|
| 100 |         gsl_heapsort(aList,Count, sizeof(int), CompareDoubles); 
 | 
|---|
| 101 |         gsl_heapsort(bList,Count, sizeof(int), CompareDoubles);
 | 
|---|
| 102 |         // compare the lists 
 | 
|---|
| 103 |         
 | 
|---|
| 104 |         flag = 0;
 | 
|---|
| 105 |         for(int i=0;i<Count;i++) {
 | 
|---|
| 106 |           if (aList[i] < bList[i]) {
 | 
|---|
| 107 |             flag = -1;
 | 
|---|
| 108 |           } else {
 | 
|---|
| 109 |             if (aList[i] > bList[i])
 | 
|---|
| 110 |               flag = 1;
 | 
|---|
| 111 |           }
 | 
|---|
| 112 |           if (flag != 0)
 | 
|---|
| 113 |             break;
 | 
|---|
| 114 |         }
 | 
|---|
| 115 |       }
 | 
|---|
| 116 |       delete[](aList);
 | 
|---|
| 117 |       delete[](bList);
 | 
|---|
| 118 |       return flag;
 | 
|---|
| 119 |     }
 | 
|---|
| 120 |   }
 | 
|---|
| 121 |   return  -1;
 | 
|---|
| 122 | };
 | 
|---|
| 123 | 
 | 
|---|
| 124 | /** Simple output of the pointers in ListOfMolecules.
 | 
|---|
| 125 |  * \param *out output stream
 | 
|---|
| 126 |  */
 | 
|---|
| 127 | void MoleculeListClass::Output(ofstream *out)
 | 
|---|
| 128 | {
 | 
|---|
| 129 |   *out<< Verbose(1) << "MoleculeList: ";
 | 
|---|
| 130 |   for (int i=0;i<NumberOfMolecules;i++)
 | 
|---|
| 131 |     *out << ListOfMolecules[i] << "\t";
 | 
|---|
| 132 |   *out << endl;
 | 
|---|
| 133 | };
 | 
|---|
| 134 | 
 | 
|---|
| 135 | 
 | 
|---|
| 136 | /** Store force indices, i.e. the connection between the nuclear index in the total molecule config and the respective atom in fragment config.
 | 
|---|
| 137 |  * \param *out output stream for debugging
 | 
|---|
| 138 |  * \param *path path to file
 | 
|---|
| 139 |  * \param *SortIndex Index to map from the BFS labeling to the sequence how of Ion_Type in the config
 | 
|---|
| 140 |  * \return true - file written successfully, false - writing failed
 | 
|---|
| 141 |  */
 | 
|---|
| 142 | bool MoleculeListClass::StoreForcesFile(ofstream *out, char *path, int *SortIndex)
 | 
|---|
| 143 | {
 | 
|---|
| 144 |   bool status = true;
 | 
|---|
| 145 |   ofstream ForcesFile;
 | 
|---|
| 146 |   stringstream line;
 | 
|---|
| 147 |   atom *Walker = NULL;
 | 
|---|
| 148 |   element *runner = NULL;
 | 
|---|
| 149 | 
 | 
|---|
| 150 |   // open file for the force factors
 | 
|---|
| 151 |   *out << Verbose(1) << "Saving  force factors ... ";
 | 
|---|
| 152 |   line << path << "/" << FRAGMENTPREFIX << FORCESFILE;
 | 
|---|
| 153 |   ForcesFile.open(line.str().c_str(), ios::out);
 | 
|---|
| 154 |   if (ForcesFile != NULL) {
 | 
|---|
| 155 |     //cout << Verbose(1) << "Final AtomicForcesList: ";
 | 
|---|
| 156 |     //output << prefix << "Forces" << endl;
 | 
|---|
| 157 |     for(int j=0;j<NumberOfMolecules;j++) {
 | 
|---|
| 158 |       //if (TEList[j] != 0) {
 | 
|---|
| 159 |       runner = ListOfMolecules[j]->elemente->start;
 | 
|---|
| 160 |       while (runner->next != ListOfMolecules[j]->elemente->end) { // go through every element
 | 
|---|
| 161 |         runner = runner->next;
 | 
|---|
| 162 |         if (ListOfMolecules[j]->ElementsInMolecule[runner->Z]) { // if this element got atoms
 | 
|---|
| 163 |           Walker = ListOfMolecules[j]->start;
 | 
|---|
| 164 |           while (Walker->next != ListOfMolecules[j]->end) { // go through every atom of this element
 | 
|---|
| 165 |             Walker = Walker->next;
 | 
|---|
| 166 |             if (Walker->type->Z == runner->Z) {
 | 
|---|
| 167 |               if ((Walker->GetTrueFather() != NULL) && (Walker->GetTrueFather() != Walker)) {// if there is a rea
 | 
|---|
| 168 |                 //cout << "Walker is " << *Walker << " with true father " << *( Walker->GetTrueFather()) << ", it
 | 
|---|
| 169 |                 ForcesFile <<  SortIndex[Walker->GetTrueFather()->nr] << "\t";
 | 
|---|
| 170 |                 } else  // otherwise a -1 to indicate an added saturation hydrogen
 | 
|---|
| 171 |                   ForcesFile << "-1\t";
 | 
|---|
| 172 |               }
 | 
|---|
| 173 |             }
 | 
|---|
| 174 |           }
 | 
|---|
| 175 |       }
 | 
|---|
| 176 |       ForcesFile << endl;
 | 
|---|
| 177 |     }
 | 
|---|
| 178 |     ForcesFile.close();
 | 
|---|
| 179 |     *out << Verbose(1) << "done." << endl;
 | 
|---|
| 180 |   } else {
 | 
|---|
| 181 |     status = false;
 | 
|---|
| 182 |     *out << Verbose(1) << "failed to open file " << line.str() << "." << endl;
 | 
|---|
| 183 |   }
 | 
|---|
| 184 |   ForcesFile.close();
 | 
|---|
| 185 |   
 | 
|---|
| 186 |   return status;
 | 
|---|
| 187 | };
 | 
|---|
| 188 | 
 | 
|---|
| 189 | /** Writes a config file for each molecule in the given \a **FragmentList.
 | 
|---|
| 190 |  * \param *out output stream for debugging
 | 
|---|
| 191 |  * \param *configuration standard configuration to attach atoms in fragment molecule to.
 | 
|---|
| 192 |  * \param *SortIndex Index to map from the BFS labeling to the sequence how of Ion_Type in the config
 | 
|---|
| 193 |  * \return true - success (each file was written), false - something went wrong.
 | 
|---|
| 194 |  */
 | 
|---|
| 195 | bool MoleculeListClass::OutputConfigForListOfFragments(ofstream *out, config *configuration, int *SortIndex)
 | 
|---|
| 196 | {
 | 
|---|
| 197 |   ofstream outputFragment;
 | 
|---|
| 198 |   char FragmentName[MAXSTRINGSIZE];
 | 
|---|
| 199 |   char PathBackup[MAXSTRINGSIZE];
 | 
|---|
| 200 |   bool result = true;
 | 
|---|
| 201 |   bool intermediateResult = true;
 | 
|---|
| 202 |   atom *Walker = NULL;
 | 
|---|
| 203 |   vector BoxDimension;
 | 
|---|
| 204 |   char *FragmentNumber;
 | 
|---|
| 205 |   int FragmentCounter = 0;
 | 
|---|
| 206 |   ofstream output;
 | 
|---|
| 207 |   
 | 
|---|
| 208 |   // store the fragments as config and as xyz
 | 
|---|
| 209 |   for(int i=0;i<NumberOfMolecules;i++) {
 | 
|---|
| 210 |     // save default path as it is changed for each fragment
 | 
|---|
| 211 |     strcpy(PathBackup, configuration->GetDefaultPath());
 | 
|---|
| 212 | 
 | 
|---|
| 213 |     // correct periodic
 | 
|---|
| 214 |     ListOfMolecules[i]->ScanForPeriodicCorrection(out);
 | 
|---|
| 215 | 
 | 
|---|
| 216 |     // output xyz file
 | 
|---|
| 217 |     FragmentNumber = FixedDigitNumber(NumberOfMolecules, FragmentCounter++);
 | 
|---|
| 218 |     sprintf(FragmentName, "%s/%s%s.conf.xyz", configuration->configpath, FRAGMENTPREFIX, FragmentNumber);
 | 
|---|
| 219 |     outputFragment.open(FragmentName, ios::out);
 | 
|---|
| 220 |     *out << Verbose(2) << "Saving bond fragment No. " << FragmentNumber << " as XYZ ...";
 | 
|---|
| 221 |     if (intermediateResult = ListOfMolecules[i]->OutputXYZ(&outputFragment))
 | 
|---|
| 222 |       *out << " done." << endl;
 | 
|---|
| 223 |     else
 | 
|---|
| 224 |       *out << " failed." << endl;
 | 
|---|
| 225 |     result = result && intermediateResult;
 | 
|---|
| 226 |     outputFragment.close();
 | 
|---|
| 227 |     outputFragment.clear();
 | 
|---|
| 228 | 
 | 
|---|
| 229 |     *out << Verbose(2) << "Contained atoms: ";
 | 
|---|
| 230 |     Walker = ListOfMolecules[i]->start;
 | 
|---|
| 231 |     while (Walker->next != ListOfMolecules[i]->end) {
 | 
|---|
| 232 |       Walker = Walker->next;
 | 
|---|
| 233 |       *out << Walker->Name << " ";
 | 
|---|
| 234 |     }
 | 
|---|
| 235 |     *out << endl;
 | 
|---|
| 236 |     // prepare output of config file
 | 
|---|
| 237 |     sprintf(FragmentName, "%s/%s%s.conf", configuration->configpath, FRAGMENTPREFIX, FragmentNumber);
 | 
|---|
| 238 |     outputFragment.open(FragmentName, ios::out);
 | 
|---|
| 239 |     strcpy(PathBackup, configuration->configpath);
 | 
|---|
| 240 |     sprintf(FragmentName, "%s/%s%s/", configuration->configpath, FRAGMENTPREFIX, FragmentNumber);
 | 
|---|
| 241 |     
 | 
|---|
| 242 |     // center on edge
 | 
|---|
| 243 |     ListOfMolecules[i]->CenterEdge(out, &BoxDimension);
 | 
|---|
| 244 |     ListOfMolecules[i]->SetBoxDimension(&BoxDimension);  // update Box of atoms by boundary
 | 
|---|
| 245 |     int j = -1;
 | 
|---|
| 246 |     for (int k=0;k<NDIM;k++) {
 | 
|---|
| 247 |       j += k+1;
 | 
|---|
| 248 |       BoxDimension.x[k] = 5.;
 | 
|---|
| 249 |       ListOfMolecules[i]->cell_size[j] += BoxDimension.x[k]*2.;
 | 
|---|
| 250 |     }
 | 
|---|
| 251 |     ListOfMolecules[i]->Translate(&BoxDimension);
 | 
|---|
| 252 | 
 | 
|---|
| 253 |     // also calculate necessary orbitals
 | 
|---|
| 254 |     ListOfMolecules[i]->CountElements();  // this is a bugfix, atoms should should actually be added correctly to this fragment 
 | 
|---|
| 255 |     ListOfMolecules[i]->CalculateOrbitals(*configuration);
 | 
|---|
| 256 |     
 | 
|---|
| 257 |     // change path in config
 | 
|---|
| 258 |     configuration->SetDefaultPath(FragmentName);
 | 
|---|
| 259 |     *out << Verbose(2) << "Saving bond fragment No. " << FragmentNumber << " as config ...";
 | 
|---|
| 260 |     if (intermediateResult = configuration->Save(&outputFragment, ListOfMolecules[i]->elemente, ListOfMolecules[i]))
 | 
|---|
| 261 |       *out << " done." << endl;
 | 
|---|
| 262 |     else
 | 
|---|
| 263 |       *out << " failed." << endl;
 | 
|---|
| 264 |     // restore old config
 | 
|---|
| 265 |     configuration->SetDefaultPath(PathBackup);
 | 
|---|
| 266 |     
 | 
|---|
| 267 |     result = result && intermediateResult;
 | 
|---|
| 268 |     outputFragment.close();
 | 
|---|
| 269 |     outputFragment.clear();
 | 
|---|
| 270 |     delete(FragmentNumber);
 | 
|---|
| 271 |     //Free((void **)&FragmentNumber, "MoleculeListClass::OutputConfigForListOfFragments: *FragmentNumber");
 | 
|---|
| 272 |   }
 | 
|---|
| 273 |   cout << " done." << endl;
 | 
|---|
| 274 |   
 | 
|---|
| 275 |   // printing final number
 | 
|---|
| 276 |   *out << "Final number of fragments: " << FragmentCounter << "." << endl;
 | 
|---|
| 277 |       
 | 
|---|
| 278 |   return result;
 | 
|---|
| 279 | };
 | 
|---|
| 280 | 
 | 
|---|
| 281 | /******************************************* Class MoleculeLeafClass ************************************************/
 | 
|---|
| 282 | 
 | 
|---|
| 283 | /** Constructor for MoleculeLeafClass root leaf.
 | 
|---|
| 284 |  * \param *Up Leaf on upper level
 | 
|---|
| 285 |  * \param *PreviousLeaf NULL - We are the first leaf on this level, otherwise points to previous in list
 | 
|---|
| 286 |  */
 | 
|---|
| 287 | //MoleculeLeafClass::MoleculeLeafClass(MoleculeLeafClass *Up = NULL, MoleculeLeafClass *Previous = NULL)
 | 
|---|
| 288 | MoleculeLeafClass::MoleculeLeafClass(MoleculeLeafClass *PreviousLeaf = NULL)
 | 
|---|
| 289 | {
 | 
|---|
| 290 | //  if (Up != NULL)
 | 
|---|
| 291 | //    if (Up->DownLeaf == NULL) // are we the first down leaf for the upper leaf?
 | 
|---|
| 292 | //      Up->DownLeaf = this;
 | 
|---|
| 293 | //  UpLeaf = Up;
 | 
|---|
| 294 | //  DownLeaf = NULL;
 | 
|---|
| 295 |   Leaf = NULL;
 | 
|---|
| 296 |   previous = PreviousLeaf;
 | 
|---|
| 297 |   if (previous != NULL) {
 | 
|---|
| 298 |     MoleculeLeafClass *Walker = previous->next;
 | 
|---|
| 299 |     previous->next = this;
 | 
|---|
| 300 |     next = Walker;
 | 
|---|
| 301 |   } else {
 | 
|---|
| 302 |     next = NULL;
 | 
|---|
| 303 |   }
 | 
|---|
| 304 | };
 | 
|---|
| 305 | 
 | 
|---|
| 306 | /** Destructor for MoleculeLeafClass.
 | 
|---|
| 307 |  */
 | 
|---|
| 308 | MoleculeLeafClass::~MoleculeLeafClass()
 | 
|---|
| 309 | {
 | 
|---|
| 310 | //  if (DownLeaf != NULL) {// drop leaves further down
 | 
|---|
| 311 | //    MoleculeLeafClass *Walker = DownLeaf;
 | 
|---|
| 312 | //    MoleculeLeafClass *Next;
 | 
|---|
| 313 | //    do {
 | 
|---|
| 314 | //      Next = Walker->NextLeaf;
 | 
|---|
| 315 | //      delete(Walker);
 | 
|---|
| 316 | //      Walker = Next;
 | 
|---|
| 317 | //    } while (Walker != NULL);
 | 
|---|
| 318 | //    // Last Walker sets DownLeaf automatically to NULL
 | 
|---|
| 319 | //  }
 | 
|---|
| 320 |   // remove the leaf itself
 | 
|---|
| 321 |   if (Leaf != NULL) {
 | 
|---|
| 322 |     delete(Leaf);
 | 
|---|
| 323 |     Leaf = NULL;
 | 
|---|
| 324 |   }
 | 
|---|
| 325 |   // remove this Leaf from level list
 | 
|---|
| 326 |   if (previous != NULL)   
 | 
|---|
| 327 |     previous->next = next;
 | 
|---|
| 328 | //  } else { // we are first in list (connects to UpLeaf->DownLeaf)
 | 
|---|
| 329 | //    if ((NextLeaf != NULL) && (NextLeaf->UpLeaf == NULL))
 | 
|---|
| 330 | //      NextLeaf->UpLeaf = UpLeaf;  // either null as we are top level or the upleaf of the first node
 | 
|---|
| 331 | //    if (UpLeaf != NULL)
 | 
|---|
| 332 | //      UpLeaf->DownLeaf = NextLeaf;  // either null as we are only leaf or NextLeaf if we are just the first
 | 
|---|
| 333 | //  }
 | 
|---|
| 334 | //  UpLeaf = NULL;
 | 
|---|
| 335 |   if (next != NULL) // are we last in list
 | 
|---|
| 336 |     next->previous = previous;
 | 
|---|
| 337 |   next = NULL;
 | 
|---|
| 338 |   previous = NULL;
 | 
|---|
| 339 | };
 | 
|---|
| 340 | 
 | 
|---|
| 341 | /** Adds \a molecule leaf to the tree.
 | 
|---|
| 342 |  * \param *ptr ptr to molecule to be added
 | 
|---|
| 343 |  * \param *Previous previous MoleculeLeafClass referencing level and which on the level
 | 
|---|
| 344 |  * \return true - success, false - something went wrong
 | 
|---|
| 345 |  */
 | 
|---|
| 346 | bool MoleculeLeafClass::AddLeaf(molecule *ptr, MoleculeLeafClass *Previous)
 | 
|---|
| 347 | {
 | 
|---|
| 348 |   return false;
 | 
|---|
| 349 | };
 | 
|---|
| 350 | 
 | 
|---|
| 351 | /** Fills the bond structure of this chain list subgraphs that are derived from a complete \a *reference molecule.
 | 
|---|
| 352 |  * Calls this routine in each MoleculeLeafClass::next subgraph if it's not NULL.
 | 
|---|
| 353 |  * \param *out output stream for debugging
 | 
|---|
| 354 |  * \param *reference reference molecule with the bond structure to be copied
 | 
|---|
| 355 |  * \param &FragmentCounter Counter needed to address \a **ListOfLocalAtoms
 | 
|---|
| 356 |  * \param ***ListOfLocalAtoms Lookup table for each subgraph and index of each atom in \a *reference, may be NULL on start, then it is filled
 | 
|---|
| 357 |  * \param FreeList true - ***ListOfLocalAtoms is free'd before return, false - it is not
 | 
|---|
| 358 |  * \return true - success, false - faoilure
 | 
|---|
| 359 |  */
 | 
|---|
| 360 | bool MoleculeLeafClass::FillBondStructureFromReference(ofstream *out, molecule *reference, int &FragmentCounter, atom ***&ListOfLocalAtoms, bool FreeList)
 | 
|---|
| 361 | {
 | 
|---|
| 362 |   atom *Walker = NULL, *OtherWalker = NULL;
 | 
|---|
| 363 |   bond *Binder = NULL;
 | 
|---|
| 364 |   bool status = true;
 | 
|---|
| 365 |   int AtomNo;
 | 
|---|
| 366 | 
 | 
|---|
| 367 |   // fill ListOfLocalAtoms if NULL was given
 | 
|---|
| 368 |   if (!FillListOfLocalAtoms(out, ListOfLocalAtoms, FragmentCounter, reference->AtomCount, FreeList)) {
 | 
|---|
| 369 |     *out << Verbose(1) << "Filling of ListOfLocalAtoms failed." << endl;
 | 
|---|
| 370 |     return false;
 | 
|---|
| 371 |   }
 | 
|---|
| 372 |   
 | 
|---|
| 373 |   if (status) {
 | 
|---|
| 374 |     *out << Verbose(1) << "Creating adjacency list for subgraph " << this << "." << endl;
 | 
|---|
| 375 |     Walker = Leaf->start;
 | 
|---|
| 376 |     while (Walker->next != Leaf->end) {
 | 
|---|
| 377 |       Walker = Walker->next;
 | 
|---|
| 378 |       AtomNo = Walker->father->nr;  // global id of the current walker
 | 
|---|
| 379 |       for(int i=0;i<reference->NumberOfBondsPerAtom[AtomNo];i++) { // go through father's bonds and copy them all
 | 
|---|
| 380 |         Binder = reference->ListOfBondsPerAtom[AtomNo][i];
 | 
|---|
| 381 |         OtherWalker = ListOfLocalAtoms[FragmentCounter][Binder->GetOtherAtom(Walker->father)->nr];    // local copy of current bond partner of walker
 | 
|---|
| 382 |         if (OtherWalker != NULL) {
 | 
|---|
| 383 |           if (OtherWalker->nr > Walker->nr)
 | 
|---|
| 384 |           Leaf->AddBond(Walker, OtherWalker, Binder->BondDegree);
 | 
|---|
| 385 |         } else {
 | 
|---|
| 386 |           *out << Verbose(1) << "OtherWalker = ListOfLocalAtoms[" << FragmentCounter << "][" << Binder->GetOtherAtom(Walker->father)->nr << "] is NULL!" << endl;
 | 
|---|
| 387 |           status = false;
 | 
|---|
| 388 |         }
 | 
|---|
| 389 |       }
 | 
|---|
| 390 |     }
 | 
|---|
| 391 |     Leaf->CreateListOfBondsPerAtom(out);
 | 
|---|
| 392 |     FragmentCounter++;
 | 
|---|
| 393 |     if (next != NULL)
 | 
|---|
| 394 |       status = next->FillBondStructureFromReference(out, reference, FragmentCounter, ListOfLocalAtoms);
 | 
|---|
| 395 |   }
 | 
|---|
| 396 |   
 | 
|---|
| 397 |   if (FreeList) {
 | 
|---|
| 398 |     // free the index lookup list
 | 
|---|
| 399 |     Free((void **)&ListOfLocalAtoms[FragmentCounter], "MoleculeLeafClass::FillBondStructureFromReference - **ListOfLocalAtoms[]");
 | 
|---|
| 400 |     if (ListOfLocalAtoms[FragmentCounter] == NULL)
 | 
|---|
| 401 |       Free((void **)&ListOfLocalAtoms, "MoleculeLeafClass::FillBondStructureFromReference - ***ListOfLocalAtoms");
 | 
|---|
| 402 |   }
 | 
|---|
| 403 |   FragmentCounter--;
 | 
|---|
| 404 |   return status;
 | 
|---|
| 405 | };
 | 
|---|
| 406 | 
 | 
|---|
| 407 | /** Fills the root stack for sites to be used as root in fragmentation depending on order or adaptivity criteria
 | 
|---|
| 408 |  * Again, as in \sa FillBondStructureFromReference steps recursively through each Leaf in this chain list of molecule's.
 | 
|---|
| 409 |  * \param *out output stream for debugging
 | 
|---|
| 410 |  * \param *&RootStack stack to be filled
 | 
|---|
| 411 |  * \param *AtomMask defines true/false per global Atom::nr to mask in/out each nuclear site
 | 
|---|
| 412 |  * \param &FragmentCounter counts through the fragments in this MoleculeLeafClass
 | 
|---|
| 413 |  * \return true - stack is non-empty, fragmentation necessary, false - stack is empty, no more sites to update
 | 
|---|
| 414 |  */
 | 
|---|
| 415 | bool MoleculeLeafClass::FillRootStackForSubgraphs(ofstream *out, KeyStack *&RootStack, bool *AtomMask, int &FragmentCounter)
 | 
|---|
| 416 | {
 | 
|---|
| 417 |   atom *Walker = NULL, *Father = NULL;
 | 
|---|
| 418 | 
 | 
|---|
| 419 |   if (RootStack != NULL) {
 | 
|---|
| 420 |     // find first root candidates 
 | 
|---|
| 421 |     if (&(RootStack[FragmentCounter]) != NULL) {
 | 
|---|
| 422 |       RootStack[FragmentCounter].clear();  
 | 
|---|
| 423 |       Walker = Leaf->start;
 | 
|---|
| 424 |       while (Walker->next != Leaf->end) { // go through all (non-hydrogen) atoms
 | 
|---|
| 425 |         Walker = Walker->next;
 | 
|---|
| 426 |         Father = Walker->GetTrueFather();
 | 
|---|
| 427 |         if (AtomMask[Father->nr]) // apply mask
 | 
|---|
| 428 |     #ifdef ADDHYDROGEN
 | 
|---|
| 429 |           if (Walker->type->Z != 1) // skip hydrogen
 | 
|---|
| 430 |     #endif
 | 
|---|
| 431 |             RootStack[FragmentCounter].push_front(Walker->nr);
 | 
|---|
| 432 |       }
 | 
|---|
| 433 |       if (next != NULL)
 | 
|---|
| 434 |         next->FillRootStackForSubgraphs(out, RootStack, AtomMask, ++FragmentCounter);
 | 
|---|
| 435 |     }  else {
 | 
|---|
| 436 |       *out << Verbose(1) << "Rootstack[" << FragmentCounter  << "] is NULL." << endl;
 | 
|---|
| 437 |       return false;
 | 
|---|
| 438 |     }
 | 
|---|
| 439 |     FragmentCounter--;
 | 
|---|
| 440 |     return true;
 | 
|---|
| 441 |   } else {
 | 
|---|
| 442 |     *out << Verbose(1) << "Rootstack is NULL." << endl;
 | 
|---|
| 443 |     return false;
 | 
|---|
| 444 |   }
 | 
|---|
| 445 | };
 | 
|---|
| 446 | 
 | 
|---|
| 447 | /** Fills a lookup list of father's Atom::nr -> atom for each subgraph.
 | 
|---|
| 448 |  * \param *out output stream fro debugging
 | 
|---|
| 449 |  * \param ***ListOfLocalAtoms Lookup table for each subgraph and index of each atom in global molecule, may be NULL on start, then it is filled
 | 
|---|
| 450 |  * \param &FragmentCounter counts the fragments as we move along the list
 | 
|---|
| 451 |  * \param GlobalAtomCount number of atoms in the complete molecule
 | 
|---|
| 452 |  * \param &FreeList true - ***ListOfLocalAtoms is free'd before return, false - it is not
 | 
|---|
| 453 |  * \return true - succes, false - failure
 | 
|---|
| 454 |  */
 | 
|---|
| 455 | bool MoleculeLeafClass::FillListOfLocalAtoms(ofstream *out, atom ***&ListOfLocalAtoms, int &FragmentCounter, int GlobalAtomCount, bool &FreeList)
 | 
|---|
| 456 | {
 | 
|---|
| 457 |   bool status = true;
 | 
|---|
| 458 |   
 | 
|---|
| 459 |   int Counter = Count();
 | 
|---|
| 460 |   if (ListOfLocalAtoms == NULL) { // allocated initial pointer
 | 
|---|
| 461 |     // allocate and set each field to NULL
 | 
|---|
| 462 |     ListOfLocalAtoms = (atom ***) Malloc(sizeof(atom **)*Counter, "MoleculeLeafClass::FillBondStructureFromReference - ***ListOfLocalAtoms");
 | 
|---|
| 463 |     if (ListOfLocalAtoms != NULL) {
 | 
|---|
| 464 |       for (int i=Counter;i--;)
 | 
|---|
| 465 |         ListOfLocalAtoms[i] = NULL;
 | 
|---|
| 466 |       FreeList = FreeList && true;
 | 
|---|
| 467 |     } else
 | 
|---|
| 468 |       status = false;
 | 
|---|
| 469 |   }
 | 
|---|
| 470 |   
 | 
|---|
| 471 |   if ((ListOfLocalAtoms != NULL) && (ListOfLocalAtoms[FragmentCounter] == NULL)) { // allocate and fill list of this fragment/subgraph
 | 
|---|
| 472 |     status = status && CreateFatherLookupTable(out, Leaf->start, Leaf->end, ListOfLocalAtoms[FragmentCounter], GlobalAtomCount);
 | 
|---|
| 473 |     FreeList = FreeList && true;
 | 
|---|
| 474 |   }
 | 
|---|
| 475 |   
 | 
|---|
| 476 |   return status;
 | 
|---|
| 477 | };
 | 
|---|
| 478 | 
 | 
|---|
| 479 | /** The indices per keyset are compared to the respective father's Atom::nr in each subgraph and thus put into \a **&FragmentList.
 | 
|---|
| 480 |  * \param *out output stream fro debugging
 | 
|---|
| 481 |  * \param *reference reference molecule with the bond structure to be copied
 | 
|---|
| 482 |  * \param *KeySetList list with all keysets
 | 
|---|
| 483 |  * \param ***ListOfLocalAtoms Lookup table for each subgraph and index of each atom in global molecule, may be NULL on start, then it is filled
 | 
|---|
| 484 |  * \param **&FragmentList list to be allocated and returned
 | 
|---|
| 485 |  * \param &FragmentCounter counts the fragments as we move along the list
 | 
|---|
| 486 |  * \param FreeList true - ***ListOfLocalAtoms is free'd before return, false - it is not
 | 
|---|
| 487 |  * \retuen true - success, false - failure
 | 
|---|
| 488 |  */
 | 
|---|
| 489 | bool MoleculeLeafClass::AssignKeySetsToFragment(ofstream *out, molecule *reference, Graph *KeySetList, atom ***&ListOfLocalAtoms, Graph **&FragmentList, int &FragmentCounter, bool FreeList)
 | 
|---|
| 490 | {
 | 
|---|
| 491 |   bool status = true;
 | 
|---|
| 492 |   int KeySetCounter = 0;
 | 
|---|
| 493 |   
 | 
|---|
| 494 |   // fill ListOfLocalAtoms if NULL was given
 | 
|---|
| 495 |   if (!FillListOfLocalAtoms(out, ListOfLocalAtoms, FragmentCounter, reference->AtomCount, FreeList)) {
 | 
|---|
| 496 |     *out << Verbose(1) << "Filling of ListOfLocalAtoms failed." << endl;
 | 
|---|
| 497 |     return false;
 | 
|---|
| 498 |   }
 | 
|---|
| 499 | 
 | 
|---|
| 500 |   // allocate fragment list
 | 
|---|
| 501 |   if (FragmentList == NULL) {
 | 
|---|
| 502 |     KeySetCounter = Count();
 | 
|---|
| 503 |     FragmentList = (Graph **) Malloc(sizeof(Graph *)*KeySetCounter, "MoleculeLeafClass::AssignKeySetsToFragment - **FragmentList");
 | 
|---|
| 504 |     for(int i=KeySetCounter;i--;)
 | 
|---|
| 505 |       FragmentList[i] = NULL;
 | 
|---|
| 506 |     KeySetCounter = 0;
 | 
|---|
| 507 |   }
 | 
|---|
| 508 |   
 | 
|---|
| 509 |   if ((KeySetList != NULL) && (KeySetList->size() != 0)) { // if there are some scanned keysets at all
 | 
|---|
| 510 |     // assign scanned keysets
 | 
|---|
| 511 |     if (FragmentList[FragmentCounter] == NULL)
 | 
|---|
| 512 |       FragmentList[FragmentCounter] = new Graph;
 | 
|---|
| 513 |     KeySet *TempSet = new KeySet;
 | 
|---|
| 514 |     for(Graph::iterator runner = KeySetList->begin();runner != KeySetList->end(); runner++) { // key sets contain global numbers!
 | 
|---|
| 515 |       if ( ListOfLocalAtoms[FragmentCounter][reference->FindAtom(*((*runner).first.begin()))->nr]->nr != -1) {// as we may assume that that bond structure is unchanged, we only test the first key in each set
 | 
|---|
| 516 |         // translate keyset to local numbers
 | 
|---|
| 517 |         for(KeySet::iterator sprinter = (*runner).first.begin(); sprinter != (*runner).first.end(); sprinter++)
 | 
|---|
| 518 |           TempSet->insert(ListOfLocalAtoms[FragmentCounter][reference->FindAtom(*sprinter)->nr]->nr);
 | 
|---|
| 519 |         // insert into FragmentList
 | 
|---|
| 520 |         FragmentList[FragmentCounter]->insert(GraphPair (*TempSet, pair<int,double>(KeySetCounter++, (*runner).second.second)));
 | 
|---|
| 521 |       }
 | 
|---|
| 522 |       TempSet->clear();
 | 
|---|
| 523 |     }
 | 
|---|
| 524 |     delete(TempSet);
 | 
|---|
| 525 |     if (KeySetCounter == 0) {// if there are no keysets, delete the list
 | 
|---|
| 526 |       *out << Verbose(1) << "KeySetCounter is zero, deleting FragmentList." << endl;
 | 
|---|
| 527 |       delete(FragmentList[FragmentCounter]);
 | 
|---|
| 528 |     } else
 | 
|---|
| 529 |       *out << Verbose(1) << KeySetCounter << " keysets were assigned to subgraph " << FragmentCounter << "." << endl;
 | 
|---|
| 530 |     FragmentCounter++;
 | 
|---|
| 531 |     if (next != NULL)
 | 
|---|
| 532 |       next->AssignKeySetsToFragment(out, reference, KeySetList, ListOfLocalAtoms, FragmentList, FragmentCounter, FreeList);
 | 
|---|
| 533 |     FragmentCounter--;
 | 
|---|
| 534 |   } else
 | 
|---|
| 535 |     *out << Verbose(1) << "KeySetList is NULL or empty." << endl;
 | 
|---|
| 536 |   
 | 
|---|
| 537 |   return status;
 | 
|---|
| 538 | };
 | 
|---|
| 539 | 
 | 
|---|
| 540 | /** Translate list into global numbers (i.e. ones that are valid in "this" molecule, not in MolecularWalker->Leaf)
 | 
|---|
| 541 |  * \param *out output stream for debugging
 | 
|---|
| 542 |  * \param **FragmentList Graph with local numbers per fragment
 | 
|---|
| 543 |  * \param &FragmentCounter counts the fragments as we move along the list
 | 
|---|
| 544 |  * \param &TotalNumberOfKeySets global key set counter
 | 
|---|
| 545 |  * \param &TotalGraph Graph to be filled with global numbers
 | 
|---|
| 546 |  */ 
 | 
|---|
| 547 | void MoleculeLeafClass::TranslateIndicesToGlobalIDs(ofstream *out, Graph **FragmentList, int &FragmentCounter, int &TotalNumberOfKeySets, Graph &TotalGraph)
 | 
|---|
| 548 | {
 | 
|---|
| 549 |   KeySet *TempSet = new KeySet;
 | 
|---|
| 550 |   if (FragmentList[FragmentCounter] != NULL) {
 | 
|---|
| 551 |     for(Graph::iterator runner = FragmentList[FragmentCounter]->begin(); runner != FragmentList[FragmentCounter]->end(); runner++) {
 | 
|---|
| 552 |       for(KeySet::iterator sprinter = (*runner).first.begin(); sprinter != (*runner).first.end(); sprinter++)
 | 
|---|
| 553 |         TempSet->insert((Leaf->FindAtom(*sprinter))->GetTrueFather()->nr);
 | 
|---|
| 554 |       TotalGraph.insert(GraphPair(*TempSet, pair<int,double>(TotalNumberOfKeySets++, (*runner).second.second)));
 | 
|---|
| 555 |       TempSet->clear();
 | 
|---|
| 556 |     }
 | 
|---|
| 557 |     delete(TempSet);
 | 
|---|
| 558 |   } else {
 | 
|---|
| 559 |     *out << Verbose(1) << "FragmentList is NULL." << endl;
 | 
|---|
| 560 |   }
 | 
|---|
| 561 |   if (next != NULL)
 | 
|---|
| 562 |     next->TranslateIndicesToGlobalIDs(out, FragmentList, ++FragmentCounter, TotalNumberOfKeySets, TotalGraph);
 | 
|---|
| 563 |   FragmentCounter--;
 | 
|---|
| 564 | };
 | 
|---|
| 565 | 
 | 
|---|
| 566 | /** Simply counts the number of items in the list, from given MoleculeLeafClass.
 | 
|---|
| 567 |  * \return number of items
 | 
|---|
| 568 |  */
 | 
|---|
| 569 | int MoleculeLeafClass::Count() const
 | 
|---|
| 570 | {
 | 
|---|
| 571 |   if (next != NULL)
 | 
|---|
| 572 |     return next->Count()+1;
 | 
|---|
| 573 |   else
 | 
|---|
| 574 |     return 1; 
 | 
|---|
| 575 | };
 | 
|---|