source: src/molecules.cpp@ 18913c

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults AddingActions_SaveParseParticleParameters Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_ParticleName_to_Atom Adding_StructOpt_integration_tests AtomFragments Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator CombiningParticlePotentialParsing Combining_Subpackages Debian_Package_split Debian_package_split_molecuildergui_only Disabling_MemDebug Docu_Python_wait EmpiricalPotential_contain_HomologyGraph EmpiricalPotential_contain_HomologyGraph_documentation Enable_parallel_make_install Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph FitPartialCharges_GlobalError Fix_BoundInBox_CenterInBox_MoleculeActions Fix_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions Fix_PopActions Fix_QtFragmentList_sorted_selection Fix_Restrictedkeyset_FragmentMolecule Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns Fix_fitting_potentials Fixes ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion FragmentAction_writes_AtomFragments FragmentMolecule_checks_bonddegrees GeometryObjects Gui_Fixes Gui_displays_atomic_force_velocity ImplicitCharges IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix MoreRobust_FragmentAutomation ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PdbParser_setsAtomName PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks Rewrite_FitPartialCharges RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg Switchable_LogView ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps TremoloParser_setsAtomName Ubuntu_1604_changes stable
Last change on this file since 18913c was 698b04, checked in by Frederik Heber <heber@…>, 16 years ago

new function: molecule::OutputTemperatureFromTrajectories() stores velocities as temperature

In order to use VibrAlyzer we need a temperature file, which we don't have anymore as we do the M
D in molecuilder now. Hence, there is a new command line switch (-L) and a menu item in MeasureAt
oms() in order to print temperature or to store it to a given file.

  • Property mode set to 100644
File size: 207.8 KB
Line 
1/** \file molecules.cpp
2 *
3 * Functions for the class molecule.
4 *
5 */
6
7#include "molecules.hpp"
8
9/************************************* Other Functions *************************************/
10
11/** Determines sum of squared distances of \a X to all \a **vectors.
12 * \param *x reference vector
13 * \param *params
14 * \return sum of square distances
15 */
16double LSQ (const gsl_vector * x, void * params)
17{
18 double sum = 0.;
19 struct LSQ_params *par = (struct LSQ_params *)params;
20 Vector **vectors = par->vectors;
21 int num = par->num;
22
23 for (int i=num;i--;) {
24 for(int j=NDIM;j--;)
25 sum += (gsl_vector_get(x,j) - (vectors[i])->x[j])*(gsl_vector_get(x,j) - (vectors[i])->x[j]);
26 }
27
28 return sum;
29};
30
31/************************************* Functions for class molecule *********************************/
32
33/** Constructor of class molecule.
34 * Initialises molecule list with correctly referenced start and end, and sets molecule::last_atom to zero.
35 */
36molecule::molecule(periodentafel *teil)
37{
38 // init atom chain list
39 start = new atom;
40 end = new atom;
41 start->father = NULL;
42 end->father = NULL;
43 link(start,end);
44 // init bond chain list
45 first = new bond(start, end, 1, -1);
46 last = new bond(start, end, 1, -1);
47 link(first,last);
48 // other stuff
49 MDSteps = 0;
50 last_atom = 0;
51 elemente = teil;
52 AtomCount = 0;
53 BondCount = 0;
54 NoNonBonds = 0;
55 NoNonHydrogen = 0;
56 NoCyclicBonds = 0;
57 ListOfBondsPerAtom = NULL;
58 NumberOfBondsPerAtom = NULL;
59 ElementCount = 0;
60 for(int i=MAX_ELEMENTS;i--;)
61 ElementsInMolecule[i] = 0;
62 cell_size[0] = cell_size[2] = cell_size[5]= 20.;
63 cell_size[1] = cell_size[3] = cell_size[4]= 0.;
64};
65
66/** Destructor of class molecule.
67 * Initialises molecule list with correctly referenced start and end, and sets molecule::last_atom to zero.
68 */
69molecule::~molecule()
70{
71 if (ListOfBondsPerAtom != NULL)
72 for(int i=AtomCount;i--;)
73 Free((void **)&ListOfBondsPerAtom[i], "molecule::~molecule: ListOfBondsPerAtom[i]");
74 Free((void **)&ListOfBondsPerAtom, "molecule::~molecule: ListOfBondsPerAtom");
75 Free((void **)&NumberOfBondsPerAtom, "molecule::~molecule: NumberOfBondsPerAtom");
76 CleanupMolecule();
77 delete(first);
78 delete(last);
79 delete(end);
80 delete(start);
81};
82
83/** Adds given atom \a *pointer from molecule list.
84 * Increases molecule::last_atom and gives last number to added atom and names it according to its element::abbrev and molecule::AtomCount
85 * \param *pointer allocated and set atom
86 * \return true - succeeded, false - atom not found in list
87 */
88bool molecule::AddAtom(atom *pointer)
89{
90 if (pointer != NULL) {
91 pointer->sort = &pointer->nr;
92 pointer->nr = last_atom++; // increase number within molecule
93 AtomCount++;
94 if (pointer->type != NULL) {
95 if (ElementsInMolecule[pointer->type->Z] == 0)
96 ElementCount++;
97 ElementsInMolecule[pointer->type->Z]++; // increase number of elements
98 if (pointer->type->Z != 1)
99 NoNonHydrogen++;
100 if (pointer->Name == NULL) {
101 Free((void **)&pointer->Name, "molecule::AddAtom: *pointer->Name");
102 pointer->Name = (char *) Malloc(sizeof(char)*6, "molecule::AddAtom: *pointer->Name");
103 sprintf(pointer->Name, "%2s%02d", pointer->type->symbol, pointer->nr+1);
104 }
105 }
106 return add(pointer, end);
107 } else
108 return false;
109};
110
111/** Adds a copy of the given atom \a *pointer from molecule list.
112 * Increases molecule::last_atom and gives last number to added atom.
113 * \param *pointer allocated and set atom
114 * \return true - succeeded, false - atom not found in list
115 */
116atom * molecule::AddCopyAtom(atom *pointer)
117{
118 if (pointer != NULL) {
119 atom *walker = new atom();
120 walker->type = pointer->type; // copy element of atom
121 walker->x.CopyVector(&pointer->x); // copy coordination
122 walker->v.CopyVector(&pointer->v); // copy velocity
123 walker->FixedIon = pointer->FixedIon;
124 walker->sort = &walker->nr;
125 walker->nr = last_atom++; // increase number within molecule
126 walker->father = pointer; //->GetTrueFather();
127 walker->Name = (char *) Malloc(sizeof(char)*strlen(pointer->Name)+1, "molecule::AddCopyAtom: *Name");
128 strcpy (walker->Name, pointer->Name);
129 add(walker, end);
130 if ((pointer->type != NULL) && (pointer->type->Z != 1))
131 NoNonHydrogen++;
132 AtomCount++;
133 return walker;
134 } else
135 return NULL;
136};
137
138/** Adds a Hydrogen atom in replacement for the given atom \a *partner in bond with a *origin.
139 * Here, we have to distinguish between single, double or triple bonds as stated by \a BondDegree, that each demand
140 * a different scheme when adding \a *replacement atom for the given one.
141 * -# Single Bond: Simply add new atom with bond distance rescaled to typical hydrogen one
142 * -# Double Bond: Here, we need the **BondList of the \a *origin atom, by scanning for the other bonds instead of
143 * *Bond, we use the through these connected atoms to determine the plane they lie in, vector::MakeNormalvector().
144 * The orthonormal vector to this plane along with the vector in *Bond direction determines the plane the two
145 * replacing hydrogens shall lie in. Now, all remains to do is take the usual hydrogen double bond angle for the
146 * element of *origin and form the sin/cos admixture of both plane vectors for the new coordinates of the two
147 * hydrogens forming this angle with *origin.
148 * -# Triple Bond: The idea is to set up a tetraoid (C1-H1-H2-H3) (however the lengths \f$b\f$ of the sides of the base
149 * triangle formed by the to be added hydrogens are not equal to the typical bond distance \f$l\f$ but have to be
150 * determined from the typical angle \f$\alpha\f$ for a hydrogen triple connected to the element of *origin):
151 * We have the height \f$d\f$ as the vector in *Bond direction (from triangle C1-H1-H2).
152 * \f[ h = l \cdot \cos{\left (\frac{\alpha}{2} \right )} \qquad b = 2l \cdot \sin{\left (\frac{\alpha}{2} \right)} \quad \rightarrow \quad d = l \cdot \sqrt{\cos^2{\left (\frac{\alpha}{2} \right)}-\frac{1}{3}\cdot\sin^2{\left (\frac{\alpha}{2}\right )}}
153 * \f]
154 * vector::GetNormalvector() creates one orthonormal vector from this *Bond vector and vector::MakeNormalvector creates
155 * the third one from the former two vectors. The latter ones form the plane of the base triangle mentioned above.
156 * The lengths for these are \f$f\f$ and \f$g\f$ (from triangle H1-H2-(center of H1-H2-H3)) with knowledge that
157 * the median lines in an isosceles triangle meet in the center point with a ratio 2:1.
158 * \f[ f = \frac{b}{\sqrt{3}} \qquad g = \frac{b}{2}
159 * \f]
160 * as the coordination of all three atoms in the coordinate system of these three vectors:
161 * \f$\pmatrix{d & f & 0}\f$, \f$\pmatrix{d & -0.5 \cdot f & g}\f$ and \f$\pmatrix{d & -0.5 \cdot f & -g}\f$.
162 *
163 * \param *out output stream for debugging
164 * \param *Bond pointer to bond between \a *origin and \a *replacement
165 * \param *TopOrigin son of \a *origin of upper level molecule (the atom added to this molecule as a copy of \a *origin)
166 * \param *origin pointer to atom which acts as the origin for scaling the added hydrogen to correct bond length
167 * \param *replacement pointer to the atom which shall be copied as a hydrogen atom in this molecule
168 * \param **BondList list of bonds \a *replacement has (necessary to determine plane for double and triple bonds)
169 * \param NumBond number of bonds in \a **BondList
170 * \param isAngstroem whether the coordination of the given atoms is in AtomicLength (false) or Angstrom(true)
171 * \return number of atoms added, if < bond::BondDegree then something went wrong
172 * \todo double and triple bonds splitting (always use the tetraeder angle!)
173 */
174bool molecule::AddHydrogenReplacementAtom(ofstream *out, bond *TopBond, atom *BottomOrigin, atom *TopOrigin, atom *TopReplacement, bond **BondList, int NumBond, bool IsAngstroem)
175{
176 double bondlength; // bond length of the bond to be replaced/cut
177 double bondangle; // bond angle of the bond to be replaced/cut
178 double BondRescale; // rescale value for the hydrogen bond length
179 bool AllWentWell = true; // flag gathering the boolean return value of molecule::AddAtom and other functions, as return value on exit
180 bond *FirstBond = NULL, *SecondBond = NULL; // Other bonds in double bond case to determine "other" plane
181 atom *FirstOtherAtom = NULL, *SecondOtherAtom = NULL, *ThirdOtherAtom = NULL; // pointer to hydrogen atoms to be added
182 double b,l,d,f,g, alpha, factors[NDIM]; // hold temporary values in triple bond case for coordination determination
183 Vector Orthovector1, Orthovector2; // temporary vectors in coordination construction
184 Vector InBondvector; // vector in direction of *Bond
185 bond *Binder = NULL;
186 double *matrix;
187
188// *out << Verbose(3) << "Begin of AddHydrogenReplacementAtom." << endl;
189 // create vector in direction of bond
190 InBondvector.CopyVector(&TopReplacement->x);
191 InBondvector.SubtractVector(&TopOrigin->x);
192 bondlength = InBondvector.Norm();
193
194 // is greater than typical bond distance? Then we have to correct periodically
195 // the problem is not the H being out of the box, but InBondvector have the wrong direction
196 // due to TopReplacement or Origin being on the wrong side!
197 if (bondlength > BondDistance) {
198// *out << Verbose(4) << "InBondvector is: ";
199// InBondvector.Output(out);
200// *out << endl;
201 Orthovector1.Zero();
202 for (int i=NDIM;i--;) {
203 l = TopReplacement->x.x[i] - TopOrigin->x.x[i];
204 if (fabs(l) > BondDistance) { // is component greater than bond distance
205 Orthovector1.x[i] = (l < 0) ? -1. : +1.;
206 } // (signs are correct, was tested!)
207 }
208 matrix = ReturnFullMatrixforSymmetric(cell_size);
209 Orthovector1.MatrixMultiplication(matrix);
210 InBondvector.SubtractVector(&Orthovector1); // subtract just the additional translation
211 Free((void **)&matrix, "molecule::AddHydrogenReplacementAtom: *matrix");
212 bondlength = InBondvector.Norm();
213// *out << Verbose(4) << "Corrected InBondvector is now: ";
214// InBondvector.Output(out);
215// *out << endl;
216 } // periodic correction finished
217
218 InBondvector.Normalize();
219 // get typical bond length and store as scale factor for later
220 BondRescale = TopOrigin->type->HBondDistance[TopBond->BondDegree-1];
221 if (BondRescale == -1) {
222 cerr << Verbose(3) << "WARNING: There is no typical bond distance for bond (" << TopOrigin->Name << "<->" << TopReplacement->Name << ") of degree " << TopBond->BondDegree << "!" << endl;
223 BondRescale = bondlength;
224 } else {
225 if (!IsAngstroem)
226 BondRescale /= (1.*AtomicLengthToAngstroem);
227 }
228
229 // discern single, double and triple bonds
230 switch(TopBond->BondDegree) {
231 case 1:
232 FirstOtherAtom = new atom(); // new atom
233 FirstOtherAtom->type = elemente->FindElement(1); // element is Hydrogen
234 FirstOtherAtom->v.CopyVector(&TopReplacement->v); // copy velocity
235 FirstOtherAtom->FixedIon = TopReplacement->FixedIon;
236 if (TopReplacement->type->Z == 1) { // neither rescale nor replace if it's already hydrogen
237 FirstOtherAtom->father = TopReplacement;
238 BondRescale = bondlength;
239 } else {
240 FirstOtherAtom->father = NULL; // if we replace hydrogen, we mark it as our father, otherwise we are just an added hydrogen with no father
241 }
242 InBondvector.Scale(&BondRescale); // rescale the distance vector to Hydrogen bond length
243 FirstOtherAtom->x.CopyVector(&TopOrigin->x); // set coordination to origin ...
244 FirstOtherAtom->x.AddVector(&InBondvector); // ... and add distance vector to replacement atom
245 AllWentWell = AllWentWell && AddAtom(FirstOtherAtom);
246// *out << Verbose(4) << "Added " << *FirstOtherAtom << " at: ";
247// FirstOtherAtom->x.Output(out);
248// *out << endl;
249 Binder = AddBond(BottomOrigin, FirstOtherAtom, 1);
250 Binder->Cyclic = false;
251 Binder->Type = TreeEdge;
252 break;
253 case 2:
254 // determine two other bonds (warning if there are more than two other) plus valence sanity check
255 for (int i=0;i<NumBond;i++) {
256 if (BondList[i] != TopBond) {
257 if (FirstBond == NULL) {
258 FirstBond = BondList[i];
259 FirstOtherAtom = BondList[i]->GetOtherAtom(TopOrigin);
260 } else if (SecondBond == NULL) {
261 SecondBond = BondList[i];
262 SecondOtherAtom = BondList[i]->GetOtherAtom(TopOrigin);
263 } else {
264 *out << Verbose(3) << "WARNING: Detected more than four bonds for atom " << TopOrigin->Name;
265 }
266 }
267 }
268 if (SecondOtherAtom == NULL) { // then we have an atom with valence four, but only 3 bonds: one to replace and one which is TopBond (third is FirstBond)
269 SecondBond = TopBond;
270 SecondOtherAtom = TopReplacement;
271 }
272 if (FirstOtherAtom != NULL) { // then we just have this double bond and the plane does not matter at all
273// *out << Verbose(3) << "Regarding the double bond (" << TopOrigin->Name << "<->" << TopReplacement->Name << ") to be constructed: Taking " << FirstOtherAtom->Name << " and " << SecondOtherAtom->Name << " along with " << TopOrigin->Name << " to determine orthogonal plane." << endl;
274
275 // determine the plane of these two with the *origin
276 AllWentWell = AllWentWell && Orthovector1.MakeNormalVector(&TopOrigin->x, &FirstOtherAtom->x, &SecondOtherAtom->x);
277 } else {
278 Orthovector1.GetOneNormalVector(&InBondvector);
279 }
280 //*out << Verbose(3)<< "Orthovector1: ";
281 //Orthovector1.Output(out);
282 //*out << endl;
283 // orthogonal vector and bond vector between origin and replacement form the new plane
284 Orthovector1.MakeNormalVector(&InBondvector);
285 Orthovector1.Normalize();
286 //*out << Verbose(3) << "ReScaleCheck: " << Orthovector1.Norm() << " and " << InBondvector.Norm() << "." << endl;
287
288 // create the two Hydrogens ...
289 FirstOtherAtom = new atom();
290 SecondOtherAtom = new atom();
291 FirstOtherAtom->type = elemente->FindElement(1);
292 SecondOtherAtom->type = elemente->FindElement(1);
293 FirstOtherAtom->v.CopyVector(&TopReplacement->v); // copy velocity
294 FirstOtherAtom->FixedIon = TopReplacement->FixedIon;
295 SecondOtherAtom->v.CopyVector(&TopReplacement->v); // copy velocity
296 SecondOtherAtom->FixedIon = TopReplacement->FixedIon;
297 FirstOtherAtom->father = NULL; // we are just an added hydrogen with no father
298 SecondOtherAtom->father = NULL; // we are just an added hydrogen with no father
299 bondangle = TopOrigin->type->HBondAngle[1];
300 if (bondangle == -1) {
301 *out << Verbose(3) << "WARNING: There is no typical bond angle for bond (" << TopOrigin->Name << "<->" << TopReplacement->Name << ") of degree " << TopBond->BondDegree << "!" << endl;
302 bondangle = 0;
303 }
304 bondangle *= M_PI/180./2.;
305// *out << Verbose(3) << "ReScaleCheck: InBondvector ";
306// InBondvector.Output(out);
307// *out << endl;
308// *out << Verbose(3) << "ReScaleCheck: Orthovector ";
309// Orthovector1.Output(out);
310// *out << endl;
311// *out << Verbose(3) << "Half the bond angle is " << bondangle << ", sin and cos of it: " << sin(bondangle) << ", " << cos(bondangle) << endl;
312 FirstOtherAtom->x.Zero();
313 SecondOtherAtom->x.Zero();
314 for(int i=NDIM;i--;) { // rotate by half the bond angle in both directions (InBondvector is bondangle = 0 direction)
315 FirstOtherAtom->x.x[i] = InBondvector.x[i] * cos(bondangle) + Orthovector1.x[i] * (sin(bondangle));
316 SecondOtherAtom->x.x[i] = InBondvector.x[i] * cos(bondangle) + Orthovector1.x[i] * (-sin(bondangle));
317 }
318 FirstOtherAtom->x.Scale(&BondRescale); // rescale by correct BondDistance
319 SecondOtherAtom->x.Scale(&BondRescale);
320 //*out << Verbose(3) << "ReScaleCheck: " << FirstOtherAtom->x.Norm() << " and " << SecondOtherAtom->x.Norm() << "." << endl;
321 for(int i=NDIM;i--;) { // and make relative to origin atom
322 FirstOtherAtom->x.x[i] += TopOrigin->x.x[i];
323 SecondOtherAtom->x.x[i] += TopOrigin->x.x[i];
324 }
325 // ... and add to molecule
326 AllWentWell = AllWentWell && AddAtom(FirstOtherAtom);
327 AllWentWell = AllWentWell && AddAtom(SecondOtherAtom);
328// *out << Verbose(4) << "Added " << *FirstOtherAtom << " at: ";
329// FirstOtherAtom->x.Output(out);
330// *out << endl;
331// *out << Verbose(4) << "Added " << *SecondOtherAtom << " at: ";
332// SecondOtherAtom->x.Output(out);
333// *out << endl;
334 Binder = AddBond(BottomOrigin, FirstOtherAtom, 1);
335 Binder->Cyclic = false;
336 Binder->Type = TreeEdge;
337 Binder = AddBond(BottomOrigin, SecondOtherAtom, 1);
338 Binder->Cyclic = false;
339 Binder->Type = TreeEdge;
340 break;
341 case 3:
342 // take the "usual" tetraoidal angle and add the three Hydrogen in direction of the bond (height of the tetraoid)
343 FirstOtherAtom = new atom();
344 SecondOtherAtom = new atom();
345 ThirdOtherAtom = new atom();
346 FirstOtherAtom->type = elemente->FindElement(1);
347 SecondOtherAtom->type = elemente->FindElement(1);
348 ThirdOtherAtom->type = elemente->FindElement(1);
349 FirstOtherAtom->v.CopyVector(&TopReplacement->v); // copy velocity
350 FirstOtherAtom->FixedIon = TopReplacement->FixedIon;
351 SecondOtherAtom->v.CopyVector(&TopReplacement->v); // copy velocity
352 SecondOtherAtom->FixedIon = TopReplacement->FixedIon;
353 ThirdOtherAtom->v.CopyVector(&TopReplacement->v); // copy velocity
354 ThirdOtherAtom->FixedIon = TopReplacement->FixedIon;
355 FirstOtherAtom->father = NULL; // we are just an added hydrogen with no father
356 SecondOtherAtom->father = NULL; // we are just an added hydrogen with no father
357 ThirdOtherAtom->father = NULL; // we are just an added hydrogen with no father
358
359 // we need to vectors orthonormal the InBondvector
360 AllWentWell = AllWentWell && Orthovector1.GetOneNormalVector(&InBondvector);
361// *out << Verbose(3) << "Orthovector1: ";
362// Orthovector1.Output(out);
363// *out << endl;
364 AllWentWell = AllWentWell && Orthovector2.MakeNormalVector(&InBondvector, &Orthovector1);
365// *out << Verbose(3) << "Orthovector2: ";
366// Orthovector2.Output(out);
367// *out << endl;
368
369 // create correct coordination for the three atoms
370 alpha = (TopOrigin->type->HBondAngle[2])/180.*M_PI/2.; // retrieve triple bond angle from database
371 l = BondRescale; // desired bond length
372 b = 2.*l*sin(alpha); // base length of isosceles triangle
373 d = l*sqrt(cos(alpha)*cos(alpha) - sin(alpha)*sin(alpha)/3.); // length for InBondvector
374 f = b/sqrt(3.); // length for Orthvector1
375 g = b/2.; // length for Orthvector2
376// *out << Verbose(3) << "Bond length and half-angle: " << l << ", " << alpha << "\t (b,d,f,g) = " << b << ", " << d << ", " << f << ", " << g << ", " << endl;
377// *out << Verbose(3) << "The three Bond lengths: " << sqrt(d*d+f*f) << ", " << sqrt(d*d+(-0.5*f)*(-0.5*f)+g*g) << ", " << sqrt(d*d+(-0.5*f)*(-0.5*f)+g*g) << endl;
378 factors[0] = d;
379 factors[1] = f;
380 factors[2] = 0.;
381 FirstOtherAtom->x.LinearCombinationOfVectors(&InBondvector, &Orthovector1, &Orthovector2, factors);
382 factors[1] = -0.5*f;
383 factors[2] = g;
384 SecondOtherAtom->x.LinearCombinationOfVectors(&InBondvector, &Orthovector1, &Orthovector2, factors);
385 factors[2] = -g;
386 ThirdOtherAtom->x.LinearCombinationOfVectors(&InBondvector, &Orthovector1, &Orthovector2, factors);
387
388 // rescale each to correct BondDistance
389// FirstOtherAtom->x.Scale(&BondRescale);
390// SecondOtherAtom->x.Scale(&BondRescale);
391// ThirdOtherAtom->x.Scale(&BondRescale);
392
393 // and relative to *origin atom
394 FirstOtherAtom->x.AddVector(&TopOrigin->x);
395 SecondOtherAtom->x.AddVector(&TopOrigin->x);
396 ThirdOtherAtom->x.AddVector(&TopOrigin->x);
397
398 // ... and add to molecule
399 AllWentWell = AllWentWell && AddAtom(FirstOtherAtom);
400 AllWentWell = AllWentWell && AddAtom(SecondOtherAtom);
401 AllWentWell = AllWentWell && AddAtom(ThirdOtherAtom);
402// *out << Verbose(4) << "Added " << *FirstOtherAtom << " at: ";
403// FirstOtherAtom->x.Output(out);
404// *out << endl;
405// *out << Verbose(4) << "Added " << *SecondOtherAtom << " at: ";
406// SecondOtherAtom->x.Output(out);
407// *out << endl;
408// *out << Verbose(4) << "Added " << *ThirdOtherAtom << " at: ";
409// ThirdOtherAtom->x.Output(out);
410// *out << endl;
411 Binder = AddBond(BottomOrigin, FirstOtherAtom, 1);
412 Binder->Cyclic = false;
413 Binder->Type = TreeEdge;
414 Binder = AddBond(BottomOrigin, SecondOtherAtom, 1);
415 Binder->Cyclic = false;
416 Binder->Type = TreeEdge;
417 Binder = AddBond(BottomOrigin, ThirdOtherAtom, 1);
418 Binder->Cyclic = false;
419 Binder->Type = TreeEdge;
420 break;
421 default:
422 cerr << "ERROR: BondDegree does not state single, double or triple bond!" << endl;
423 AllWentWell = false;
424 break;
425 }
426
427// *out << Verbose(3) << "End of AddHydrogenReplacementAtom." << endl;
428 return AllWentWell;
429};
430
431/** Adds given atom \a *pointer from molecule list.
432 * Increases molecule::last_atom and gives last number to added atom.
433 * \param filename name and path of xyz file
434 * \return true - succeeded, false - file not found
435 */
436bool molecule::AddXYZFile(string filename)
437{
438 istringstream *input = NULL;
439 int NumberOfAtoms = 0; // atom number in xyz read
440 int i, j; // loop variables
441 atom *Walker = NULL; // pointer to added atom
442 char shorthand[3]; // shorthand for atom name
443 ifstream xyzfile; // xyz file
444 string line; // currently parsed line
445 double x[3]; // atom coordinates
446
447 xyzfile.open(filename.c_str());
448 if (!xyzfile)
449 return false;
450
451 getline(xyzfile,line,'\n'); // Read numer of atoms in file
452 input = new istringstream(line);
453 *input >> NumberOfAtoms;
454 cout << Verbose(0) << "Parsing " << NumberOfAtoms << " atoms in file." << endl;
455 getline(xyzfile,line,'\n'); // Read comment
456 cout << Verbose(1) << "Comment: " << line << endl;
457
458 if (MDSteps == 0) // no atoms yet present
459 MDSteps++;
460 for(i=0;i<NumberOfAtoms;i++){
461 Walker = new atom;
462 getline(xyzfile,line,'\n');
463 istringstream *item = new istringstream(line);
464 //istringstream input(line);
465 //cout << Verbose(1) << "Reading: " << line << endl;
466 *item >> shorthand;
467 *item >> x[0];
468 *item >> x[1];
469 *item >> x[2];
470 Walker->type = elemente->FindElement(shorthand);
471 if (Walker->type == NULL) {
472 cerr << "Could not parse the element at line: '" << line << "', setting to H.";
473 Walker->type = elemente->FindElement(1);
474 }
475 if (Trajectories[Walker].R.size() <= (unsigned int)MDSteps) {
476 Trajectories[Walker].R.resize(MDSteps+10);
477 Trajectories[Walker].U.resize(MDSteps+10);
478 Trajectories[Walker].F.resize(MDSteps+10);
479 }
480 for(j=NDIM;j--;) {
481 Walker->x.x[j] = x[j];
482 Trajectories[Walker].R.at(MDSteps-1).x[j] = x[j];
483 Trajectories[Walker].U.at(MDSteps-1).x[j] = 0;
484 Trajectories[Walker].F.at(MDSteps-1).x[j] = 0;
485 }
486 AddAtom(Walker); // add to molecule
487 delete(item);
488 }
489 xyzfile.close();
490 delete(input);
491 return true;
492};
493
494/** Creates a copy of this molecule.
495 * \return copy of molecule
496 */
497molecule *molecule::CopyMolecule()
498{
499 molecule *copy = new molecule(elemente);
500 atom *CurrentAtom = NULL;
501 atom *LeftAtom = NULL, *RightAtom = NULL;
502 atom *Walker = NULL;
503
504 // copy all atoms
505 Walker = start;
506 while(Walker->next != end) {
507 Walker = Walker->next;
508 CurrentAtom = copy->AddCopyAtom(Walker);
509 }
510
511 // copy all bonds
512 bond *Binder = first;
513 bond *NewBond = NULL;
514 while(Binder->next != last) {
515 Binder = Binder->next;
516 // get the pendant atoms of current bond in the copy molecule
517 LeftAtom = copy->start;
518 while (LeftAtom->next != copy->end) {
519 LeftAtom = LeftAtom->next;
520 if (LeftAtom->father == Binder->leftatom)
521 break;
522 }
523 RightAtom = copy->start;
524 while (RightAtom->next != copy->end) {
525 RightAtom = RightAtom->next;
526 if (RightAtom->father == Binder->rightatom)
527 break;
528 }
529 NewBond = copy->AddBond(LeftAtom, RightAtom, Binder->BondDegree);
530 NewBond->Cyclic = Binder->Cyclic;
531 if (Binder->Cyclic)
532 copy->NoCyclicBonds++;
533 NewBond->Type = Binder->Type;
534 }
535 // correct fathers
536 Walker = copy->start;
537 while(Walker->next != copy->end) {
538 Walker = Walker->next;
539 if (Walker->father->father == Walker->father) // same atom in copy's father points to itself
540 Walker->father = Walker; // set father to itself (copy of a whole molecule)
541 else
542 Walker->father = Walker->father->father; // set father to original's father
543 }
544 // copy values
545 copy->CountAtoms((ofstream *)&cout);
546 copy->CountElements();
547 if (first->next != last) { // if adjaceny list is present
548 copy->BondDistance = BondDistance;
549 copy->CreateListOfBondsPerAtom((ofstream *)&cout);
550 }
551
552 return copy;
553};
554
555/** Adds a bond to a the molecule specified by two atoms, \a *first and \a *second.
556 * Also updates molecule::BondCount and molecule::NoNonBonds.
557 * \param *first first atom in bond
558 * \param *second atom in bond
559 * \return pointer to bond or NULL on failure
560 */
561bond * molecule::AddBond(atom *atom1, atom *atom2, int degree=1)
562{
563 bond *Binder = NULL;
564 if ((atom1 != NULL) && (FindAtom(atom1->nr) != NULL) && (atom2 != NULL) && (FindAtom(atom2->nr) != NULL)) {
565 Binder = new bond(atom1, atom2, degree, BondCount++);
566 if ((atom1->type != NULL) && (atom1->type->Z != 1) && (atom2->type != NULL) && (atom2->type->Z != 1))
567 NoNonBonds++;
568 add(Binder, last);
569 } else {
570 cerr << Verbose(1) << "ERROR: Could not add bond between " << atom1->Name << " and " << atom2->Name << " as one or both are not present in the molecule." << endl;
571 }
572 return Binder;
573};
574
575/** Remove bond from bond chain list.
576 * \todo Function not implemented yet
577 * \param *pointer bond pointer
578 * \return true - bound found and removed, false - bond not found/removed
579 */
580bool molecule::RemoveBond(bond *pointer)
581{
582 //cerr << Verbose(1) << "molecule::RemoveBond: Function not implemented yet." << endl;
583 removewithoutcheck(pointer);
584 return true;
585};
586
587/** Remove every bond from bond chain list that atom \a *BondPartner is a constituent of.
588 * \todo Function not implemented yet
589 * \param *BondPartner atom to be removed
590 * \return true - bounds found and removed, false - bonds not found/removed
591 */
592bool molecule::RemoveBonds(atom *BondPartner)
593{
594 cerr << Verbose(1) << "molecule::RemoveBond: Function not implemented yet." << endl;
595 return false;
596};
597
598/** Sets the molecule::cell_size to the components of \a *dim (rectangular box)
599 * \param *dim vector class
600 */
601void molecule::SetBoxDimension(Vector *dim)
602{
603 cell_size[0] = dim->x[0];
604 cell_size[1] = 0.;
605 cell_size[2] = dim->x[1];
606 cell_size[3] = 0.;
607 cell_size[4] = 0.;
608 cell_size[5] = dim->x[2];
609};
610
611/** Centers the molecule in the box whose lengths are defined by vector \a *BoxLengths.
612 * \param *out output stream for debugging
613 * \param *BoxLengths box lengths
614 */
615bool molecule::CenterInBox(ofstream *out, Vector *BoxLengths)
616{
617 bool status = true;
618 atom *ptr = NULL;
619 Vector *min = new Vector;
620 Vector *max = new Vector;
621
622 // gather min and max for each axis
623 ptr = start->next; // start at first in list
624 if (ptr != end) { //list not empty?
625 for (int i=NDIM;i--;) {
626 max->x[i] = ptr->x.x[i];
627 min->x[i] = ptr->x.x[i];
628 }
629 while (ptr->next != end) { // continue with second if present
630 ptr = ptr->next;
631 //ptr->Output(1,1,out);
632 for (int i=NDIM;i--;) {
633 max->x[i] = (max->x[i] < ptr->x.x[i]) ? ptr->x.x[i] : max->x[i];
634 min->x[i] = (min->x[i] > ptr->x.x[i]) ? ptr->x.x[i] : min->x[i];
635 }
636 }
637 }
638 // sanity check
639 for(int i=NDIM;i--;) {
640 if (max->x[i] - min->x[i] > BoxLengths->x[i])
641 status = false;
642 }
643 // warn if check failed
644 if (!status)
645 *out << "WARNING: molecule is bigger than defined box!" << endl;
646 else { // else center in box
647 max->AddVector(min);
648 max->Scale(-1.);
649 max->AddVector(BoxLengths);
650 max->Scale(0.5);
651 Translate(max);
652 }
653
654 // free and exit
655 delete(min);
656 delete(max);
657 return status;
658};
659
660/** Centers the edge of the atoms at (0,0,0).
661 * \param *out output stream for debugging
662 * \param *max coordinates of other edge, specifying box dimensions.
663 */
664void molecule::CenterEdge(ofstream *out, Vector *max)
665{
666 Vector *min = new Vector;
667
668// *out << Verbose(3) << "Begin of CenterEdge." << endl;
669 atom *ptr = start->next; // start at first in list
670 if (ptr != end) { //list not empty?
671 for (int i=NDIM;i--;) {
672 max->x[i] = ptr->x.x[i];
673 min->x[i] = ptr->x.x[i];
674 }
675 while (ptr->next != end) { // continue with second if present
676 ptr = ptr->next;
677 //ptr->Output(1,1,out);
678 for (int i=NDIM;i--;) {
679 max->x[i] = (max->x[i] < ptr->x.x[i]) ? ptr->x.x[i] : max->x[i];
680 min->x[i] = (min->x[i] > ptr->x.x[i]) ? ptr->x.x[i] : min->x[i];
681 }
682 }
683// *out << Verbose(4) << "Maximum is ";
684// max->Output(out);
685// *out << ", Minimum is ";
686// min->Output(out);
687// *out << endl;
688 min->Scale(-1.);
689 max->AddVector(min);
690 Translate(min);
691 }
692 delete(min);
693// *out << Verbose(3) << "End of CenterEdge." << endl;
694};
695
696/** Centers the center of the atoms at (0,0,0).
697 * \param *out output stream for debugging
698 * \param *center return vector for translation vector
699 */
700void molecule::CenterOrigin(ofstream *out, Vector *center)
701{
702 int Num = 0;
703 atom *ptr = start->next; // start at first in list
704
705 for(int i=NDIM;i--;) // zero center vector
706 center->x[i] = 0.;
707
708 if (ptr != end) { //list not empty?
709 while (ptr->next != end) { // continue with second if present
710 ptr = ptr->next;
711 Num++;
712 center->AddVector(&ptr->x);
713 }
714 center->Scale(-1./Num); // divide through total number (and sign for direction)
715 Translate(center);
716 }
717};
718
719/** Returns vector pointing to center of gravity.
720 * \param *out output stream for debugging
721 * \return pointer to center of gravity vector
722 */
723Vector * molecule::DetermineCenterOfAll(ofstream *out)
724{
725 atom *ptr = start->next; // start at first in list
726 Vector *a = new Vector();
727 Vector tmp;
728 double Num = 0;
729
730 a->Zero();
731
732 if (ptr != end) { //list not empty?
733 while (ptr->next != end) { // continue with second if present
734 ptr = ptr->next;
735 Num += 1.;
736 tmp.CopyVector(&ptr->x);
737 a->AddVector(&tmp);
738 }
739 a->Scale(-1./Num); // divide through total mass (and sign for direction)
740 }
741 //cout << Verbose(1) << "Resulting center of gravity: ";
742 //a->Output(out);
743 //cout << endl;
744 return a;
745};
746
747/** Returns vector pointing to center of gravity.
748 * \param *out output stream for debugging
749 * \return pointer to center of gravity vector
750 */
751Vector * molecule::DetermineCenterOfGravity(ofstream *out)
752{
753 atom *ptr = start->next; // start at first in list
754 Vector *a = new Vector();
755 Vector tmp;
756 double Num = 0;
757
758 a->Zero();
759
760 if (ptr != end) { //list not empty?
761 while (ptr->next != end) { // continue with second if present
762 ptr = ptr->next;
763 Num += ptr->type->mass;
764 tmp.CopyVector(&ptr->x);
765 tmp.Scale(ptr->type->mass); // scale by mass
766 a->AddVector(&tmp);
767 }
768 a->Scale(-1./Num); // divide through total mass (and sign for direction)
769 }
770// *out << Verbose(1) << "Resulting center of gravity: ";
771// a->Output(out);
772// *out << endl;
773 return a;
774};
775
776/** Centers the center of gravity of the atoms at (0,0,0).
777 * \param *out output stream for debugging
778 * \param *center return vector for translation vector
779 */
780void molecule::CenterGravity(ofstream *out, Vector *center)
781{
782 if (center == NULL) {
783 DetermineCenter(*center);
784 Translate(center);
785 delete(center);
786 } else {
787 Translate(center);
788 }
789};
790
791/** Scales all atoms by \a *factor.
792 * \param *factor pointer to scaling factor
793 */
794void molecule::Scale(double **factor)
795{
796 atom *ptr = start;
797
798 while (ptr->next != end) {
799 ptr = ptr->next;
800 for (int j=0;j<MDSteps;j++)
801 Trajectories[ptr].R.at(j).Scale(factor);
802 ptr->x.Scale(factor);
803 }
804};
805
806/** Translate all atoms by given vector.
807 * \param trans[] translation vector.
808 */
809void molecule::Translate(const Vector *trans)
810{
811 atom *ptr = start;
812
813 while (ptr->next != end) {
814 ptr = ptr->next;
815 for (int j=0;j<MDSteps;j++)
816 Trajectories[ptr].R.at(j).Translate(trans);
817 ptr->x.Translate(trans);
818 }
819};
820
821/** Mirrors all atoms against a given plane.
822 * \param n[] normal vector of mirror plane.
823 */
824void molecule::Mirror(const Vector *n)
825{
826 atom *ptr = start;
827
828 while (ptr->next != end) {
829 ptr = ptr->next;
830 for (int j=0;j<MDSteps;j++)
831 Trajectories[ptr].R.at(j).Mirror(n);
832 ptr->x.Mirror(n);
833 }
834};
835
836/** Determines center of molecule (yet not considering atom masses).
837 * \param Center reference to return vector
838 */
839void molecule::DetermineCenter(Vector &Center)
840{
841 atom *Walker = start;
842 bond *Binder = NULL;
843 double *matrix = ReturnFullMatrixforSymmetric(cell_size);
844 double tmp;
845 bool flag;
846 Vector Testvector, Translationvector;
847
848 do {
849 Center.Zero();
850 flag = true;
851 while (Walker->next != end) {
852 Walker = Walker->next;
853#ifdef ADDHYDROGEN
854 if (Walker->type->Z != 1) {
855#endif
856 Testvector.CopyVector(&Walker->x);
857 Testvector.InverseMatrixMultiplication(matrix);
858 Translationvector.Zero();
859 for (int i=0;i<NumberOfBondsPerAtom[Walker->nr]; i++) {
860 Binder = ListOfBondsPerAtom[Walker->nr][i];
861 if (Walker->nr < Binder->GetOtherAtom(Walker)->nr) // otherwise we shift one to, the other fro and gain nothing
862 for (int j=0;j<NDIM;j++) {
863 tmp = Walker->x.x[j] - Binder->GetOtherAtom(Walker)->x.x[j];
864 if ((fabs(tmp)) > BondDistance) {
865 flag = false;
866 cout << Verbose(0) << "Hit: atom " << Walker->Name << " in bond " << *Binder << " has to be shifted due to " << tmp << "." << endl;
867 if (tmp > 0)
868 Translationvector.x[j] -= 1.;
869 else
870 Translationvector.x[j] += 1.;
871 }
872 }
873 }
874 Testvector.AddVector(&Translationvector);
875 Testvector.MatrixMultiplication(matrix);
876 Center.AddVector(&Testvector);
877 cout << Verbose(1) << "vector is: ";
878 Testvector.Output((ofstream *)&cout);
879 cout << endl;
880#ifdef ADDHYDROGEN
881 // now also change all hydrogens
882 for (int i=0;i<NumberOfBondsPerAtom[Walker->nr]; i++) {
883 Binder = ListOfBondsPerAtom[Walker->nr][i];
884 if (Binder->GetOtherAtom(Walker)->type->Z == 1) {
885 Testvector.CopyVector(&Binder->GetOtherAtom(Walker)->x);
886 Testvector.InverseMatrixMultiplication(matrix);
887 Testvector.AddVector(&Translationvector);
888 Testvector.MatrixMultiplication(matrix);
889 Center.AddVector(&Testvector);
890 cout << Verbose(1) << "Hydrogen vector is: ";
891 Testvector.Output((ofstream *)&cout);
892 cout << endl;
893 }
894 }
895 }
896#endif
897 }
898 } while (!flag);
899 Free((void **)&matrix, "molecule::DetermineCenter: *matrix");
900 Center.Scale(1./(double)AtomCount);
901};
902
903/** Transforms/Rotates the given molecule into its principal axis system.
904 * \param *out output stream for debugging
905 * \param DoRotate whether to rotate (true) or only to determine the PAS.
906 */
907void molecule::PrincipalAxisSystem(ofstream *out, bool DoRotate)
908{
909 atom *ptr = start; // start at first in list
910 double InertiaTensor[NDIM*NDIM];
911 Vector *CenterOfGravity = DetermineCenterOfGravity(out);
912
913 CenterGravity(out, CenterOfGravity);
914
915 // reset inertia tensor
916 for(int i=0;i<NDIM*NDIM;i++)
917 InertiaTensor[i] = 0.;
918
919 // sum up inertia tensor
920 while (ptr->next != end) {
921 ptr = ptr->next;
922 Vector x;
923 x.CopyVector(&ptr->x);
924 //x.SubtractVector(CenterOfGravity);
925 InertiaTensor[0] += ptr->type->mass*(x.x[1]*x.x[1] + x.x[2]*x.x[2]);
926 InertiaTensor[1] += ptr->type->mass*(-x.x[0]*x.x[1]);
927 InertiaTensor[2] += ptr->type->mass*(-x.x[0]*x.x[2]);
928 InertiaTensor[3] += ptr->type->mass*(-x.x[1]*x.x[0]);
929 InertiaTensor[4] += ptr->type->mass*(x.x[0]*x.x[0] + x.x[2]*x.x[2]);
930 InertiaTensor[5] += ptr->type->mass*(-x.x[1]*x.x[2]);
931 InertiaTensor[6] += ptr->type->mass*(-x.x[2]*x.x[0]);
932 InertiaTensor[7] += ptr->type->mass*(-x.x[2]*x.x[1]);
933 InertiaTensor[8] += ptr->type->mass*(x.x[0]*x.x[0] + x.x[1]*x.x[1]);
934 }
935 // print InertiaTensor for debugging
936 *out << "The inertia tensor is:" << endl;
937 for(int i=0;i<NDIM;i++) {
938 for(int j=0;j<NDIM;j++)
939 *out << InertiaTensor[i*NDIM+j] << " ";
940 *out << endl;
941 }
942 *out << endl;
943
944 // diagonalize to determine principal axis system
945 gsl_eigen_symmv_workspace *T = gsl_eigen_symmv_alloc(NDIM);
946 gsl_matrix_view m = gsl_matrix_view_array(InertiaTensor, NDIM, NDIM);
947 gsl_vector *eval = gsl_vector_alloc(NDIM);
948 gsl_matrix *evec = gsl_matrix_alloc(NDIM, NDIM);
949 gsl_eigen_symmv(&m.matrix, eval, evec, T);
950 gsl_eigen_symmv_free(T);
951 gsl_eigen_symmv_sort(eval, evec, GSL_EIGEN_SORT_ABS_DESC);
952
953 for(int i=0;i<NDIM;i++) {
954 *out << Verbose(1) << "eigenvalue = " << gsl_vector_get(eval, i);
955 *out << ", eigenvector = (" << evec->data[i * evec->tda + 0] << "," << evec->data[i * evec->tda + 1] << "," << evec->data[i * evec->tda + 2] << ")" << endl;
956 }
957
958 // check whether we rotate or not
959 if (DoRotate) {
960 *out << Verbose(1) << "Transforming molecule into PAS ... ";
961 // the eigenvectors specify the transformation matrix
962 ptr = start;
963 while (ptr->next != end) {
964 ptr = ptr->next;
965 for (int j=0;j<MDSteps;j++)
966 Trajectories[ptr].R.at(j).MatrixMultiplication(evec->data);
967 ptr->x.MatrixMultiplication(evec->data);
968 }
969 *out << "done." << endl;
970
971 // summing anew for debugging (resulting matrix has to be diagonal!)
972 // reset inertia tensor
973 for(int i=0;i<NDIM*NDIM;i++)
974 InertiaTensor[i] = 0.;
975
976 // sum up inertia tensor
977 ptr = start;
978 while (ptr->next != end) {
979 ptr = ptr->next;
980 Vector x;
981 x.CopyVector(&ptr->x);
982 //x.SubtractVector(CenterOfGravity);
983 InertiaTensor[0] += ptr->type->mass*(x.x[1]*x.x[1] + x.x[2]*x.x[2]);
984 InertiaTensor[1] += ptr->type->mass*(-x.x[0]*x.x[1]);
985 InertiaTensor[2] += ptr->type->mass*(-x.x[0]*x.x[2]);
986 InertiaTensor[3] += ptr->type->mass*(-x.x[1]*x.x[0]);
987 InertiaTensor[4] += ptr->type->mass*(x.x[0]*x.x[0] + x.x[2]*x.x[2]);
988 InertiaTensor[5] += ptr->type->mass*(-x.x[1]*x.x[2]);
989 InertiaTensor[6] += ptr->type->mass*(-x.x[2]*x.x[0]);
990 InertiaTensor[7] += ptr->type->mass*(-x.x[2]*x.x[1]);
991 InertiaTensor[8] += ptr->type->mass*(x.x[0]*x.x[0] + x.x[1]*x.x[1]);
992 }
993 // print InertiaTensor for debugging
994 *out << "The inertia tensor is:" << endl;
995 for(int i=0;i<NDIM;i++) {
996 for(int j=0;j<NDIM;j++)
997 *out << InertiaTensor[i*NDIM+j] << " ";
998 *out << endl;
999 }
1000 *out << endl;
1001 }
1002
1003 // free everything
1004 delete(CenterOfGravity);
1005 gsl_vector_free(eval);
1006 gsl_matrix_free(evec);
1007};
1008
1009/** Parses nuclear forces from file and performs Verlet integration.
1010 * Note that we assume the parsed forces to be in atomic units (hence, if coordinates are in angstroem, we
1011 * have to transform them).
1012 * This adds a new MD step to the config file.
1013 * \param *file filename
1014 * \param delta_t time step width in atomic units
1015 * \param IsAngstroem whether coordinates are in angstroem (true) or bohrradius (false)
1016 * \return true - file found and parsed, false - file not found or imparsable
1017 */
1018bool molecule::VerletForceIntegration(char *file, double delta_t, bool IsAngstroem)
1019{
1020 element *runner = elemente->start;
1021 atom *walker = NULL;
1022 int AtomNo;
1023 ifstream input(file);
1024 string token;
1025 stringstream item;
1026 double a, IonMass, Vector[NDIM];
1027 ForceMatrix Force;
1028
1029 CountElements(); // make sure ElementsInMolecule is up to date
1030
1031 // check file
1032 if (input == NULL) {
1033 return false;
1034 } else {
1035 // parse file into ForceMatrix
1036 if (!Force.ParseMatrix(file, 0,0,0)) {
1037 cerr << "Could not parse Force Matrix file " << file << "." << endl;
1038 return false;
1039 }
1040 if (Force.RowCounter[0] != AtomCount) {
1041 cerr << "Mismatch between number of atoms in file " << Force.RowCounter[0] << " and in molecule " << AtomCount << "." << endl;
1042 return false;
1043 }
1044 // correct Forces
1045 for(int d=0;d<NDIM;d++)
1046 Vector[d] = 0.;
1047 for(int i=0;i<AtomCount;i++)
1048 for(int d=0;d<NDIM;d++) {
1049 Vector[d] += Force.Matrix[0][i][d+5];
1050 }
1051 for(int i=0;i<AtomCount;i++)
1052 for(int d=0;d<NDIM;d++) {
1053 Force.Matrix[0][i][d+5] -= Vector[d]/(double)AtomCount;
1054 }
1055 // and perform Verlet integration for each atom with position, velocity and force vector
1056 runner = elemente->start;
1057 while (runner->next != elemente->end) { // go through every element
1058 runner = runner->next;
1059 IonMass = runner->mass;
1060 a = delta_t*0.5/IonMass; // (F+F_old)/2m = a and thus: v = (F+F_old)/2m * t = (F + F_old) * a
1061 if (ElementsInMolecule[runner->Z]) { // if this element got atoms
1062 AtomNo = 0;
1063 walker = start;
1064 while (walker->next != end) { // go through every atom of this element
1065 walker = walker->next;
1066 if (walker->type == runner) { // if this atom fits to element
1067 // check size of vectors
1068 if (Trajectories[walker].R.size() <= (unsigned int)(MDSteps)) {
1069 //cout << "Increasing size for trajectory array of " << *walker << " to " << (size+10) << "." << endl;
1070 Trajectories[walker].R.resize(MDSteps+10);
1071 Trajectories[walker].U.resize(MDSteps+10);
1072 Trajectories[walker].F.resize(MDSteps+10);
1073 }
1074
1075 // Update R (and F)
1076 for (int d=0; d<NDIM; d++) {
1077 Trajectories[walker].F.at(MDSteps).x[d] = -Force.Matrix[0][AtomNo][d+5]*(IsAngstroem ? AtomicLengthToAngstroem : 1.);
1078 Trajectories[walker].R.at(MDSteps).x[d] = Trajectories[walker].R.at(MDSteps-1).x[d];
1079 Trajectories[walker].R.at(MDSteps).x[d] += delta_t*(Trajectories[walker].U.at(MDSteps-1).x[d]);
1080 Trajectories[walker].R.at(MDSteps).x[d] += delta_t*a*(Trajectories[walker].F.at(MDSteps).x[d]); // F = m * a and s = 0.5 * F/m * t^2 = F * a * t
1081 }
1082 // Update U
1083 for (int d=0; d<NDIM; d++) {
1084 Trajectories[walker].U.at(MDSteps).x[d] = Trajectories[walker].U.at(MDSteps-1).x[d];
1085 Trajectories[walker].U.at(MDSteps).x[d] += a * (Trajectories[walker].F.at(MDSteps).x[d]+Trajectories[walker].F.at(MDSteps-1).x[d]);
1086 }
1087// cout << "Integrated position&velocity of step " << (MDSteps) << ": (";
1088// for (int d=0;d<NDIM;d++)
1089// cout << Trajectories[walker].R.at(MDSteps).x[d] << " "; // next step
1090// cout << ")\t(";
1091// for (int d=0;d<NDIM;d++)
1092// cout << Trajectories[walker].U.at(MDSteps).x[d] << " "; // next step
1093// cout << ")" << endl;
1094 // next atom
1095 AtomNo++;
1096 }
1097 }
1098 }
1099 }
1100 }
1101// // correct velocities (rather momenta) so that center of mass remains motionless
1102// for(int d=0;d<NDIM;d++)
1103// Vector[d] = 0.;
1104// IonMass = 0.;
1105// walker = start;
1106// while (walker->next != end) { // go through every atom
1107// walker = walker->next;
1108// IonMass += walker->type->mass; // sum up total mass
1109// for(int d=0;d<NDIM;d++) {
1110// Vector[d] += Trajectories[walker].U.at(MDSteps).x[d]*walker->type->mass;
1111// }
1112// }
1113// walker = start;
1114// while (walker->next != end) { // go through every atom of this element
1115// walker = walker->next;
1116// for(int d=0;d<NDIM;d++) {
1117// Trajectories[walker].U.at(MDSteps).x[d] -= Vector[d]*walker->type->mass/IonMass;
1118// }
1119// }
1120 MDSteps++;
1121
1122
1123 // exit
1124 return true;
1125};
1126
1127/** Align all atoms in such a manner that given vector \a *n is along z axis.
1128 * \param n[] alignment vector.
1129 */
1130void molecule::Align(Vector *n)
1131{
1132 atom *ptr = start;
1133 double alpha, tmp;
1134 Vector z_axis;
1135 z_axis.x[0] = 0.;
1136 z_axis.x[1] = 0.;
1137 z_axis.x[2] = 1.;
1138
1139 // rotate on z-x plane
1140 cout << Verbose(0) << "Begin of Aligning all atoms." << endl;
1141 alpha = atan(-n->x[0]/n->x[2]);
1142 cout << Verbose(1) << "Z-X-angle: " << alpha << " ... ";
1143 while (ptr->next != end) {
1144 ptr = ptr->next;
1145 tmp = ptr->x.x[0];
1146 ptr->x.x[0] = cos(alpha) * tmp + sin(alpha) * ptr->x.x[2];
1147 ptr->x.x[2] = -sin(alpha) * tmp + cos(alpha) * ptr->x.x[2];
1148 for (int j=0;j<MDSteps;j++) {
1149 tmp = Trajectories[ptr].R.at(j).x[0];
1150 Trajectories[ptr].R.at(j).x[0] = cos(alpha) * tmp + sin(alpha) * Trajectories[ptr].R.at(j).x[2];
1151 Trajectories[ptr].R.at(j).x[2] = -sin(alpha) * tmp + cos(alpha) * Trajectories[ptr].R.at(j).x[2];
1152 }
1153 }
1154 // rotate n vector
1155 tmp = n->x[0];
1156 n->x[0] = cos(alpha) * tmp + sin(alpha) * n->x[2];
1157 n->x[2] = -sin(alpha) * tmp + cos(alpha) * n->x[2];
1158 cout << Verbose(1) << "alignment vector after first rotation: ";
1159 n->Output((ofstream *)&cout);
1160 cout << endl;
1161
1162 // rotate on z-y plane
1163 ptr = start;
1164 alpha = atan(-n->x[1]/n->x[2]);
1165 cout << Verbose(1) << "Z-Y-angle: " << alpha << " ... ";
1166 while (ptr->next != end) {
1167 ptr = ptr->next;
1168 tmp = ptr->x.x[1];
1169 ptr->x.x[1] = cos(alpha) * tmp + sin(alpha) * ptr->x.x[2];
1170 ptr->x.x[2] = -sin(alpha) * tmp + cos(alpha) * ptr->x.x[2];
1171 for (int j=0;j<MDSteps;j++) {
1172 tmp = Trajectories[ptr].R.at(j).x[1];
1173 Trajectories[ptr].R.at(j).x[1] = cos(alpha) * tmp + sin(alpha) * Trajectories[ptr].R.at(j).x[2];
1174 Trajectories[ptr].R.at(j).x[2] = -sin(alpha) * tmp + cos(alpha) * Trajectories[ptr].R.at(j).x[2];
1175 }
1176 }
1177 // rotate n vector (for consistency check)
1178 tmp = n->x[1];
1179 n->x[1] = cos(alpha) * tmp + sin(alpha) * n->x[2];
1180 n->x[2] = -sin(alpha) * tmp + cos(alpha) * n->x[2];
1181
1182 cout << Verbose(1) << "alignment vector after second rotation: ";
1183 n->Output((ofstream *)&cout);
1184 cout << Verbose(1) << endl;
1185 cout << Verbose(0) << "End of Aligning all atoms." << endl;
1186};
1187
1188/** Removes atom from molecule list.
1189 * \param *pointer atom to be removed
1190 * \return true - succeeded, false - atom not found in list
1191 */
1192bool molecule::RemoveAtom(atom *pointer)
1193{
1194 if (ElementsInMolecule[pointer->type->Z] != 0) // this would indicate an error
1195 ElementsInMolecule[pointer->type->Z]--; // decrease number of atom of this element
1196 else
1197 cerr << "ERROR: Atom " << pointer->Name << " is of element " << pointer->type->Z << " but the entry in the table of the molecule is 0!" << endl;
1198 if (ElementsInMolecule[pointer->type->Z] == 0) // was last atom of this element?
1199 ElementCount--;
1200 Trajectories.erase(pointer);
1201 return remove(pointer, start, end);
1202};
1203
1204/** Removes every atom from molecule list.
1205 * \return true - succeeded, false - atom not found in list
1206 */
1207bool molecule::CleanupMolecule()
1208{
1209 return (cleanup(start,end) && cleanup(first,last));
1210};
1211
1212/** Finds an atom specified by its continuous number.
1213 * \param Nr number of atom withim molecule
1214 * \return pointer to atom or NULL
1215 */
1216atom * molecule::FindAtom(int Nr) const{
1217 atom * walker = find(&Nr, start,end);
1218 if (walker != NULL) {
1219 //cout << Verbose(0) << "Found Atom Nr. " << walker->nr << endl;
1220 return walker;
1221 } else {
1222 cout << Verbose(0) << "Atom not found in list." << endl;
1223 return NULL;
1224 }
1225};
1226
1227/** Asks for atom number, and checks whether in list.
1228 * \param *text question before entering
1229 */
1230atom * molecule::AskAtom(string text)
1231{
1232 int No;
1233 atom *ion = NULL;
1234 do {
1235 //cout << Verbose(0) << "============Atom list==========================" << endl;
1236 //mol->Output((ofstream *)&cout);
1237 //cout << Verbose(0) << "===============================================" << endl;
1238 cout << Verbose(0) << text;
1239 cin >> No;
1240 ion = this->FindAtom(No);
1241 } while (ion == NULL);
1242 return ion;
1243};
1244
1245/** Checks if given coordinates are within cell volume.
1246 * \param *x array of coordinates
1247 * \return true - is within, false - out of cell
1248 */
1249bool molecule::CheckBounds(const Vector *x) const
1250{
1251 bool result = true;
1252 int j =-1;
1253 for (int i=0;i<NDIM;i++) {
1254 j += i+1;
1255 result = result && ((x->x[i] >= 0) && (x->x[i] < cell_size[j]));
1256 }
1257 //return result;
1258 return true; /// probably not gonna use the check no more
1259};
1260
1261/** Calculates sum over least square distance to line hidden in \a *x.
1262 * \param *x offset and direction vector
1263 * \param *params pointer to lsq_params structure
1264 * \return \f$ sum_i^N | y_i - (a + t_i b)|^2\f$
1265 */
1266double LeastSquareDistance (const gsl_vector * x, void * params)
1267{
1268 double res = 0, t;
1269 Vector a,b,c,d;
1270 struct lsq_params *par = (struct lsq_params *)params;
1271 atom *ptr = par->mol->start;
1272
1273 // initialize vectors
1274 a.x[0] = gsl_vector_get(x,0);
1275 a.x[1] = gsl_vector_get(x,1);
1276 a.x[2] = gsl_vector_get(x,2);
1277 b.x[0] = gsl_vector_get(x,3);
1278 b.x[1] = gsl_vector_get(x,4);
1279 b.x[2] = gsl_vector_get(x,5);
1280 // go through all atoms
1281 while (ptr != par->mol->end) {
1282 ptr = ptr->next;
1283 if (ptr->type == ((struct lsq_params *)params)->type) { // for specific type
1284 c.CopyVector(&ptr->x); // copy vector to temporary one
1285 c.SubtractVector(&a); // subtract offset vector
1286 t = c.ScalarProduct(&b); // get direction parameter
1287 d.CopyVector(&b); // and create vector
1288 d.Scale(&t);
1289 c.SubtractVector(&d); // ... yielding distance vector
1290 res += d.ScalarProduct((const Vector *)&d); // add squared distance
1291 }
1292 }
1293 return res;
1294};
1295
1296/** By minimizing the least square distance gains alignment vector.
1297 * \bug this is not yet working properly it seems
1298 */
1299void molecule::GetAlignvector(struct lsq_params * par) const
1300{
1301 int np = 6;
1302
1303 const gsl_multimin_fminimizer_type *T =
1304 gsl_multimin_fminimizer_nmsimplex;
1305 gsl_multimin_fminimizer *s = NULL;
1306 gsl_vector *ss;
1307 gsl_multimin_function minex_func;
1308
1309 size_t iter = 0, i;
1310 int status;
1311 double size;
1312
1313 /* Initial vertex size vector */
1314 ss = gsl_vector_alloc (np);
1315
1316 /* Set all step sizes to 1 */
1317 gsl_vector_set_all (ss, 1.0);
1318
1319 /* Starting point */
1320 par->x = gsl_vector_alloc (np);
1321 par->mol = this;
1322
1323 gsl_vector_set (par->x, 0, 0.0); // offset
1324 gsl_vector_set (par->x, 1, 0.0);
1325 gsl_vector_set (par->x, 2, 0.0);
1326 gsl_vector_set (par->x, 3, 0.0); // direction
1327 gsl_vector_set (par->x, 4, 0.0);
1328 gsl_vector_set (par->x, 5, 1.0);
1329
1330 /* Initialize method and iterate */
1331 minex_func.f = &LeastSquareDistance;
1332 minex_func.n = np;
1333 minex_func.params = (void *)par;
1334
1335 s = gsl_multimin_fminimizer_alloc (T, np);
1336 gsl_multimin_fminimizer_set (s, &minex_func, par->x, ss);
1337
1338 do
1339 {
1340 iter++;
1341 status = gsl_multimin_fminimizer_iterate(s);
1342
1343 if (status)
1344 break;
1345
1346 size = gsl_multimin_fminimizer_size (s);
1347 status = gsl_multimin_test_size (size, 1e-2);
1348
1349 if (status == GSL_SUCCESS)
1350 {
1351 printf ("converged to minimum at\n");
1352 }
1353
1354 printf ("%5d ", (int)iter);
1355 for (i = 0; i < (size_t)np; i++)
1356 {
1357 printf ("%10.3e ", gsl_vector_get (s->x, i));
1358 }
1359 printf ("f() = %7.3f size = %.3f\n", s->fval, size);
1360 }
1361 while (status == GSL_CONTINUE && iter < 100);
1362
1363 for (i=0;i<(size_t)np;i++)
1364 gsl_vector_set(par->x, i, gsl_vector_get(s->x, i));
1365 //gsl_vector_free(par->x);
1366 gsl_vector_free(ss);
1367 gsl_multimin_fminimizer_free (s);
1368};
1369
1370/** Prints molecule to *out.
1371 * \param *out output stream
1372 */
1373bool molecule::Output(ofstream *out)
1374{
1375 element *runner;
1376 atom *walker = NULL;
1377 int ElementNo, AtomNo;
1378 CountElements();
1379
1380 if (out == NULL) {
1381 return false;
1382 } else {
1383 *out << "#Ion_TypeNr._Nr.R[0] R[1] R[2] MoveType (0 MoveIon, 1 FixedIon)" << endl;
1384 ElementNo = 0;
1385 runner = elemente->start;
1386 while (runner->next != elemente->end) { // go through every element
1387 runner = runner->next;
1388 if (ElementsInMolecule[runner->Z]) { // if this element got atoms
1389 ElementNo++;
1390 AtomNo = 0;
1391 walker = start;
1392 while (walker->next != end) { // go through every atom of this element
1393 walker = walker->next;
1394 if (walker->type == runner) { // if this atom fits to element
1395 AtomNo++;
1396 walker->Output(ElementNo, AtomNo, out); // removed due to trajectories
1397 }
1398 }
1399 }
1400 }
1401 return true;
1402 }
1403};
1404
1405/** Prints molecule with all atomic trajectory positions to *out.
1406 * \param *out output stream
1407 */
1408bool molecule::OutputTrajectories(ofstream *out)
1409{
1410 element *runner = NULL;
1411 atom *walker = NULL;
1412 int ElementNo, AtomNo;
1413 CountElements();
1414
1415 if (out == NULL) {
1416 return false;
1417 } else {
1418 for (int step = 0; step < MDSteps; step++) {
1419 if (step == 0) {
1420 *out << "#Ion_TypeNr._Nr.R[0] R[1] R[2] MoveType (0 MoveIon, 1 FixedIon)" << endl;
1421 } else {
1422 *out << "# ====== MD step " << step << " =========" << endl;
1423 }
1424 ElementNo = 0;
1425 runner = elemente->start;
1426 while (runner->next != elemente->end) { // go through every element
1427 runner = runner->next;
1428 if (ElementsInMolecule[runner->Z]) { // if this element got atoms
1429 ElementNo++;
1430 AtomNo = 0;
1431 walker = start;
1432 while (walker->next != end) { // go through every atom of this element
1433 walker = walker->next;
1434 if (walker->type == runner) { // if this atom fits to element
1435 AtomNo++;
1436 *out << "Ion_Type" << ElementNo << "_" << AtomNo << "\t" << fixed << setprecision(9) << showpoint;
1437 *out << Trajectories[walker].R.at(step).x[0] << "\t" << Trajectories[walker].R.at(step).x[1] << "\t" << Trajectories[walker].R.at(step).x[2];
1438 *out << "\t" << walker->FixedIon;
1439 if (Trajectories[walker].U.at(step).Norm() > MYEPSILON)
1440 *out << "\t" << scientific << setprecision(6) << Trajectories[walker].U.at(step).x[0] << "\t" << Trajectories[walker].U.at(step).x[1] << "\t" << Trajectories[walker].U.at(step).x[2] << "\t";
1441 if (Trajectories[walker].F.at(step).Norm() > MYEPSILON)
1442 *out << "\t" << scientific << setprecision(6) << Trajectories[walker].F.at(step).x[0] << "\t" << Trajectories[walker].F.at(step).x[1] << "\t" << Trajectories[walker].F.at(step).x[2] << "\t";
1443 *out << "\t# Number in molecule " << walker->nr << endl;
1444 }
1445 }
1446 }
1447 }
1448 }
1449 return true;
1450 }
1451};
1452
1453/** Outputs contents of molecule::ListOfBondsPerAtom.
1454 * \param *out output stream
1455 */
1456void molecule::OutputListOfBonds(ofstream *out) const
1457{
1458 *out << Verbose(2) << endl << "From Contents of ListOfBondsPerAtom, all non-hydrogen atoms:" << endl;
1459 atom *Walker = start;
1460 while (Walker->next != end) {
1461 Walker = Walker->next;
1462#ifdef ADDHYDROGEN
1463 if (Walker->type->Z != 1) { // regard only non-hydrogen
1464#endif
1465 *out << Verbose(2) << "Atom " << Walker->Name << " has Bonds: "<<endl;
1466 for(int j=0;j<NumberOfBondsPerAtom[Walker->nr];j++) {
1467 *out << Verbose(3) << *(ListOfBondsPerAtom)[Walker->nr][j] << endl;
1468 }
1469#ifdef ADDHYDROGEN
1470 }
1471#endif
1472 }
1473 *out << endl;
1474};
1475
1476/** Output of element before the actual coordination list.
1477 * \param *out stream pointer
1478 */
1479bool molecule::Checkout(ofstream *out) const
1480{
1481 return elemente->Checkout(out, ElementsInMolecule);
1482};
1483
1484/** Prints molecule with all its trajectories to *out as xyz file.
1485 * \param *out output stream
1486 */
1487bool molecule::OutputTrajectoriesXYZ(ofstream *out)
1488{
1489 atom *walker = NULL;
1490 int No = 0;
1491 time_t now;
1492
1493 now = time((time_t *)NULL); // Get the system time and put it into 'now' as 'calender time'
1494 walker = start;
1495 while (walker->next != end) { // go through every atom and count
1496 walker = walker->next;
1497 No++;
1498 }
1499 if (out != NULL) {
1500 for (int step=0;step<MDSteps;step++) {
1501 *out << No << "\n\tCreated by molecuilder, step " << step << ", on " << ctime(&now);
1502 walker = start;
1503 while (walker->next != end) { // go through every atom of this element
1504 walker = walker->next;
1505 *out << walker->type->symbol << "\t" << Trajectories[walker].R.at(step).x[0] << "\t" << Trajectories[walker].R.at(step).x[1] << "\t" << Trajectories[walker].R.at(step).x[2] << endl;
1506 }
1507 }
1508 return true;
1509 } else
1510 return false;
1511};
1512
1513/** Prints molecule to *out as xyz file.
1514* \param *out output stream
1515 */
1516bool molecule::OutputXYZ(ofstream *out) const
1517{
1518 atom *walker = NULL;
1519 int No = 0;
1520 time_t now;
1521
1522 now = time((time_t *)NULL); // Get the system time and put it into 'now' as 'calender time'
1523 walker = start;
1524 while (walker->next != end) { // go through every atom and count
1525 walker = walker->next;
1526 No++;
1527 }
1528 if (out != NULL) {
1529 *out << No << "\n\tCreated by molecuilder on " << ctime(&now);
1530 walker = start;
1531 while (walker->next != end) { // go through every atom of this element
1532 walker = walker->next;
1533 walker->OutputXYZLine(out);
1534 }
1535 return true;
1536 } else
1537 return false;
1538};
1539
1540/** Brings molecule::AtomCount and atom::*Name up-to-date.
1541 * \param *out output stream for debugging
1542 */
1543void molecule::CountAtoms(ofstream *out)
1544{
1545 int i = 0;
1546 atom *Walker = start;
1547 while (Walker->next != end) {
1548 Walker = Walker->next;
1549 i++;
1550 }
1551 if ((AtomCount == 0) || (i != AtomCount)) {
1552 *out << Verbose(3) << "Mismatch in AtomCount " << AtomCount << " and recounted number " << i << ", renaming all." << endl;
1553 AtomCount = i;
1554
1555 // count NonHydrogen atoms and give each atom a unique name
1556 if (AtomCount != 0) {
1557 i=0;
1558 NoNonHydrogen = 0;
1559 Walker = start;
1560 while (Walker->next != end) {
1561 Walker = Walker->next;
1562 Walker->nr = i; // update number in molecule (for easier referencing in FragmentMolecule lateron)
1563 if (Walker->type->Z != 1) // count non-hydrogen atoms whilst at it
1564 NoNonHydrogen++;
1565 Free((void **)&Walker->Name, "molecule::CountAtoms: *walker->Name");
1566 Walker->Name = (char *) Malloc(sizeof(char)*6, "molecule::CountAtoms: *walker->Name");
1567 sprintf(Walker->Name, "%2s%02d", Walker->type->symbol, Walker->nr+1);
1568 *out << "Naming atom nr. " << Walker->nr << " " << Walker->Name << "." << endl;
1569 i++;
1570 }
1571 } else
1572 *out << Verbose(3) << "AtomCount is still " << AtomCount << ", thus counting nothing." << endl;
1573 }
1574};
1575
1576/** Brings molecule::ElementCount and molecule::ElementsInMolecule up-to-date.
1577 */
1578void molecule::CountElements()
1579{
1580 int i = 0;
1581 for(i=MAX_ELEMENTS;i--;)
1582 ElementsInMolecule[i] = 0;
1583 ElementCount = 0;
1584
1585 atom *walker = start;
1586 while (walker->next != end) {
1587 walker = walker->next;
1588 ElementsInMolecule[walker->type->Z]++;
1589 i++;
1590 }
1591 for(i=MAX_ELEMENTS;i--;)
1592 ElementCount += (ElementsInMolecule[i] != 0 ? 1 : 0);
1593};
1594
1595/** Counts all cyclic bonds and returns their number.
1596 * \note Hydrogen bonds can never by cyclic, thus no check for that
1597 * \param *out output stream for debugging
1598 * \return number opf cyclic bonds
1599 */
1600int molecule::CountCyclicBonds(ofstream *out)
1601{
1602 int No = 0;
1603 int *MinimumRingSize = NULL;
1604 MoleculeLeafClass *Subgraphs = NULL;
1605 bond *Binder = first;
1606 if ((Binder->next != last) && (Binder->next->Type == Undetermined)) {
1607 *out << Verbose(0) << "No Depth-First-Search analysis performed so far, calling ..." << endl;
1608 Subgraphs = DepthFirstSearchAnalysis(out, MinimumRingSize);
1609 while (Subgraphs->next != NULL) {
1610 Subgraphs = Subgraphs->next;
1611 delete(Subgraphs->previous);
1612 }
1613 delete(Subgraphs);
1614 delete[](MinimumRingSize);
1615 }
1616 while(Binder->next != last) {
1617 Binder = Binder->next;
1618 if (Binder->Cyclic)
1619 No++;
1620 }
1621 return No;
1622};
1623/** Returns Shading as a char string.
1624 * \param color the Shading
1625 * \return string of the flag
1626 */
1627string molecule::GetColor(enum Shading color)
1628{
1629 switch(color) {
1630 case white:
1631 return "white";
1632 break;
1633 case lightgray:
1634 return "lightgray";
1635 break;
1636 case darkgray:
1637 return "darkgray";
1638 break;
1639 case black:
1640 return "black";
1641 break;
1642 default:
1643 return "uncolored";
1644 break;
1645 };
1646};
1647
1648
1649/** Counts necessary number of valence electrons and returns number and SpinType.
1650 * \param configuration containing everything
1651 */
1652void molecule::CalculateOrbitals(class config &configuration)
1653{
1654 configuration.MaxPsiDouble = configuration.PsiMaxNoDown = configuration.PsiMaxNoUp = configuration.PsiType = 0;
1655 for(int i=MAX_ELEMENTS;i--;) {
1656 if (ElementsInMolecule[i] != 0) {
1657 //cout << "CalculateOrbitals: " << elemente->FindElement(i)->name << " has a valence of " << (int)elemente->FindElement(i)->Valence << " and there are " << ElementsInMolecule[i] << " of it." << endl;
1658 configuration.MaxPsiDouble += ElementsInMolecule[i]*((int)elemente->FindElement(i)->Valence);
1659 }
1660 }
1661 configuration.PsiMaxNoDown = configuration.MaxPsiDouble/2 + (configuration.MaxPsiDouble % 2);
1662 configuration.PsiMaxNoUp = configuration.MaxPsiDouble/2;
1663 configuration.MaxPsiDouble /= 2;
1664 configuration.PsiType = (configuration.PsiMaxNoDown == configuration.PsiMaxNoUp) ? 0 : 1;
1665 if ((configuration.PsiType == 1) && (configuration.ProcPEPsi < 2)) {
1666 configuration.ProcPEGamma /= 2;
1667 configuration.ProcPEPsi *= 2;
1668 } else {
1669 configuration.ProcPEGamma *= configuration.ProcPEPsi;
1670 configuration.ProcPEPsi = 1;
1671 }
1672 configuration.InitMaxMinStopStep = configuration.MaxMinStopStep = configuration.MaxPsiDouble;
1673};
1674
1675/** Creates an adjacency list of the molecule.
1676 * Generally, we use the CSD approach to bond recognition, that is the the distance
1677 * between two atoms A and B must be within [Rcov(A)+Rcov(B)-t,Rcov(A)+Rcov(B)+t] with
1678 * a threshold t = 0.4 Angstroem.
1679 * To make it O(N log N) the function uses the linked-cell technique as follows:
1680 * The procedure is step-wise:
1681 * -# Remove every bond in list
1682 * -# Count the atoms in the molecule with CountAtoms()
1683 * -# partition cell into smaller linked cells of size \a bonddistance
1684 * -# put each atom into its corresponding cell
1685 * -# go through every cell, check the atoms therein against all possible bond partners in the 27 adjacent cells, add bond if true
1686 * -# create the list of bonds via CreateListOfBondsPerAtom()
1687 * -# correct the bond degree iteratively (single->double->triple bond)
1688 * -# finally print the bond list to \a *out if desired
1689 * \param *out out stream for printing the matrix, NULL if no output
1690 * \param bonddistance length of linked cells (i.e. maximum minimal length checked)
1691 * \param IsAngstroem whether coordinate system is gauged to Angstroem or Bohr radii
1692 */
1693void molecule::CreateAdjacencyList(ofstream *out, double bonddistance, bool IsAngstroem)
1694{
1695 atom *Walker = NULL, *OtherWalker = NULL, *Candidate = NULL;
1696 int No, NoBonds, CandidateBondNo;
1697 int NumberCells, divisor[NDIM], n[NDIM], N[NDIM], index, Index, j;
1698 molecule **CellList;
1699 double distance, MinDistance, MaxDistance;
1700 double *matrix = ReturnFullMatrixforSymmetric(cell_size);
1701 Vector x;
1702
1703 BondDistance = bonddistance; // * ((IsAngstroem) ? 1. : 1./AtomicLengthToAngstroem);
1704 *out << Verbose(0) << "Begin of CreateAdjacencyList." << endl;
1705 // remove every bond from the list
1706 if ((first->next != last) && (last->previous != first)) { // there are bonds present
1707 cleanup(first,last);
1708 }
1709
1710 // count atoms in molecule = dimension of matrix (also give each unique name and continuous numbering)
1711 CountAtoms(out);
1712 *out << Verbose(1) << "AtomCount " << AtomCount << "." << endl;
1713
1714 if (AtomCount != 0) {
1715 // 1. find divisor for each axis, such that a sphere with radius of at least bonddistance can be placed into each cell
1716 j=-1;
1717 for (int i=0;i<NDIM;i++) {
1718 j += i+1;
1719 divisor[i] = (int)floor(cell_size[j]/bonddistance); // take smaller value such that size of linked cell is at least bonddistance
1720 *out << Verbose(1) << "divisor[" << i << "] = " << divisor[i] << "." << endl;
1721 }
1722 // 2a. allocate memory for the cell list
1723 NumberCells = divisor[0]*divisor[1]*divisor[2];
1724 *out << Verbose(1) << "Allocating " << NumberCells << " cells." << endl;
1725 CellList = (molecule **) Malloc(sizeof(molecule *)*NumberCells, "molecule::CreateAdjacencyList - ** CellList");
1726 for (int i=NumberCells;i--;)
1727 CellList[i] = NULL;
1728
1729 // 2b. put all atoms into its corresponding list
1730 Walker = start;
1731 while(Walker->next != end) {
1732 Walker = Walker->next;
1733 //*out << Verbose(1) << "Current atom is " << *Walker << " with coordinates ";
1734 //Walker->x.Output(out);
1735 //*out << "." << endl;
1736 // compute the cell by the atom's coordinates
1737 j=-1;
1738 for (int i=0;i<NDIM;i++) {
1739 j += i+1;
1740 x.CopyVector(&(Walker->x));
1741 x.KeepPeriodic(out, matrix);
1742 n[i] = (int)floor(x.x[i]/cell_size[j]*(double)divisor[i]);
1743 }
1744 index = n[2] + (n[1] + n[0] * divisor[1]) * divisor[2];
1745 *out << Verbose(1) << "Atom " << *Walker << " goes into cell number [" << n[0] << "," << n[1] << "," << n[2] << "] = " << index << "." << endl;
1746 // add copy atom to this cell
1747 if (CellList[index] == NULL) // allocate molecule if not done
1748 CellList[index] = new molecule(elemente);
1749 OtherWalker = CellList[index]->AddCopyAtom(Walker); // add a copy of walker to this atom, father will be walker for later reference
1750 //*out << Verbose(1) << "Copy Atom is " << *OtherWalker << "." << endl;
1751 }
1752 //for (int i=0;i<NumberCells;i++)
1753 //*out << Verbose(1) << "Cell number " << i << ": " << CellList[i] << "." << endl;
1754
1755 // 3a. go through every cell
1756 for (N[0]=divisor[0];N[0]--;)
1757 for (N[1]=divisor[1];N[1]--;)
1758 for (N[2]=divisor[2];N[2]--;) {
1759 Index = N[2] + (N[1] + N[0] * divisor[1]) * divisor[2];
1760 if (CellList[Index] != NULL) { // if there atoms in this cell
1761 //*out << Verbose(1) << "Current cell is " << Index << "." << endl;
1762 // 3b. for every atom therein
1763 Walker = CellList[Index]->start;
1764 while (Walker->next != CellList[Index]->end) { // go through every atom
1765 Walker = Walker->next;
1766 //*out << Verbose(0) << "Current Atom is " << *Walker << "." << endl;
1767 // 3c. check for possible bond between each atom in this and every one in the 27 cells
1768 for (n[0]=-1;n[0]<=1;n[0]++)
1769 for (n[1]=-1;n[1]<=1;n[1]++)
1770 for (n[2]=-1;n[2]<=1;n[2]++) {
1771 // compute the index of this comparison cell and make it periodic
1772 index = ((N[2]+n[2]+divisor[2])%divisor[2]) + (((N[1]+n[1]+divisor[1])%divisor[1]) + ((N[0]+n[0]+divisor[0])%divisor[0]) * divisor[1]) * divisor[2];
1773 //*out << Verbose(1) << "Number of comparison cell is " << index << "." << endl;
1774 if (CellList[index] != NULL) { // if there are any atoms in this cell
1775 OtherWalker = CellList[index]->start;
1776 while(OtherWalker->next != CellList[index]->end) { // go through every atom in this cell
1777 OtherWalker = OtherWalker->next;
1778 //*out << Verbose(0) << "Current comparison atom is " << *OtherWalker << "." << endl;
1779 /// \todo periodic check is missing here!
1780 //*out << Verbose(1) << "Checking distance " << OtherWalker->x.PeriodicDistance(&(Walker->x), cell_size) << " against typical bond length of " << bonddistance*bonddistance << "." << endl;
1781 MinDistance = OtherWalker->type->CovalentRadius + Walker->type->CovalentRadius;
1782 MinDistance *= (IsAngstroem) ? 1. : 1./AtomicLengthToAngstroem;
1783 MaxDistance = MinDistance + BONDTHRESHOLD;
1784 MinDistance -= BONDTHRESHOLD;
1785 distance = OtherWalker->x.PeriodicDistance(&(Walker->x), cell_size);
1786 if ((OtherWalker->father->nr > Walker->father->nr) && (distance <= MaxDistance*MaxDistance) && (distance >= MinDistance*MinDistance)) { // create bond if distance is smaller
1787 *out << Verbose(0) << "Adding Bond between " << *Walker << " and " << *OtherWalker << "." << endl;
1788 AddBond(Walker->father, OtherWalker->father, 1); // also increases molecule::BondCount
1789 BondCount++;
1790 } else {
1791 //*out << Verbose(1) << "Not Adding: Wrong label order or distance too great." << endl;
1792 }
1793 }
1794 }
1795 }
1796 }
1797 }
1798 }
1799 // 4. free the cell again
1800 for (int i=NumberCells;i--;)
1801 if (CellList[i] != NULL) {
1802 delete(CellList[i]);
1803 }
1804 Free((void **)&CellList, "molecule::CreateAdjacencyList - ** CellList");
1805
1806 // create the adjacency list per atom
1807 CreateListOfBondsPerAtom(out);
1808
1809 // correct Bond degree of each bond by checking both bond partners for a mismatch between valence and current sum of bond degrees,
1810 // iteratively increase the one first where the other bond partner has the fewest number of bonds (i.e. in general bonds oxygene
1811 // preferred over carbon bonds). Beforehand, we had picked the first mismatching partner, which lead to oxygenes with single instead of
1812 // double bonds as was expected.
1813 if (BondCount != 0) {
1814 NoCyclicBonds = 0;
1815 *out << Verbose(1) << "Correcting Bond degree of each bond ... ";
1816 do {
1817 No = 0; // No acts as breakup flag (if 1 we still continue)
1818 Walker = start;
1819 while (Walker->next != end) { // go through every atom
1820 Walker = Walker->next;
1821 // count valence of first partner
1822 NoBonds = 0;
1823 for(j=0;j<NumberOfBondsPerAtom[Walker->nr];j++)
1824 NoBonds += ListOfBondsPerAtom[Walker->nr][j]->BondDegree;
1825 *out << Verbose(3) << "Walker " << *Walker << ": " << (int)Walker->type->NoValenceOrbitals << " > " << NoBonds << "?" << endl;
1826 if ((int)(Walker->type->NoValenceOrbitals) > NoBonds) { // we have a mismatch, check all bonding partners for mismatch
1827 Candidate = NULL;
1828 for(int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++) { // go through each of its bond partners
1829 OtherWalker = ListOfBondsPerAtom[Walker->nr][i]->GetOtherAtom(Walker);
1830 // count valence of second partner
1831 NoBonds = 0;
1832 for(j=0;j<NumberOfBondsPerAtom[OtherWalker->nr];j++)
1833 NoBonds += ListOfBondsPerAtom[OtherWalker->nr][j]->BondDegree;
1834 *out << Verbose(3) << "OtherWalker " << *OtherWalker << ": " << (int)OtherWalker->type->NoValenceOrbitals << " > " << NoBonds << "?" << endl;
1835 if ((int)(OtherWalker->type->NoValenceOrbitals) > NoBonds) { // check if possible candidate
1836 if ((Candidate == NULL) || (NumberOfBondsPerAtom[Candidate->nr] > NumberOfBondsPerAtom[OtherWalker->nr])) { // pick the one with fewer number of bonds first
1837 Candidate = OtherWalker;
1838 CandidateBondNo = i;
1839 *out << Verbose(3) << "New candidate is " << *Candidate << "." << endl;
1840 }
1841 }
1842 }
1843 if (Candidate != NULL) {
1844 ListOfBondsPerAtom[Walker->nr][CandidateBondNo]->BondDegree++;
1845 *out << Verbose(2) << "Increased bond degree for bond " << *ListOfBondsPerAtom[Walker->nr][CandidateBondNo] << "." << endl;
1846 }
1847 }
1848 }
1849 } while (No);
1850 *out << " done." << endl;
1851 } else
1852 *out << Verbose(1) << "BondCount is " << BondCount << ", no bonds between any of the " << AtomCount << " atoms." << endl;
1853 *out << Verbose(1) << "I detected " << BondCount << " bonds in the molecule with distance " << bonddistance << "." << endl;
1854
1855 // output bonds for debugging (if bond chain list was correctly installed)
1856 *out << Verbose(1) << endl << "From contents of bond chain list:";
1857 bond *Binder = first;
1858 while(Binder->next != last) {
1859 Binder = Binder->next;
1860 *out << *Binder << "\t" << endl;
1861 }
1862 *out << endl;
1863 } else
1864 *out << Verbose(1) << "AtomCount is " << AtomCount << ", thus no bonds, no connections!." << endl;
1865 *out << Verbose(0) << "End of CreateAdjacencyList." << endl;
1866 Free((void **)&matrix, "molecule::CreateAdjacencyList: *matrix");
1867};
1868
1869/** Performs a Depth-First search on this molecule.
1870 * Marks bonds in molecule as cyclic, bridge, ... and atoms as
1871 * articulations points, ...
1872 * We use the algorithm from [Even, Graph Algorithms, p.62].
1873 * \param *out output stream for debugging
1874 * \param *&MinimumRingSize contains smallest ring size in molecular structure on return or -1 if no rings were found
1875 * \return list of each disconnected subgraph as an individual molecule class structure
1876 */
1877MoleculeLeafClass * molecule::DepthFirstSearchAnalysis(ofstream *out, int *&MinimumRingSize)
1878{
1879 class StackClass<atom *> *AtomStack;
1880 AtomStack = new StackClass<atom *>(AtomCount);
1881 class StackClass<bond *> *BackEdgeStack = new StackClass<bond *> (BondCount);
1882 MoleculeLeafClass *SubGraphs = new MoleculeLeafClass(NULL);
1883 MoleculeLeafClass *LeafWalker = SubGraphs;
1884 int CurrentGraphNr = 0, OldGraphNr;
1885 int ComponentNumber = 0;
1886 atom *Walker = NULL, *OtherAtom = NULL, *Root = start->next;
1887 bond *Binder = NULL;
1888 bool BackStepping = false;
1889
1890 *out << Verbose(0) << "Begin of DepthFirstSearchAnalysis" << endl;
1891
1892 ResetAllBondsToUnused();
1893 ResetAllAtomNumbers();
1894 InitComponentNumbers();
1895 BackEdgeStack->ClearStack();
1896 while (Root != end) { // if there any atoms at all
1897 // (1) mark all edges unused, empty stack, set atom->GraphNr = 0 for all
1898 AtomStack->ClearStack();
1899
1900 // put into new subgraph molecule and add this to list of subgraphs
1901 LeafWalker = new MoleculeLeafClass(LeafWalker);
1902 LeafWalker->Leaf = new molecule(elemente);
1903 LeafWalker->Leaf->AddCopyAtom(Root);
1904
1905 OldGraphNr = CurrentGraphNr;
1906 Walker = Root;
1907 do { // (10)
1908 do { // (2) set number and Lowpoint of Atom to i, increase i, push current atom
1909 if (!BackStepping) { // if we don't just return from (8)
1910 Walker->GraphNr = CurrentGraphNr;
1911 Walker->LowpointNr = CurrentGraphNr;
1912 *out << Verbose(1) << "Setting Walker[" << Walker->Name << "]'s number to " << Walker->GraphNr << " with Lowpoint " << Walker->LowpointNr << "." << endl;
1913 AtomStack->Push(Walker);
1914 CurrentGraphNr++;
1915 }
1916 do { // (3) if Walker has no unused egdes, go to (5)
1917 BackStepping = false; // reset backstepping flag for (8)
1918 if (Binder == NULL) // if we don't just return from (11), Binder is already set to next unused
1919 Binder = FindNextUnused(Walker);
1920 if (Binder == NULL)
1921 break;
1922 *out << Verbose(2) << "Current Unused Bond is " << *Binder << "." << endl;
1923 // (4) Mark Binder used, ...
1924 Binder->MarkUsed(black);
1925 OtherAtom = Binder->GetOtherAtom(Walker);
1926 *out << Verbose(2) << "(4) OtherAtom is " << OtherAtom->Name << "." << endl;
1927 if (OtherAtom->GraphNr != -1) {
1928 // (4a) ... if "other" atom has been visited (GraphNr != 0), set lowpoint to minimum of both, go to (3)
1929 Binder->Type = BackEdge;
1930 BackEdgeStack->Push(Binder);
1931 Walker->LowpointNr = ( Walker->LowpointNr < OtherAtom->GraphNr ) ? Walker->LowpointNr : OtherAtom->GraphNr;
1932 *out << Verbose(3) << "(4a) Visited: Setting Lowpoint of Walker[" << Walker->Name << "] to " << Walker->LowpointNr << "." << endl;
1933 } else {
1934 // (4b) ... otherwise set OtherAtom as Ancestor of Walker and Walker as OtherAtom, go to (2)
1935 Binder->Type = TreeEdge;
1936 OtherAtom->Ancestor = Walker;
1937 Walker = OtherAtom;
1938 *out << Verbose(3) << "(4b) Not Visited: OtherAtom[" << OtherAtom->Name << "]'s Ancestor is now " << OtherAtom->Ancestor->Name << ", Walker is OtherAtom " << OtherAtom->Name << "." << endl;
1939 break;
1940 }
1941 Binder = NULL;
1942 } while (1); // (3)
1943 if (Binder == NULL) {
1944 *out << Verbose(2) << "No more Unused Bonds." << endl;
1945 break;
1946 } else
1947 Binder = NULL;
1948 } while (1); // (2)
1949
1950 // if we came from backstepping, yet there were no more unused bonds, we end up here with no Ancestor, because Walker is Root! Then we are finished!
1951 if ((Walker == Root) && (Binder == NULL))
1952 break;
1953
1954 // (5) if Ancestor of Walker is ...
1955 *out << Verbose(1) << "(5) Number of Walker[" << Walker->Name << "]'s Ancestor[" << Walker->Ancestor->Name << "] is " << Walker->Ancestor->GraphNr << "." << endl;
1956 if (Walker->Ancestor->GraphNr != Root->GraphNr) {
1957 // (6) (Ancestor of Walker is not Root)
1958 if (Walker->LowpointNr < Walker->Ancestor->GraphNr) {
1959 // (6a) set Ancestor's Lowpoint number to minimum of of its Ancestor and itself, go to Step(8)
1960 Walker->Ancestor->LowpointNr = (Walker->Ancestor->LowpointNr < Walker->LowpointNr) ? Walker->Ancestor->LowpointNr : Walker->LowpointNr;
1961 *out << Verbose(2) << "(6) Setting Walker[" << Walker->Name << "]'s Ancestor[" << Walker->Ancestor->Name << "]'s Lowpoint to " << Walker->Ancestor->LowpointNr << "." << endl;
1962 } else {
1963 // (7) (Ancestor of Walker is a separating vertex, remove all from stack till Walker (including), these and Ancestor form a component
1964 Walker->Ancestor->SeparationVertex = true;
1965 *out << Verbose(2) << "(7) Walker[" << Walker->Name << "]'s Ancestor[" << Walker->Ancestor->Name << "]'s is a separating vertex, creating component." << endl;
1966 SetNextComponentNumber(Walker->Ancestor, ComponentNumber);
1967 *out << Verbose(3) << "(7) Walker[" << Walker->Name << "]'s Ancestor's Compont is " << ComponentNumber << "." << endl;
1968 SetNextComponentNumber(Walker, ComponentNumber);
1969 *out << Verbose(3) << "(7) Walker[" << Walker->Name << "]'s Compont is " << ComponentNumber << "." << endl;
1970 do {
1971 OtherAtom = AtomStack->PopLast();
1972 LeafWalker->Leaf->AddCopyAtom(OtherAtom);
1973 SetNextComponentNumber(OtherAtom, ComponentNumber);
1974 *out << Verbose(3) << "(7) Other[" << OtherAtom->Name << "]'s Compont is " << ComponentNumber << "." << endl;
1975 } while (OtherAtom != Walker);
1976 ComponentNumber++;
1977 }
1978 // (8) Walker becomes its Ancestor, go to (3)
1979 *out << Verbose(2) << "(8) Walker[" << Walker->Name << "] is now its Ancestor " << Walker->Ancestor->Name << ", backstepping. " << endl;
1980 Walker = Walker->Ancestor;
1981 BackStepping = true;
1982 }
1983 if (!BackStepping) { // coming from (8) want to go to (3)
1984 // (9) remove all from stack till Walker (including), these and Root form a component
1985 AtomStack->Output(out);
1986 SetNextComponentNumber(Root, ComponentNumber);
1987 *out << Verbose(3) << "(9) Root[" << Root->Name << "]'s Component is " << ComponentNumber << "." << endl;
1988 SetNextComponentNumber(Walker, ComponentNumber);
1989 *out << Verbose(3) << "(9) Walker[" << Walker->Name << "]'s Component is " << ComponentNumber << "." << endl;
1990 do {
1991 OtherAtom = AtomStack->PopLast();
1992 LeafWalker->Leaf->AddCopyAtom(OtherAtom);
1993 SetNextComponentNumber(OtherAtom, ComponentNumber);
1994 *out << Verbose(3) << "(7) Other[" << OtherAtom->Name << "]'s Compont is " << ComponentNumber << "." << endl;
1995 } while (OtherAtom != Walker);
1996 ComponentNumber++;
1997
1998 // (11) Root is separation vertex, set Walker to Root and go to (4)
1999 Walker = Root;
2000 Binder = FindNextUnused(Walker);
2001 *out << Verbose(1) << "(10) Walker is Root[" << Root->Name << "], next Unused Bond is " << Binder << "." << endl;
2002 if (Binder != NULL) { // Root is separation vertex
2003 *out << Verbose(1) << "(11) Root is a separation vertex." << endl;
2004 Walker->SeparationVertex = true;
2005 }
2006 }
2007 } while ((BackStepping) || (Binder != NULL)); // (10) halt only if Root has no unused edges
2008
2009 // From OldGraphNr to CurrentGraphNr ranges an disconnected subgraph
2010 *out << Verbose(0) << "Disconnected subgraph ranges from " << OldGraphNr << " to " << CurrentGraphNr << "." << endl;
2011 LeafWalker->Leaf->Output(out);
2012 *out << endl;
2013
2014 // step on to next root
2015 while ((Root != end) && (Root->GraphNr != -1)) {
2016 //*out << Verbose(1) << "Current next subgraph root candidate is " << Root->Name << "." << endl;
2017 if (Root->GraphNr != -1) // if already discovered, step on
2018 Root = Root->next;
2019 }
2020 }
2021 // set cyclic bond criterium on "same LP" basis
2022 Binder = first;
2023 while(Binder->next != last) {
2024 Binder = Binder->next;
2025 if (Binder->rightatom->LowpointNr == Binder->leftatom->LowpointNr) { // cyclic ??
2026 Binder->Cyclic = true;
2027 NoCyclicBonds++;
2028 }
2029 }
2030
2031 // analysis of the cycles (print rings, get minimum cycle length)
2032 CyclicStructureAnalysis(out, BackEdgeStack, MinimumRingSize);
2033
2034 *out << Verbose(1) << "Final graph info for each atom is:" << endl;
2035 Walker = start;
2036 while (Walker->next != end) {
2037 Walker = Walker->next;
2038 *out << Verbose(2) << "Atom " << Walker->Name << " is " << ((Walker->SeparationVertex) ? "a" : "not a") << " separation vertex, components are ";
2039 OutputComponentNumber(out, Walker);
2040 *out << " with Lowpoint " << Walker->LowpointNr << " and Graph Nr. " << Walker->GraphNr << "." << endl;
2041 }
2042
2043 *out << Verbose(1) << "Final graph info for each bond is:" << endl;
2044 Binder = first;
2045 while(Binder->next != last) {
2046 Binder = Binder->next;
2047 *out << Verbose(2) << ((Binder->Type == TreeEdge) ? "TreeEdge " : "BackEdge ") << *Binder << ": <";
2048 *out << ((Binder->leftatom->SeparationVertex) ? "SP," : "") << "L" << Binder->leftatom->LowpointNr << " G" << Binder->leftatom->GraphNr << " Comp.";
2049 OutputComponentNumber(out, Binder->leftatom);
2050 *out << " === ";
2051 *out << ((Binder->rightatom->SeparationVertex) ? "SP," : "") << "L" << Binder->rightatom->LowpointNr << " G" << Binder->rightatom->GraphNr << " Comp.";
2052 OutputComponentNumber(out, Binder->rightatom);
2053 *out << ">." << endl;
2054 if (Binder->Cyclic) // cyclic ??
2055 *out << Verbose(3) << "Lowpoint at each side are equal: CYCLIC!" << endl;
2056 }
2057
2058 // free all and exit
2059 delete(AtomStack);
2060 *out << Verbose(0) << "End of DepthFirstSearchAnalysis" << endl;
2061 return SubGraphs;
2062};
2063
2064/** Analyses the cycles found and returns minimum of all cycle lengths.
2065 * We begin with a list of Back edges found during DepthFirstSearchAnalysis(). We go through this list - one end is the Root,
2066 * the other our initial Walker - and do a Breadth First Search for the Root. We mark down each Predecessor and as soon as
2067 * we have found the Root via BFS, we may climb back the closed cycle via the Predecessors. Thereby we mark atoms and bonds
2068 * as cyclic and print out the cycles.
2069 * \param *out output stream for debugging
2070 * \param *BackEdgeStack stack with all back edges found during DFS scan
2071 * \param *&MinimumRingSize contains smallest ring size in molecular structure on return or -1 if no rings were found, if set is maximum search distance
2072 * \todo BFS from the not-same-LP to find back to starting point of tributary cycle over more than one bond
2073 */
2074void molecule::CyclicStructureAnalysis(ofstream *out, class StackClass<bond *> * BackEdgeStack, int *&MinimumRingSize)
2075{
2076 atom **PredecessorList = (atom **) Malloc(sizeof(atom *)*AtomCount, "molecule::CyclicStructureAnalysis: **PredecessorList");
2077 int *ShortestPathList = (int *) Malloc(sizeof(int)*AtomCount, "molecule::CyclicStructureAnalysis: *ShortestPathList");
2078 enum Shading *ColorList = (enum Shading *) Malloc(sizeof(enum Shading)*AtomCount, "molecule::CyclicStructureAnalysis: *ColorList");
2079 class StackClass<atom *> *BFSStack = new StackClass<atom *> (AtomCount); // will hold the current ring
2080 class StackClass<atom *> *TouchedStack = new StackClass<atom *> (AtomCount); // contains all "touched" atoms (that need to be reset after BFS loop)
2081 atom *Walker = NULL, *OtherAtom = NULL, *Root = NULL;
2082 bond *Binder = NULL, *BackEdge = NULL;
2083 int RingSize, NumCycles, MinRingSize = -1;
2084
2085 // initialise each vertex as white with no predecessor, empty queue, color Root lightgray
2086 for (int i=AtomCount;i--;) {
2087 PredecessorList[i] = NULL;
2088 ShortestPathList[i] = -1;
2089 ColorList[i] = white;
2090 }
2091 MinimumRingSize = new int[AtomCount];
2092 for(int i=AtomCount;i--;)
2093 MinimumRingSize[i] = AtomCount;
2094
2095
2096 *out << Verbose(1) << "Back edge list - ";
2097 BackEdgeStack->Output(out);
2098
2099 *out << Verbose(1) << "Analysing cycles ... " << endl;
2100 NumCycles = 0;
2101 while (!BackEdgeStack->IsEmpty()) {
2102 BackEdge = BackEdgeStack->PopFirst();
2103 // this is the target
2104 Root = BackEdge->leftatom;
2105 // this is the source point
2106 Walker = BackEdge->rightatom;
2107 ShortestPathList[Walker->nr] = 0;
2108 BFSStack->ClearStack(); // start with empty BFS stack
2109 BFSStack->Push(Walker);
2110 TouchedStack->Push(Walker);
2111 *out << Verbose(1) << "---------------------------------------------------------------------------------------------------------" << endl;
2112 OtherAtom = NULL;
2113 do { // look for Root
2114 Walker = BFSStack->PopFirst();
2115 *out << Verbose(2) << "Current Walker is " << *Walker << ", we look for SP to Root " << *Root << "." << endl;
2116 for(int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++) {
2117 Binder = ListOfBondsPerAtom[Walker->nr][i];
2118 if (Binder != BackEdge) { // only walk along DFS spanning tree (otherwise we always find SP of one being backedge Binder)
2119 OtherAtom = Binder->GetOtherAtom(Walker);
2120#ifdef ADDHYDROGEN
2121 if (OtherAtom->type->Z != 1) {
2122#endif
2123 *out << Verbose(2) << "Current OtherAtom is: " << OtherAtom->Name << " for bond " << *Binder << "." << endl;
2124 if (ColorList[OtherAtom->nr] == white) {
2125 TouchedStack->Push(OtherAtom);
2126 ColorList[OtherAtom->nr] = lightgray;
2127 PredecessorList[OtherAtom->nr] = Walker; // Walker is the predecessor
2128 ShortestPathList[OtherAtom->nr] = ShortestPathList[Walker->nr]+1;
2129 *out << Verbose(2) << "Coloring OtherAtom " << OtherAtom->Name << " lightgray, its predecessor is " << Walker->Name << " and its Shortest Path is " << ShortestPathList[OtherAtom->nr] << " egde(s) long." << endl;
2130 //if (ShortestPathList[OtherAtom->nr] < MinimumRingSize[Walker->GetTrueFather()->nr]) { // Check for maximum distance
2131 *out << Verbose(3) << "Putting OtherAtom into queue." << endl;
2132 BFSStack->Push(OtherAtom);
2133 //}
2134 } else {
2135 *out << Verbose(3) << "Not Adding, has already been visited." << endl;
2136 }
2137 if (OtherAtom == Root)
2138 break;
2139#ifdef ADDHYDROGEN
2140 } else {
2141 *out << Verbose(2) << "Skipping hydrogen atom " << *OtherAtom << "." << endl;
2142 ColorList[OtherAtom->nr] = black;
2143 }
2144#endif
2145 } else {
2146 *out << Verbose(2) << "Bond " << *Binder << " not Visiting, is the back edge." << endl;
2147 }
2148 }
2149 ColorList[Walker->nr] = black;
2150 *out << Verbose(1) << "Coloring Walker " << Walker->Name << " black." << endl;
2151 if (OtherAtom == Root) { // if we have found the root, check whether this cycle wasn't already found beforehand
2152 // step through predecessor list
2153 while (OtherAtom != BackEdge->rightatom) {
2154 if (!OtherAtom->GetTrueFather()->IsCyclic) // if one bond in the loop is not marked as cyclic, we haven't found this cycle yet
2155 break;
2156 else
2157 OtherAtom = PredecessorList[OtherAtom->nr];
2158 }
2159 if (OtherAtom == BackEdge->rightatom) { // if each atom in found cycle is cyclic, loop's been found before already
2160 *out << Verbose(3) << "This cycle was already found before, skipping and removing seeker from search." << endl;\
2161 do {
2162 OtherAtom = TouchedStack->PopLast();
2163 if (PredecessorList[OtherAtom->nr] == Walker) {
2164 *out << Verbose(4) << "Removing " << *OtherAtom << " from lists and stacks." << endl;
2165 PredecessorList[OtherAtom->nr] = NULL;
2166 ShortestPathList[OtherAtom->nr] = -1;
2167 ColorList[OtherAtom->nr] = white;
2168 BFSStack->RemoveItem(OtherAtom);
2169 }
2170 } while ((!TouchedStack->IsEmpty()) && (PredecessorList[OtherAtom->nr] == NULL));
2171 TouchedStack->Push(OtherAtom); // last was wrongly popped
2172 OtherAtom = BackEdge->rightatom; // set to not Root
2173 } else
2174 OtherAtom = Root;
2175 }
2176 } while ((!BFSStack->IsEmpty()) && (OtherAtom != Root) && (OtherAtom != NULL)); // || (ShortestPathList[OtherAtom->nr] < MinimumRingSize[Walker->GetTrueFather()->nr])));
2177
2178 if (OtherAtom == Root) {
2179 // now climb back the predecessor list and thus find the cycle members
2180 NumCycles++;
2181 RingSize = 1;
2182 Root->GetTrueFather()->IsCyclic = true;
2183 *out << Verbose(1) << "Found ring contains: ";
2184 Walker = Root;
2185 while (Walker != BackEdge->rightatom) {
2186 *out << Walker->Name << " <-> ";
2187 Walker = PredecessorList[Walker->nr];
2188 Walker->GetTrueFather()->IsCyclic = true;
2189 RingSize++;
2190 }
2191 *out << Walker->Name << " with a length of " << RingSize << "." << endl << endl;
2192 // walk through all and set MinimumRingSize
2193 Walker = Root;
2194 MinimumRingSize[Walker->GetTrueFather()->nr] = RingSize;
2195 while (Walker != BackEdge->rightatom) {
2196 Walker = PredecessorList[Walker->nr];
2197 if (RingSize < MinimumRingSize[Walker->GetTrueFather()->nr])
2198 MinimumRingSize[Walker->GetTrueFather()->nr] = RingSize;
2199 }
2200 if ((RingSize < MinRingSize) || (MinRingSize == -1))
2201 MinRingSize = RingSize;
2202 } else {
2203 *out << Verbose(1) << "No ring containing " << *Root << " with length equal to or smaller than " << MinimumRingSize[Walker->GetTrueFather()->nr] << " found." << endl;
2204 }
2205
2206 // now clean the lists
2207 while (!TouchedStack->IsEmpty()){
2208 Walker = TouchedStack->PopFirst();
2209 PredecessorList[Walker->nr] = NULL;
2210 ShortestPathList[Walker->nr] = -1;
2211 ColorList[Walker->nr] = white;
2212 }
2213 }
2214 if (MinRingSize != -1) {
2215 // go over all atoms
2216 Root = start;
2217 while(Root->next != end) {
2218 Root = Root->next;
2219
2220 if (MinimumRingSize[Root->GetTrueFather()->nr] == AtomCount) { // check whether MinimumRingSize is set, if not BFS to next where it is
2221 Walker = Root;
2222 ShortestPathList[Walker->nr] = 0;
2223 BFSStack->ClearStack(); // start with empty BFS stack
2224 BFSStack->Push(Walker);
2225 TouchedStack->Push(Walker);
2226 //*out << Verbose(1) << "---------------------------------------------------------------------------------------------------------" << endl;
2227 OtherAtom = Walker;
2228 while (OtherAtom != NULL) { // look for Root
2229 Walker = BFSStack->PopFirst();
2230 //*out << Verbose(2) << "Current Walker is " << *Walker << ", we look for SP to Root " << *Root << "." << endl;
2231 for(int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++) {
2232 Binder = ListOfBondsPerAtom[Walker->nr][i];
2233 if ((Binder != BackEdge) || (NumberOfBondsPerAtom[Walker->nr] == 1)) { // only walk along DFS spanning tree (otherwise we always find SP of 1 being backedge Binder), but terminal hydrogens may be connected via backedge, hence extra check
2234 OtherAtom = Binder->GetOtherAtom(Walker);
2235 //*out << Verbose(2) << "Current OtherAtom is: " << OtherAtom->Name << " for bond " << *Binder << "." << endl;
2236 if (ColorList[OtherAtom->nr] == white) {
2237 TouchedStack->Push(OtherAtom);
2238 ColorList[OtherAtom->nr] = lightgray;
2239 PredecessorList[OtherAtom->nr] = Walker; // Walker is the predecessor
2240 ShortestPathList[OtherAtom->nr] = ShortestPathList[Walker->nr]+1;
2241 //*out << Verbose(2) << "Coloring OtherAtom " << OtherAtom->Name << " lightgray, its predecessor is " << Walker->Name << " and its Shortest Path is " << ShortestPathList[OtherAtom->nr] << " egde(s) long." << endl;
2242 if (OtherAtom->GetTrueFather()->IsCyclic) { // if the other atom is connected to a ring
2243 MinimumRingSize[Root->GetTrueFather()->nr] = ShortestPathList[OtherAtom->nr]+MinimumRingSize[OtherAtom->GetTrueFather()->nr];
2244 OtherAtom = NULL; //break;
2245 break;
2246 } else
2247 BFSStack->Push(OtherAtom);
2248 } else {
2249 //*out << Verbose(3) << "Not Adding, has already been visited." << endl;
2250 }
2251 } else {
2252 //*out << Verbose(3) << "Not Visiting, is a back edge." << endl;
2253 }
2254 }
2255 ColorList[Walker->nr] = black;
2256 //*out << Verbose(1) << "Coloring Walker " << Walker->Name << " black." << endl;
2257 }
2258
2259 // now clean the lists
2260 while (!TouchedStack->IsEmpty()){
2261 Walker = TouchedStack->PopFirst();
2262 PredecessorList[Walker->nr] = NULL;
2263 ShortestPathList[Walker->nr] = -1;
2264 ColorList[Walker->nr] = white;
2265 }
2266 }
2267 *out << Verbose(1) << "Minimum ring size of " << *Root << " is " << MinimumRingSize[Root->GetTrueFather()->nr] << "." << endl;
2268 }
2269 *out << Verbose(1) << "Minimum ring size is " << MinRingSize << ", over " << NumCycles << " cycles total." << endl;
2270 } else
2271 *out << Verbose(1) << "No rings were detected in the molecular structure." << endl;
2272
2273 Free((void **)&PredecessorList, "molecule::CyclicStructureAnalysis: **PredecessorList");
2274 Free((void **)&ShortestPathList, "molecule::CyclicStructureAnalysis: **ShortestPathList");
2275 Free((void **)&ColorList, "molecule::CyclicStructureAnalysis: **ColorList");
2276 delete(BFSStack);
2277};
2278
2279/** Sets the next component number.
2280 * This is O(N) as the number of bonds per atom is bound.
2281 * \param *vertex atom whose next atom::*ComponentNr is to be set
2282 * \param nr number to use
2283 */
2284void molecule::SetNextComponentNumber(atom *vertex, int nr)
2285{
2286 int i=0;
2287 if (vertex != NULL) {
2288 for(;i<NumberOfBondsPerAtom[vertex->nr];i++) {
2289 if (vertex->ComponentNr[i] == -1) { // check if not yet used
2290 vertex->ComponentNr[i] = nr;
2291 break;
2292 }
2293 else if (vertex->ComponentNr[i] == nr) // if number is already present, don't add another time
2294 break; // breaking here will not cause error!
2295 }
2296 if (i == NumberOfBondsPerAtom[vertex->nr])
2297 cerr << "Error: All Component entries are already occupied!" << endl;
2298 } else
2299 cerr << "Error: Given vertex is NULL!" << endl;
2300};
2301
2302/** Output a list of flags, stating whether the bond was visited or not.
2303 * \param *out output stream for debugging
2304 */
2305void molecule::OutputComponentNumber(ofstream *out, atom *vertex)
2306{
2307 for(int i=0;i<NumberOfBondsPerAtom[vertex->nr];i++)
2308 *out << vertex->ComponentNr[i] << " ";
2309};
2310
2311/** Allocates memory for all atom::*ComponentNr in this molecule and sets each entry to -1.
2312 */
2313void molecule::InitComponentNumbers()
2314{
2315 atom *Walker = start;
2316 while(Walker->next != end) {
2317 Walker = Walker->next;
2318 if (Walker->ComponentNr != NULL)
2319 Free((void **)&Walker->ComponentNr, "molecule::InitComponentNumbers: **Walker->ComponentNr");
2320 Walker->ComponentNr = (int *) Malloc(sizeof(int)*NumberOfBondsPerAtom[Walker->nr], "molecule::InitComponentNumbers: *Walker->ComponentNr");
2321 for (int i=NumberOfBondsPerAtom[Walker->nr];i--;)
2322 Walker->ComponentNr[i] = -1;
2323 }
2324};
2325
2326/** Returns next unused bond for this atom \a *vertex or NULL of none exists.
2327 * \param *vertex atom to regard
2328 * \return bond class or NULL
2329 */
2330bond * molecule::FindNextUnused(atom *vertex)
2331{
2332 for(int i=0;i<NumberOfBondsPerAtom[vertex->nr];i++)
2333 if (ListOfBondsPerAtom[vertex->nr][i]->IsUsed() == white)
2334 return(ListOfBondsPerAtom[vertex->nr][i]);
2335 return NULL;
2336};
2337
2338/** Resets bond::Used flag of all bonds in this molecule.
2339 * \return true - success, false - -failure
2340 */
2341void molecule::ResetAllBondsToUnused()
2342{
2343 bond *Binder = first;
2344 while (Binder->next != last) {
2345 Binder = Binder->next;
2346 Binder->ResetUsed();
2347 }
2348};
2349
2350/** Resets atom::nr to -1 of all atoms in this molecule.
2351 */
2352void molecule::ResetAllAtomNumbers()
2353{
2354 atom *Walker = start;
2355 while (Walker->next != end) {
2356 Walker = Walker->next;
2357 Walker->GraphNr = -1;
2358 }
2359};
2360
2361/** Output a list of flags, stating whether the bond was visited or not.
2362 * \param *out output stream for debugging
2363 * \param *list
2364 */
2365void OutputAlreadyVisited(ofstream *out, int *list)
2366{
2367 *out << Verbose(4) << "Already Visited Bonds:\t";
2368 for(int i=1;i<=list[0];i++) *out << Verbose(0) << list[i] << " ";
2369 *out << endl;
2370};
2371
2372/** Estimates by educated guessing (using upper limit) the expected number of fragments.
2373 * The upper limit is
2374 * \f[
2375 * n = N \cdot C^k
2376 * \f]
2377 * where \f$C=2^c\f$ and c is the maximum bond degree over N number of atoms.
2378 * \param *out output stream for debugging
2379 * \param order bond order k
2380 * \return number n of fragments
2381 */
2382int molecule::GuesstimateFragmentCount(ofstream *out, int order)
2383{
2384 int c = 0;
2385 int FragmentCount;
2386 // get maximum bond degree
2387 atom *Walker = start;
2388 while (Walker->next != end) {
2389 Walker = Walker->next;
2390 c = (NumberOfBondsPerAtom[Walker->nr] > c) ? NumberOfBondsPerAtom[Walker->nr] : c;
2391 }
2392 FragmentCount = NoNonHydrogen*(1 << (c*order));
2393 *out << Verbose(1) << "Upper limit for this subgraph is " << FragmentCount << " for " << NoNonHydrogen << " non-H atoms with maximum bond degree of " << c << "." << endl;
2394 return FragmentCount;
2395};
2396
2397/** Scans a single line for number and puts them into \a KeySet.
2398 * \param *out output stream for debugging
2399 * \param *buffer buffer to scan
2400 * \param &CurrentSet filled KeySet on return
2401 * \return true - at least one valid atom id parsed, false - CurrentSet is empty
2402 */
2403bool molecule::ScanBufferIntoKeySet(ofstream *out, char *buffer, KeySet &CurrentSet)
2404{
2405 stringstream line;
2406 int AtomNr;
2407 int status = 0;
2408
2409 line.str(buffer);
2410 while (!line.eof()) {
2411 line >> AtomNr;
2412 if ((AtomNr >= 0) && (AtomNr < AtomCount)) {
2413 CurrentSet.insert(AtomNr); // insert at end, hence in same order as in file!
2414 status++;
2415 } // else it's "-1" or else and thus must not be added
2416 }
2417 *out << Verbose(1) << "The scanned KeySet is ";
2418 for(KeySet::iterator runner = CurrentSet.begin(); runner != CurrentSet.end(); runner++) {
2419 *out << (*runner) << "\t";
2420 }
2421 *out << endl;
2422 return (status != 0);
2423};
2424
2425/** Parses the KeySet file and fills \a *FragmentList from the known molecule structure.
2426 * Does two-pass scanning:
2427 * -# Scans the keyset file and initialises a temporary graph
2428 * -# Scans TEFactors file and sets the TEFactor of each key set in the temporary graph accordingly
2429 * Finally, the temporary graph is inserted into the given \a FragmentList for return.
2430 * \param *out output stream for debugging
2431 * \param *path path to file
2432 * \param *FragmentList empty, filled on return
2433 * \return true - parsing successfully, false - failure on parsing (FragmentList will be NULL)
2434 */
2435bool molecule::ParseKeySetFile(ofstream *out, char *path, Graph *&FragmentList)
2436{
2437 bool status = true;
2438 ifstream InputFile;
2439 stringstream line;
2440 GraphTestPair testGraphInsert;
2441 int NumberOfFragments = 0;
2442 double TEFactor;
2443 char *filename = (char *) Malloc(sizeof(char)*MAXSTRINGSIZE, "molecule::ParseKeySetFile - filename");
2444
2445 if (FragmentList == NULL) { // check list pointer
2446 FragmentList = new Graph;
2447 }
2448
2449 // 1st pass: open file and read
2450 *out << Verbose(1) << "Parsing the KeySet file ... " << endl;
2451 sprintf(filename, "%s/%s%s", path, FRAGMENTPREFIX, KEYSETFILE);
2452 InputFile.open(filename);
2453 if (InputFile != NULL) {
2454 // each line represents a new fragment
2455 char *buffer = (char *) Malloc(sizeof(char)*MAXSTRINGSIZE, "molecule::ParseKeySetFile - *buffer");
2456 // 1. parse keysets and insert into temp. graph
2457 while (!InputFile.eof()) {
2458 InputFile.getline(buffer, MAXSTRINGSIZE);
2459 KeySet CurrentSet;
2460 if ((strlen(buffer) > 0) && (ScanBufferIntoKeySet(out, buffer, CurrentSet))) { // if at least one valid atom was added, write config
2461 testGraphInsert = FragmentList->insert(GraphPair (CurrentSet,pair<int,double>(NumberOfFragments++,1))); // store fragment number and current factor
2462 if (!testGraphInsert.second) {
2463 cerr << "KeySet file must be corrupt as there are two equal key sets therein!" << endl;
2464 }
2465 //FragmentList->ListOfMolecules[NumberOfFragments++] = StoreFragmentFromKeySet(out, CurrentSet, IsAngstroem);
2466 }
2467 }
2468 // 2. Free and done
2469 InputFile.close();
2470 InputFile.clear();
2471 Free((void **)&buffer, "molecule::ParseKeySetFile - *buffer");
2472 *out << Verbose(1) << "done." << endl;
2473 } else {
2474 *out << Verbose(1) << "File " << filename << " not found." << endl;
2475 status = false;
2476 }
2477
2478 // 2nd pass: open TEFactors file and read
2479 *out << Verbose(1) << "Parsing the TEFactors file ... " << endl;
2480 sprintf(filename, "%s/%s%s", path, FRAGMENTPREFIX, TEFACTORSFILE);
2481 InputFile.open(filename);
2482 if (InputFile != NULL) {
2483 // 3. add found TEFactors to each keyset
2484 NumberOfFragments = 0;
2485 for(Graph::iterator runner = FragmentList->begin();runner != FragmentList->end(); runner++) {
2486 if (!InputFile.eof()) {
2487 InputFile >> TEFactor;
2488 (*runner).second.second = TEFactor;
2489 *out << Verbose(2) << "Setting " << ++NumberOfFragments << " fragment's TEFactor to " << (*runner).second.second << "." << endl;
2490 } else {
2491 status = false;
2492 break;
2493 }
2494 }
2495 // 4. Free and done
2496 InputFile.close();
2497 *out << Verbose(1) << "done." << endl;
2498 } else {
2499 *out << Verbose(1) << "File " << filename << " not found." << endl;
2500 status = false;
2501 }
2502
2503 // free memory
2504 Free((void **)&filename, "molecule::ParseKeySetFile - filename");
2505
2506 return status;
2507};
2508
2509/** Stores keysets and TEFactors to file.
2510 * \param *out output stream for debugging
2511 * \param KeySetList Graph with Keysets and factors
2512 * \param *path path to file
2513 * \return true - file written successfully, false - writing failed
2514 */
2515bool molecule::StoreKeySetFile(ofstream *out, Graph &KeySetList, char *path)
2516{
2517 ofstream output;
2518 bool status = true;
2519 string line;
2520
2521 // open KeySet file
2522 line = path;
2523 line.append("/");
2524 line += FRAGMENTPREFIX;
2525 line += KEYSETFILE;
2526 output.open(line.c_str(), ios::out);
2527 *out << Verbose(1) << "Saving key sets of the total graph ... ";
2528 if(output != NULL) {
2529 for(Graph::iterator runner = KeySetList.begin(); runner != KeySetList.end(); runner++) {
2530 for (KeySet::iterator sprinter = (*runner).first.begin();sprinter != (*runner).first.end(); sprinter++) {
2531 if (sprinter != (*runner).first.begin())
2532 output << "\t";
2533 output << *sprinter;
2534 }
2535 output << endl;
2536 }
2537 *out << "done." << endl;
2538 } else {
2539 cerr << "Unable to open " << line << " for writing keysets!" << endl;
2540 status = false;
2541 }
2542 output.close();
2543 output.clear();
2544
2545 // open TEFactors file
2546 line = path;
2547 line.append("/");
2548 line += FRAGMENTPREFIX;
2549 line += TEFACTORSFILE;
2550 output.open(line.c_str(), ios::out);
2551 *out << Verbose(1) << "Saving TEFactors of the total graph ... ";
2552 if(output != NULL) {
2553 for(Graph::iterator runner = KeySetList.begin(); runner != KeySetList.end(); runner++)
2554 output << (*runner).second.second << endl;
2555 *out << Verbose(1) << "done." << endl;
2556 } else {
2557 *out << Verbose(1) << "failed to open " << line << "." << endl;
2558 status = false;
2559 }
2560 output.close();
2561
2562 return status;
2563};
2564
2565/** Storing the bond structure of a molecule to file.
2566 * Simply stores Atom::nr and then the Atom::nr of all bond partners per line.
2567 * \param *out output stream for debugging
2568 * \param *path path to file
2569 * \return true - file written successfully, false - writing failed
2570 */
2571bool molecule::StoreAdjacencyToFile(ofstream *out, char *path)
2572{
2573 ofstream AdjacencyFile;
2574 atom *Walker = NULL;
2575 stringstream line;
2576 bool status = true;
2577
2578 line << path << "/" << FRAGMENTPREFIX << ADJACENCYFILE;
2579 AdjacencyFile.open(line.str().c_str(), ios::out);
2580 *out << Verbose(1) << "Saving adjacency list ... ";
2581 if (AdjacencyFile != NULL) {
2582 Walker = start;
2583 while(Walker->next != end) {
2584 Walker = Walker->next;
2585 AdjacencyFile << Walker->nr << "\t";
2586 for (int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++)
2587 AdjacencyFile << ListOfBondsPerAtom[Walker->nr][i]->GetOtherAtom(Walker)->nr << "\t";
2588 AdjacencyFile << endl;
2589 }
2590 AdjacencyFile.close();
2591 *out << Verbose(1) << "done." << endl;
2592 } else {
2593 *out << Verbose(1) << "failed to open file " << line.str() << "." << endl;
2594 status = false;
2595 }
2596
2597 return status;
2598};
2599
2600/** Checks contents of adjacency file against bond structure in structure molecule.
2601 * \param *out output stream for debugging
2602 * \param *path path to file
2603 * \param **ListOfAtoms allocated (molecule::AtomCount) and filled lookup table for ids (Atom::nr) to *Atom
2604 * \return true - structure is equal, false - not equivalence
2605 */
2606bool molecule::CheckAdjacencyFileAgainstMolecule(ofstream *out, char *path, atom **ListOfAtoms)
2607{
2608 ifstream File;
2609 stringstream filename;
2610 bool status = true;
2611 char *buffer = (char *) Malloc(sizeof(char)*MAXSTRINGSIZE, "molecule::CheckAdjacencyFileAgainstMolecule: *buffer");
2612
2613 filename << path << "/" << FRAGMENTPREFIX << ADJACENCYFILE;
2614 File.open(filename.str().c_str(), ios::out);
2615 *out << Verbose(1) << "Looking at bond structure stored in adjacency file and comparing to present one ... ";
2616 if (File != NULL) {
2617 // allocate storage structure
2618 int NonMatchNumber = 0; // will number of atoms with differing bond structure
2619 int *CurrentBonds = (int *) Malloc(sizeof(int)*8, "molecule::CheckAdjacencyFileAgainstMolecule - CurrentBonds"); // contains parsed bonds of current atom
2620 int CurrentBondsOfAtom;
2621
2622 // Parse the file line by line and count the bonds
2623 while (!File.eof()) {
2624 File.getline(buffer, MAXSTRINGSIZE);
2625 stringstream line;
2626 line.str(buffer);
2627 int AtomNr = -1;
2628 line >> AtomNr;
2629 CurrentBondsOfAtom = -1; // we count one too far due to line end
2630 // parse into structure
2631 if ((AtomNr >= 0) && (AtomNr < AtomCount)) {
2632 while (!line.eof())
2633 line >> CurrentBonds[ ++CurrentBondsOfAtom ];
2634 // compare against present bonds
2635 //cout << Verbose(2) << "Walker is " << *Walker << ", bond partners: ";
2636 if (CurrentBondsOfAtom == NumberOfBondsPerAtom[AtomNr]) {
2637 for(int i=0;i<NumberOfBondsPerAtom[AtomNr];i++) {
2638 int id = ListOfBondsPerAtom[AtomNr][i]->GetOtherAtom(ListOfAtoms[AtomNr])->nr;
2639 int j = 0;
2640 for (;(j<CurrentBondsOfAtom) && (CurrentBonds[j++] != id);); // check against all parsed bonds
2641 if (CurrentBonds[j-1] != id) { // no match ? Then mark in ListOfAtoms
2642 ListOfAtoms[AtomNr] = NULL;
2643 NonMatchNumber++;
2644 status = false;
2645 //out << "[" << id << "]\t";
2646 } else {
2647 //out << id << "\t";
2648 }
2649 }
2650 //out << endl;
2651 } else {
2652 *out << "Number of bonds for Atom " << *ListOfAtoms[AtomNr] << " does not match, parsed " << CurrentBondsOfAtom << " against " << NumberOfBondsPerAtom[AtomNr] << "." << endl;
2653 status = false;
2654 }
2655 }
2656 }
2657 File.close();
2658 File.clear();
2659 if (status) { // if equal we parse the KeySetFile
2660 *out << Verbose(1) << "done: Equal." << endl;
2661 status = true;
2662 } else
2663 *out << Verbose(1) << "done: Not equal by " << NonMatchNumber << " atoms." << endl;
2664 Free((void **)&CurrentBonds, "molecule::CheckAdjacencyFileAgainstMolecule - **CurrentBonds");
2665 } else {
2666 *out << Verbose(1) << "Adjacency file not found." << endl;
2667 status = false;
2668 }
2669 *out << endl;
2670 Free((void **)&buffer, "molecule::CheckAdjacencyFileAgainstMolecule: *buffer");
2671
2672 return status;
2673};
2674
2675/** Checks whether the OrderAtSite is still below \a Order at some site.
2676 * \param *out output stream for debugging
2677 * \param *AtomMask defines true/false per global Atom::nr to mask in/out each nuclear site, used to activate given number of site to increment order adaptively
2678 * \param *GlobalKeySetList list of keysets with global ids (valid in "this" molecule) needed for adaptive increase
2679 * \param Order desired Order if positive, desired exponent in threshold criteria if negative (0 is single-step)
2680 * \param *MinimumRingSize array of max. possible order to avoid loops
2681 * \param *path path to ENERGYPERFRAGMENT file (may be NULL if Order is non-negative)
2682 * \return true - needs further fragmentation, false - does not need fragmentation
2683 */
2684bool molecule::CheckOrderAtSite(ofstream *out, bool *AtomMask, Graph *GlobalKeySetList, int Order, int *MinimumRingSize, char *path)
2685{
2686 atom *Walker = start;
2687 bool status = false;
2688 ifstream InputFile;
2689
2690 // initialize mask list
2691 for(int i=AtomCount;i--;)
2692 AtomMask[i] = false;
2693
2694 if (Order < 0) { // adaptive increase of BondOrder per site
2695 if (AtomMask[AtomCount] == true) // break after one step
2696 return false;
2697 // parse the EnergyPerFragment file
2698 char *buffer = (char *) Malloc(sizeof(char)*MAXSTRINGSIZE, "molecule::CheckOrderAtSite: *buffer");
2699 sprintf(buffer, "%s/%s%s.dat", path, FRAGMENTPREFIX, ENERGYPERFRAGMENT);
2700 InputFile.open(buffer, ios::in);
2701 if ((InputFile != NULL) && (GlobalKeySetList != NULL)) {
2702 // transmorph graph keyset list into indexed KeySetList
2703 map<int,KeySet> IndexKeySetList;
2704 for(Graph::iterator runner = GlobalKeySetList->begin(); runner != GlobalKeySetList->end(); runner++) {
2705 IndexKeySetList.insert( pair<int,KeySet>(runner->second.first,runner->first) );
2706 }
2707 int lines = 0;
2708 // count the number of lines, i.e. the number of fragments
2709 InputFile.getline(buffer, MAXSTRINGSIZE); // skip comment lines
2710 InputFile.getline(buffer, MAXSTRINGSIZE);
2711 while(!InputFile.eof()) {
2712 InputFile.getline(buffer, MAXSTRINGSIZE);
2713 lines++;
2714 }
2715 //*out << Verbose(2) << "Scanned " << lines-1 << " lines." << endl; // one endline too much
2716 InputFile.clear();
2717 InputFile.seekg(ios::beg);
2718 map<int, pair<double,int> > AdaptiveCriteriaList; // (Root No., (Value, Order)) !
2719 int No, FragOrder;
2720 double Value;
2721 // each line represents a fragment root (Atom::nr) id and its energy contribution
2722 InputFile.getline(buffer, MAXSTRINGSIZE); // skip comment lines
2723 InputFile.getline(buffer, MAXSTRINGSIZE);
2724 while(!InputFile.eof()) {
2725 InputFile.getline(buffer, MAXSTRINGSIZE);
2726 if (strlen(buffer) > 2) {
2727 //*out << Verbose(2) << "Scanning: " << buffer << endl;
2728 stringstream line(buffer);
2729 line >> FragOrder;
2730 line >> ws >> No;
2731 line >> ws >> Value; // skip time entry
2732 line >> ws >> Value;
2733 No -= 1; // indices start at 1 in file, not 0
2734 //*out << Verbose(2) << " - yields (" << No << "," << Value << ", " << FragOrder << ")" << endl;
2735
2736 // clean the list of those entries that have been superceded by higher order terms already
2737 map<int,KeySet>::iterator marker = IndexKeySetList.find(No); // find keyset to Frag No.
2738 if (marker != IndexKeySetList.end()) { // if found
2739 Value *= 1 + MYEPSILON*(*((*marker).second.begin())); // in case of equal energies this makes em not equal without changing anything actually
2740 // as the smallest number in each set has always been the root (we use global id to keep the doubles away), seek smallest and insert into AtomMask
2741 pair <map<int, pair<double,int> >::iterator, bool> InsertedElement = AdaptiveCriteriaList.insert( make_pair(*((*marker).second.begin()), pair<double,int>( fabs(Value), FragOrder) ));
2742 map<int, pair<double,int> >::iterator PresentItem = InsertedElement.first;
2743 if (!InsertedElement.second) { // this root is already present
2744 if ((*PresentItem).second.second < FragOrder) // if order there is lower, update entry with higher-order term
2745 //if ((*PresentItem).second.first < (*runner).first) // as higher-order terms are not always better, we skip this part (which would always include this site into adaptive increase)
2746 { // if value is smaller, update value and order
2747 (*PresentItem).second.first = fabs(Value);
2748 (*PresentItem).second.second = FragOrder;
2749 *out << Verbose(2) << "Updated element (" << (*PresentItem).first << ",[" << (*PresentItem).second.first << "," << (*PresentItem).second.second << "])." << endl;
2750 } else {
2751 *out << Verbose(2) << "Did not update element " << (*PresentItem).first << " as " << FragOrder << " is less than or equal to " << (*PresentItem).second.second << "." << endl;
2752 }
2753 } else {
2754 *out << Verbose(2) << "Inserted element (" << (*PresentItem).first << ",[" << (*PresentItem).second.first << "," << (*PresentItem).second.second << "])." << endl;
2755 }
2756 } else {
2757 *out << Verbose(1) << "No Fragment under No. " << No << "found." << endl;
2758 }
2759 }
2760 }
2761 // then map back onto (Value, (Root Nr., Order)) (i.e. sorted by value to pick the highest ones)
2762 map<double, pair<int,int> > FinalRootCandidates;
2763 *out << Verbose(1) << "Root candidate list is: " << endl;
2764 for(map<int, pair<double,int> >::iterator runner = AdaptiveCriteriaList.begin(); runner != AdaptiveCriteriaList.end(); runner++) {
2765 Walker = FindAtom((*runner).first);
2766 if (Walker != NULL) {
2767 //if ((*runner).second.second >= Walker->AdaptiveOrder) { // only insert if this is an "active" root site for the current order
2768 if (!Walker->MaxOrder) {
2769 *out << Verbose(2) << "(" << (*runner).first << ",[" << (*runner).second.first << "," << (*runner).second.second << "])" << endl;
2770 FinalRootCandidates.insert( make_pair( (*runner).second.first, pair<int,int>((*runner).first, (*runner).second.second) ) );
2771 } else {
2772 *out << Verbose(2) << "Excluding (" << *Walker << ", " << (*runner).first << ",[" << (*runner).second.first << "," << (*runner).second.second << "]), as it has reached its maximum order." << endl;
2773 }
2774 } else {
2775 cerr << "Atom No. " << (*runner).second.first << " was not found in this molecule." << endl;
2776 }
2777 }
2778 // pick the ones still below threshold and mark as to be adaptively updated
2779 for(map<double, pair<int,int> >::iterator runner = FinalRootCandidates.upper_bound(pow(10.,Order)); runner != FinalRootCandidates.end(); runner++) {
2780 No = (*runner).second.first;
2781 Walker = FindAtom(No);
2782 //if (Walker->AdaptiveOrder < MinimumRingSize[Walker->nr]) {
2783 *out << Verbose(2) << "Root " << No << " is still above threshold (10^{" << Order <<"}: " << runner->first << ", setting entry " << No << " of Atom mask to true." << endl;
2784 AtomMask[No] = true;
2785 status = true;
2786 //} else
2787 //*out << Verbose(2) << "Root " << No << " is still above threshold (10^{" << Order <<"}: " << runner->first << ", however MinimumRingSize of " << MinimumRingSize[Walker->nr] << " does not allow further adaptive increase." << endl;
2788 }
2789 // close and done
2790 InputFile.close();
2791 InputFile.clear();
2792 } else {
2793 cerr << "Unable to parse " << buffer << " file, incrementing all." << endl;
2794 while (Walker->next != end) {
2795 Walker = Walker->next;
2796 #ifdef ADDHYDROGEN
2797 if (Walker->type->Z != 1) // skip hydrogen
2798 #endif
2799 {
2800 AtomMask[Walker->nr] = true; // include all (non-hydrogen) atoms
2801 status = true;
2802 }
2803 }
2804 }
2805 Free((void **)&buffer, "molecule::CheckOrderAtSite: *buffer");
2806 // pick a given number of highest values and set AtomMask
2807 } else { // global increase of Bond Order
2808 while (Walker->next != end) {
2809 Walker = Walker->next;
2810 #ifdef ADDHYDROGEN
2811 if (Walker->type->Z != 1) // skip hydrogen
2812 #endif
2813 {
2814 AtomMask[Walker->nr] = true; // include all (non-hydrogen) atoms
2815 if ((Order != 0) && (Walker->AdaptiveOrder < Order)) // && (Walker->AdaptiveOrder < MinimumRingSize[Walker->nr]))
2816 status = true;
2817 }
2818 }
2819 if ((Order == 0) && (AtomMask[AtomCount] == false)) // single stepping, just check
2820 status = true;
2821
2822 if (!status) {
2823 if (Order == 0)
2824 *out << Verbose(1) << "Single stepping done." << endl;
2825 else
2826 *out << Verbose(1) << "Order at every site is already equal or above desired order " << Order << "." << endl;
2827 }
2828 }
2829
2830 // print atom mask for debugging
2831 *out << " ";
2832 for(int i=0;i<AtomCount;i++)
2833 *out << (i % 10);
2834 *out << endl << "Atom mask is: ";
2835 for(int i=0;i<AtomCount;i++)
2836 *out << (AtomMask[i] ? "t" : "f");
2837 *out << endl;
2838
2839 return status;
2840};
2841
2842/** Create a SortIndex to map from atomic labels to the sequence in which the atoms are given in the config file.
2843 * \param *out output stream for debugging
2844 * \param *&SortIndex Mapping array of size molecule::AtomCount
2845 * \return true - success, false - failure of SortIndex alloc
2846 */
2847bool molecule::CreateMappingLabelsToConfigSequence(ofstream *out, int *&SortIndex)
2848{
2849 element *runner = elemente->start;
2850 int AtomNo = 0;
2851 atom *Walker = NULL;
2852
2853 if (SortIndex != NULL) {
2854 *out << Verbose(1) << "SortIndex is " << SortIndex << " and not NULL as expected." << endl;
2855 return false;
2856 }
2857 SortIndex = (int *) Malloc(sizeof(int)*AtomCount, "molecule::FragmentMolecule: *SortIndex");
2858 for(int i=AtomCount;i--;)
2859 SortIndex[i] = -1;
2860 while (runner->next != elemente->end) { // go through every element
2861 runner = runner->next;
2862 if (ElementsInMolecule[runner->Z]) { // if this element got atoms
2863 Walker = start;
2864 while (Walker->next != end) { // go through every atom of this element
2865 Walker = Walker->next;
2866 if (Walker->type->Z == runner->Z) // if this atom fits to element
2867 SortIndex[Walker->nr] = AtomNo++;
2868 }
2869 }
2870 }
2871 return true;
2872};
2873
2874/** Performs a many-body bond order analysis for a given bond order.
2875 * -# parses adjacency, keysets and orderatsite files
2876 * -# performs DFS to find connected subgraphs (to leave this in was a design decision: might be useful later)
2877 * -# RootStack is created for every subgraph (here, later we implement the "update 10 sites with highest energ
2878y contribution", and that's why this consciously not done in the following loop)
2879 * -# in a loop over all subgraphs
2880 * -# calls FragmentBOSSANOVA with this RootStack and within the subgraph molecule structure
2881 * -# creates molecule (fragment)s from the returned keysets (StoreFragmentFromKeySet)
2882 * -# combines the generated molecule lists from all subgraphs
2883 * -# saves to disk: fragment configs, adjacency, orderatsite, keyset files
2884 * Note that as we split "this" molecule up into a list of subgraphs, i.e. a MoleculeListClass, we have two sets
2885 * of vertex indices: Global always means the index in "this" molecule, whereas local refers to the molecule or
2886 * subgraph in the MoleculeListClass.
2887 * \param *out output stream for debugging
2888 * \param Order up to how many neighbouring bonds a fragment contains in BondOrderScheme::BottumUp scheme
2889 * \param *configuration configuration for writing config files for each fragment
2890 * \return 1 - continue, 2 - stop (no fragmentation occured)
2891 */
2892int molecule::FragmentMolecule(ofstream *out, int Order, config *configuration)
2893{
2894 MoleculeListClass *BondFragments = NULL;
2895 int *SortIndex = NULL;
2896 int *MinimumRingSize = NULL;
2897 int FragmentCounter;
2898 MoleculeLeafClass *MolecularWalker = NULL;
2899 MoleculeLeafClass *Subgraphs = NULL; // list of subgraphs from DFS analysis
2900 fstream File;
2901 bool FragmentationToDo = true;
2902 bool CheckOrder = false;
2903 Graph **FragmentList = NULL;
2904 Graph *ParsedFragmentList = NULL;
2905 Graph TotalGraph; // graph with all keysets however local numbers
2906 int TotalNumberOfKeySets = 0;
2907 atom **ListOfAtoms = NULL;
2908 atom ***ListOfLocalAtoms = NULL;
2909 bool *AtomMask = NULL;
2910
2911 *out << endl;
2912#ifdef ADDHYDROGEN
2913 *out << Verbose(0) << "I will treat hydrogen special and saturate dangling bonds with it." << endl;
2914#else
2915 *out << Verbose(0) << "Hydrogen is treated just like the rest of the lot." << endl;
2916#endif
2917
2918 // ++++++++++++++++++++++++++++ INITIAL STUFF: Bond structure analysis, file parsing, ... ++++++++++++++++++++++++++++++++++++++++++
2919
2920 // ===== 1. Check whether bond structure is same as stored in files ====
2921
2922 // fill the adjacency list
2923 CreateListOfBondsPerAtom(out);
2924
2925 // create lookup table for Atom::nr
2926 FragmentationToDo = FragmentationToDo && CreateFatherLookupTable(out, start, end, ListOfAtoms, AtomCount);
2927
2928 // === compare it with adjacency file ===
2929 FragmentationToDo = FragmentationToDo && CheckAdjacencyFileAgainstMolecule(out, configuration->configpath, ListOfAtoms);
2930 Free((void **)&ListOfAtoms, "molecule::FragmentMolecule - **ListOfAtoms");
2931
2932 // ===== 2. perform a DFS analysis to gather info on cyclic structure and a list of disconnected subgraphs =====
2933 Subgraphs = DepthFirstSearchAnalysis(out, MinimumRingSize);
2934 // fill the bond structure of the individually stored subgraphs
2935 Subgraphs->next->FillBondStructureFromReference(out, this, (FragmentCounter = 0), ListOfLocalAtoms, false); // we want to keep the created ListOfLocalAtoms
2936
2937 // ===== 3. if structure still valid, parse key set file and others =====
2938 FragmentationToDo = FragmentationToDo && ParseKeySetFile(out, configuration->configpath, ParsedFragmentList);
2939
2940 // ===== 4. check globally whether there's something to do actually (first adaptivity check)
2941 FragmentationToDo = FragmentationToDo && ParseOrderAtSiteFromFile(out, configuration->configpath);
2942
2943 // =================================== Begin of FRAGMENTATION ===============================
2944 // ===== 6a. assign each keyset to its respective subgraph =====
2945 Subgraphs->next->AssignKeySetsToFragment(out, this, ParsedFragmentList, ListOfLocalAtoms, FragmentList, (FragmentCounter = 0), false);
2946
2947 // ===== 6b. prepare and go into the adaptive (Order<0), single-step (Order==0) or incremental (Order>0) cycle
2948 KeyStack *RootStack = new KeyStack[Subgraphs->next->Count()];
2949 AtomMask = new bool[AtomCount+1];
2950 AtomMask[AtomCount] = false;
2951 FragmentationToDo = false; // if CheckOrderAtSite just ones recommends fragmentation, we will save fragments afterwards
2952 while ((CheckOrder = CheckOrderAtSite(out, AtomMask, ParsedFragmentList, Order, MinimumRingSize, configuration->configpath))) {
2953 FragmentationToDo = FragmentationToDo || CheckOrder;
2954 AtomMask[AtomCount] = true; // last plus one entry is used as marker that we have been through this loop once already in CheckOrderAtSite()
2955 // ===== 6b. fill RootStack for each subgraph (second adaptivity check) =====
2956 Subgraphs->next->FillRootStackForSubgraphs(out, RootStack, AtomMask, (FragmentCounter = 0));
2957
2958 // ===== 7. fill the bond fragment list =====
2959 FragmentCounter = 0;
2960 MolecularWalker = Subgraphs;
2961 while (MolecularWalker->next != NULL) {
2962 MolecularWalker = MolecularWalker->next;
2963 *out << Verbose(1) << "Fragmenting subgraph " << MolecularWalker << "." << endl;
2964 // output ListOfBondsPerAtom for debugging
2965 MolecularWalker->Leaf->OutputListOfBonds(out);
2966 if (MolecularWalker->Leaf->first->next != MolecularWalker->Leaf->last) {
2967
2968 // call BOSSANOVA method
2969 *out << Verbose(0) << endl << " ========== BOND ENERGY of subgraph " << FragmentCounter << " ========================= " << endl;
2970 MolecularWalker->Leaf->FragmentBOSSANOVA(out, FragmentList[FragmentCounter], RootStack[FragmentCounter], MinimumRingSize);
2971 } else {
2972 cerr << "Subgraph " << MolecularWalker << " has no atoms!" << endl;
2973 }
2974 FragmentCounter++; // next fragment list
2975 }
2976 }
2977 delete[](RootStack);
2978 delete[](AtomMask);
2979 delete(ParsedFragmentList);
2980 delete[](MinimumRingSize);
2981
2982 // free the index lookup list
2983 for (int i=FragmentCounter;i--;)
2984 Free((void **)&ListOfLocalAtoms[i], "molecule::FragmentMolecule - *ListOfLocalAtoms[]");
2985 Free((void **)&ListOfLocalAtoms, "molecule::FragmentMolecule - **ListOfLocalAtoms");
2986
2987 // ==================================== End of FRAGMENTATION ============================================
2988
2989 // ===== 8a. translate list into global numbers (i.e. ones that are valid in "this" molecule, not in MolecularWalker->Leaf)
2990 Subgraphs->next->TranslateIndicesToGlobalIDs(out, FragmentList, (FragmentCounter = 0), TotalNumberOfKeySets, TotalGraph);
2991
2992 // free subgraph memory again
2993 FragmentCounter = 0;
2994 if (Subgraphs != NULL) {
2995 while (Subgraphs->next != NULL) {
2996 Subgraphs = Subgraphs->next;
2997 delete(FragmentList[FragmentCounter++]);
2998 delete(Subgraphs->previous);
2999 }
3000 delete(Subgraphs);
3001 }
3002 Free((void **)&FragmentList, "molecule::FragmentMolecule - **FragmentList");
3003
3004 // ===== 8b. gather keyset lists (graphs) from all subgraphs and transform into MoleculeListClass =====
3005 //if (FragmentationToDo) { // we should always store the fragments again as coordination might have changed slightly without changing bond structure
3006 // allocate memory for the pointer array and transmorph graphs into full molecular fragments
3007 BondFragments = new MoleculeListClass(TotalGraph.size(), AtomCount);
3008 int k=0;
3009 for(Graph::iterator runner = TotalGraph.begin(); runner != TotalGraph.end(); runner++) {
3010 KeySet test = (*runner).first;
3011 *out << "Fragment No." << (*runner).second.first << " with TEFactor " << (*runner).second.second << "." << endl;
3012 BondFragments->ListOfMolecules[k] = StoreFragmentFromKeySet(out, test, configuration);
3013 k++;
3014 }
3015 *out << k << "/" << BondFragments->NumberOfMolecules << " fragments generated from the keysets." << endl;
3016
3017 // ===== 9. Save fragments' configuration and keyset files et al to disk ===
3018 if (BondFragments->NumberOfMolecules != 0) {
3019 // create the SortIndex from BFS labels to order in the config file
3020 CreateMappingLabelsToConfigSequence(out, SortIndex);
3021
3022 *out << Verbose(1) << "Writing " << BondFragments->NumberOfMolecules << " possible bond fragmentation configs" << endl;
3023 if (BondFragments->OutputConfigForListOfFragments(out, configuration, SortIndex))
3024 *out << Verbose(1) << "All configs written." << endl;
3025 else
3026 *out << Verbose(1) << "Some config writing failed." << endl;
3027
3028 // store force index reference file
3029 BondFragments->StoreForcesFile(out, configuration->configpath, SortIndex);
3030
3031 // store keysets file
3032 StoreKeySetFile(out, TotalGraph, configuration->configpath);
3033
3034 // store Adjacency file
3035 StoreAdjacencyToFile(out, configuration->configpath);
3036
3037 // store Hydrogen saturation correction file
3038 BondFragments->AddHydrogenCorrection(out, configuration->configpath);
3039
3040 // store adaptive orders into file
3041 StoreOrderAtSiteFile(out, configuration->configpath);
3042
3043 // restore orbital and Stop values
3044 CalculateOrbitals(*configuration);
3045
3046 // free memory for bond part
3047 *out << Verbose(1) << "Freeing bond memory" << endl;
3048 delete(FragmentList); // remove bond molecule from memory
3049 Free((void **)&SortIndex, "molecule::FragmentMolecule: *SortIndex");
3050 } else
3051 *out << Verbose(1) << "FragmentList is zero on return, splitting failed." << endl;
3052 //} else
3053 // *out << Verbose(1) << "No fragments to store." << endl;
3054 *out << Verbose(0) << "End of bond fragmentation." << endl;
3055
3056 return ((int)(!FragmentationToDo)+1); // 1 - continue, 2 - stop (no fragmentation occured)
3057};
3058
3059/** Stores pairs (Atom::nr, Atom::AdaptiveOrder) into file.
3060 * Atoms not present in the file get "-1".
3061 * \param *out output stream for debugging
3062 * \param *path path to file ORDERATSITEFILE
3063 * \return true - file writable, false - not writable
3064 */
3065bool molecule::StoreOrderAtSiteFile(ofstream *out, char *path)
3066{
3067 stringstream line;
3068 ofstream file;
3069
3070 line << path << "/" << FRAGMENTPREFIX << ORDERATSITEFILE;
3071 file.open(line.str().c_str());
3072 *out << Verbose(1) << "Writing OrderAtSite " << ORDERATSITEFILE << " ... " << endl;
3073 if (file != NULL) {
3074 atom *Walker = start;
3075 while (Walker->next != end) {
3076 Walker = Walker->next;
3077 file << Walker->nr << "\t" << (int)Walker->AdaptiveOrder << "\t" << (int)Walker->MaxOrder << endl;
3078 *out << Verbose(2) << "Storing: " << Walker->nr << "\t" << (int)Walker->AdaptiveOrder << "\t" << (int)Walker->MaxOrder << "." << endl;
3079 }
3080 file.close();
3081 *out << Verbose(1) << "done." << endl;
3082 return true;
3083 } else {
3084 *out << Verbose(1) << "failed to open file " << line.str() << "." << endl;
3085 return false;
3086 }
3087};
3088
3089/** Parses pairs(Atom::nr, Atom::AdaptiveOrder) from file and stores in molecule's Atom's.
3090 * Atoms not present in the file get "0".
3091 * \param *out output stream for debugging
3092 * \param *path path to file ORDERATSITEFILEe
3093 * \return true - file found and scanned, false - file not found
3094 * \sa ParseKeySetFile() and CheckAdjacencyFileAgainstMolecule() as this is meant to be used in conjunction with the two
3095 */
3096bool molecule::ParseOrderAtSiteFromFile(ofstream *out, char *path)
3097{
3098 unsigned char *OrderArray = (unsigned char *) Malloc(sizeof(unsigned char)*AtomCount, "molecule::ParseOrderAtSiteFromFile - *OrderArray");
3099 bool *MaxArray = (bool *) Malloc(sizeof(bool)*AtomCount, "molecule::ParseOrderAtSiteFromFile - *MaxArray");
3100 bool status;
3101 int AtomNr, value;
3102 stringstream line;
3103 ifstream file;
3104
3105 *out << Verbose(1) << "Begin of ParseOrderAtSiteFromFile" << endl;
3106 for(int i=AtomCount;i--;)
3107 OrderArray[i] = 0;
3108 line << path << "/" << FRAGMENTPREFIX << ORDERATSITEFILE;
3109 file.open(line.str().c_str());
3110 if (file != NULL) {
3111 for (int i=AtomCount;i--;) { // initialise with 0
3112 OrderArray[i] = 0;
3113 MaxArray[i] = 0;
3114 }
3115 while (!file.eof()) { // parse from file
3116 AtomNr = -1;
3117 file >> AtomNr;
3118 if (AtomNr != -1) { // test whether we really parsed something (this is necessary, otherwise last atom is set twice and to 0 on second time)
3119 file >> value;
3120 OrderArray[AtomNr] = value;
3121 file >> value;
3122 MaxArray[AtomNr] = value;
3123 //*out << Verbose(2) << "AtomNr " << AtomNr << " with order " << (int)OrderArray[AtomNr] << " and max order set to " << (int)MaxArray[AtomNr] << "." << endl;
3124 }
3125 }
3126 atom *Walker = start;
3127 while (Walker->next != end) { // fill into atom classes
3128 Walker = Walker->next;
3129 Walker->AdaptiveOrder = OrderArray[Walker->nr];
3130 Walker->MaxOrder = MaxArray[Walker->nr];
3131 *out << Verbose(2) << *Walker << " gets order " << (int)Walker->AdaptiveOrder << " and is " << (!Walker->MaxOrder ? "not " : " ") << "maxed." << endl;
3132 }
3133 file.close();
3134 *out << Verbose(1) << "done." << endl;
3135 status = true;
3136 } else {
3137 *out << Verbose(1) << "failed to open file " << line.str() << "." << endl;
3138 status = false;
3139 }
3140 Free((void **)&OrderArray, "molecule::ParseOrderAtSiteFromFile - *OrderArray");
3141 Free((void **)&MaxArray, "molecule::ParseOrderAtSiteFromFile - *MaxArray");
3142
3143 *out << Verbose(1) << "End of ParseOrderAtSiteFromFile" << endl;
3144 return status;
3145};
3146
3147/** Creates an 2d array of pointer with an entry for each atom and each bond it has.
3148 * Updates molecule::ListOfBondsPerAtom, molecule::NumberOfBondsPerAtom by parsing through
3149 * bond chain list, using molecule::AtomCount and molecule::BondCount.
3150 * Allocates memory, fills the array and exits
3151 * \param *out output stream for debugging
3152 */
3153void molecule::CreateListOfBondsPerAtom(ofstream *out)
3154{
3155 bond *Binder = NULL;
3156 atom *Walker = NULL;
3157 int TotalDegree;
3158 *out << Verbose(1) << "Begin of Creating ListOfBondsPerAtom: AtomCount = " << AtomCount << "\tBondCount = " << BondCount << "\tNoNonBonds = " << NoNonBonds << "." << endl;
3159
3160 // re-allocate memory
3161 *out << Verbose(2) << "(Re-)Allocating memory." << endl;
3162 if (ListOfBondsPerAtom != NULL) {
3163 for(int i=AtomCount;i--;)
3164 Free((void **)&ListOfBondsPerAtom[i], "molecule::CreateListOfBondsPerAtom: ListOfBondsPerAtom[i]");
3165 Free((void **)&ListOfBondsPerAtom, "molecule::CreateListOfBondsPerAtom: ListOfBondsPerAtom");
3166 }
3167 if (NumberOfBondsPerAtom != NULL)
3168 Free((void **)&NumberOfBondsPerAtom, "molecule::CreateListOfBondsPerAtom: NumberOfBondsPerAtom");
3169 ListOfBondsPerAtom = (bond ***) Malloc(sizeof(bond **)*AtomCount, "molecule::CreateListOfBondsPerAtom: ***ListOfBondsPerAtom");
3170 NumberOfBondsPerAtom = (int *) Malloc(sizeof(int)*AtomCount, "molecule::CreateListOfBondsPerAtom: *NumberOfBondsPerAtom");
3171
3172 // reset bond counts per atom
3173 for(int i=AtomCount;i--;)
3174 NumberOfBondsPerAtom[i] = 0;
3175 // count bonds per atom
3176 Binder = first;
3177 while (Binder->next != last) {
3178 Binder = Binder->next;
3179 NumberOfBondsPerAtom[Binder->leftatom->nr]++;
3180 NumberOfBondsPerAtom[Binder->rightatom->nr]++;
3181 }
3182 for(int i=AtomCount;i--;) {
3183 // allocate list of bonds per atom
3184 ListOfBondsPerAtom[i] = (bond **) Malloc(sizeof(bond *)*NumberOfBondsPerAtom[i], "molecule::CreateListOfBondsPerAtom: **ListOfBondsPerAtom[]");
3185 // clear the list again, now each NumberOfBondsPerAtom marks current free field
3186 NumberOfBondsPerAtom[i] = 0;
3187 }
3188 // fill the list
3189 Binder = first;
3190 while (Binder->next != last) {
3191 Binder = Binder->next;
3192 ListOfBondsPerAtom[Binder->leftatom->nr][NumberOfBondsPerAtom[Binder->leftatom->nr]++] = Binder;
3193 ListOfBondsPerAtom[Binder->rightatom->nr][NumberOfBondsPerAtom[Binder->rightatom->nr]++] = Binder;
3194 }
3195
3196 // output list for debugging
3197 *out << Verbose(3) << "ListOfBondsPerAtom for each atom:" << endl;
3198 Walker = start;
3199 while (Walker->next != end) {
3200 Walker = Walker->next;
3201 *out << Verbose(4) << "Atom " << Walker->Name << " with " << NumberOfBondsPerAtom[Walker->nr] << " bonds: ";
3202 TotalDegree = 0;
3203 for (int j=0;j<NumberOfBondsPerAtom[Walker->nr];j++) {
3204 *out << *ListOfBondsPerAtom[Walker->nr][j] << "\t";
3205 TotalDegree += ListOfBondsPerAtom[Walker->nr][j]->BondDegree;
3206 }
3207 *out << " -- TotalDegree: " << TotalDegree << endl;
3208 }
3209 *out << Verbose(1) << "End of Creating ListOfBondsPerAtom." << endl << endl;
3210};
3211
3212/** Adds atoms up to \a BondCount distance from \a *Root and notes them down in \a **AddedAtomList.
3213 * Gray vertices are always enqueued in an StackClass<atom *> FIFO queue, the rest is usual BFS with adding vertices found was
3214 * white and putting into queue.
3215 * \param *out output stream for debugging
3216 * \param *Mol Molecule class to add atoms to
3217 * \param **AddedAtomList list with added atom pointers, index is atom father's number
3218 * \param **AddedBondList list with added bond pointers, index is bond father's number
3219 * \param *Root root vertex for BFS
3220 * \param *Bond bond not to look beyond
3221 * \param BondOrder maximum distance for vertices to add
3222 * \param IsAngstroem lengths are in angstroem or bohrradii
3223 */
3224void molecule::BreadthFirstSearchAdd(ofstream *out, molecule *Mol, atom **&AddedAtomList, bond **&AddedBondList, atom *Root, bond *Bond, int BondOrder, bool IsAngstroem)
3225{
3226 atom **PredecessorList = (atom **) Malloc(sizeof(atom *)*AtomCount, "molecule::BreadthFirstSearchAdd: **PredecessorList");
3227 int *ShortestPathList = (int *) Malloc(sizeof(int)*AtomCount, "molecule::BreadthFirstSearchAdd: *ShortestPathList");
3228 enum Shading *ColorList = (enum Shading *) Malloc(sizeof(enum Shading)*AtomCount, "molecule::BreadthFirstSearchAdd: *ColorList");
3229 class StackClass<atom *> *AtomStack = new StackClass<atom *>(AtomCount);
3230 atom *Walker = NULL, *OtherAtom = NULL;
3231 bond *Binder = NULL;
3232
3233 // add Root if not done yet
3234 AtomStack->ClearStack();
3235 if (AddedAtomList[Root->nr] == NULL) // add Root if not yet present
3236 AddedAtomList[Root->nr] = Mol->AddCopyAtom(Root);
3237 AtomStack->Push(Root);
3238
3239 // initialise each vertex as white with no predecessor, empty queue, color Root lightgray
3240 for (int i=AtomCount;i--;) {
3241 PredecessorList[i] = NULL;
3242 ShortestPathList[i] = -1;
3243 if (AddedAtomList[i] != NULL) // mark already present atoms (i.e. Root and maybe others) as visited
3244 ColorList[i] = lightgray;
3245 else
3246 ColorList[i] = white;
3247 }
3248 ShortestPathList[Root->nr] = 0;
3249
3250 // and go on ... Queue always contains all lightgray vertices
3251 while (!AtomStack->IsEmpty()) {
3252 // we have to pop the oldest atom from stack. This keeps the atoms on the stack always of the same ShortestPath distance.
3253 // e.g. if current atom is 2, push to end of stack are of length 3, but first all of length 2 would be popped. They again
3254 // append length of 3 (their neighbours). Thus on stack we have always atoms of a certain length n at bottom of stack and
3255 // followed by n+1 till top of stack.
3256 Walker = AtomStack->PopFirst(); // pop oldest added
3257 *out << Verbose(1) << "Current Walker is: " << Walker->Name << ", and has " << NumberOfBondsPerAtom[Walker->nr] << " bonds." << endl;
3258 for(int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++) {
3259 Binder = ListOfBondsPerAtom[Walker->nr][i];
3260 if (Binder != NULL) { // don't look at bond equal NULL
3261 OtherAtom = Binder->GetOtherAtom(Walker);
3262 *out << Verbose(2) << "Current OtherAtom is: " << OtherAtom->Name << " for bond " << *Binder << "." << endl;
3263 if (ColorList[OtherAtom->nr] == white) {
3264 if (Binder != Bond) // let other atom white if it's via Root bond. In case it's cyclic it has to be reached again (yet Root is from OtherAtom already black, thus no problem)
3265 ColorList[OtherAtom->nr] = lightgray;
3266 PredecessorList[OtherAtom->nr] = Walker; // Walker is the predecessor
3267 ShortestPathList[OtherAtom->nr] = ShortestPathList[Walker->nr]+1;
3268 *out << Verbose(2) << "Coloring OtherAtom " << OtherAtom->Name << " " << ((ColorList[OtherAtom->nr] == white) ? "white" : "lightgray") << ", its predecessor is " << Walker->Name << " and its Shortest Path is " << ShortestPathList[OtherAtom->nr] << " egde(s) long." << endl;
3269 if ((((ShortestPathList[OtherAtom->nr] < BondOrder) && (Binder != Bond))) ) { // Check for maximum distance
3270 *out << Verbose(3);
3271 if (AddedAtomList[OtherAtom->nr] == NULL) { // add if it's not been so far
3272 AddedAtomList[OtherAtom->nr] = Mol->AddCopyAtom(OtherAtom);
3273 *out << "Added OtherAtom " << OtherAtom->Name;
3274 AddedBondList[Binder->nr] = Mol->AddBond(AddedAtomList[Walker->nr], AddedAtomList[OtherAtom->nr], Binder->BondDegree);
3275 AddedBondList[Binder->nr]->Cyclic = Binder->Cyclic;
3276 AddedBondList[Binder->nr]->Type = Binder->Type;
3277 *out << " and bond " << *(AddedBondList[Binder->nr]) << ", ";
3278 } else { // this code should actually never come into play (all white atoms are not yet present in BondMolecule, that's why they are white in the first place)
3279 *out << "Not adding OtherAtom " << OtherAtom->Name;
3280 if (AddedBondList[Binder->nr] == NULL) {
3281 AddedBondList[Binder->nr] = Mol->AddBond(AddedAtomList[Walker->nr], AddedAtomList[OtherAtom->nr], Binder->BondDegree);
3282 AddedBondList[Binder->nr]->Cyclic = Binder->Cyclic;
3283 AddedBondList[Binder->nr]->Type = Binder->Type;
3284 *out << ", added Bond " << *(AddedBondList[Binder->nr]);
3285 } else
3286 *out << ", not added Bond ";
3287 }
3288 *out << ", putting OtherAtom into queue." << endl;
3289 AtomStack->Push(OtherAtom);
3290 } else { // out of bond order, then replace
3291 if ((AddedAtomList[OtherAtom->nr] == NULL) && (Binder->Cyclic))
3292 ColorList[OtherAtom->nr] = white; // unmark if it has not been queued/added, to make it available via its other bonds (cyclic)
3293 if (Binder == Bond)
3294 *out << Verbose(3) << "Not Queueing, is the Root bond";
3295 else if (ShortestPathList[OtherAtom->nr] >= BondOrder)
3296 *out << Verbose(3) << "Not Queueing, is out of Bond Count of " << BondOrder;
3297 if (!Binder->Cyclic)
3298 *out << ", is not part of a cyclic bond, saturating bond with Hydrogen." << endl;
3299 if (AddedBondList[Binder->nr] == NULL) {
3300 if ((AddedAtomList[OtherAtom->nr] != NULL)) { // .. whether we add or saturate
3301 AddedBondList[Binder->nr] = Mol->AddBond(AddedAtomList[Walker->nr], AddedAtomList[OtherAtom->nr], Binder->BondDegree);
3302 AddedBondList[Binder->nr]->Cyclic = Binder->Cyclic;
3303 AddedBondList[Binder->nr]->Type = Binder->Type;
3304 } else {
3305#ifdef ADDHYDROGEN
3306 Mol->AddHydrogenReplacementAtom(out, Binder, AddedAtomList[Walker->nr], Walker, OtherAtom, ListOfBondsPerAtom[Walker->nr], NumberOfBondsPerAtom[Walker->nr], IsAngstroem);
3307#endif
3308 }
3309 }
3310 }
3311 } else {
3312 *out << Verbose(3) << "Not Adding, has already been visited." << endl;
3313 // This has to be a cyclic bond, check whether it's present ...
3314 if (AddedBondList[Binder->nr] == NULL) {
3315 if ((Binder != Bond) && (Binder->Cyclic) && (((ShortestPathList[Walker->nr]+1) < BondOrder))) {
3316 AddedBondList[Binder->nr] = Mol->AddBond(AddedAtomList[Walker->nr], AddedAtomList[OtherAtom->nr], Binder->BondDegree);
3317 AddedBondList[Binder->nr]->Cyclic = Binder->Cyclic;
3318 AddedBondList[Binder->nr]->Type = Binder->Type;
3319 } else { // if it's root bond it has to broken (otherwise we would not create the fragments)
3320#ifdef ADDHYDROGEN
3321 Mol->AddHydrogenReplacementAtom(out, Binder, AddedAtomList[Walker->nr], Walker, OtherAtom, ListOfBondsPerAtom[Walker->nr], NumberOfBondsPerAtom[Walker->nr], IsAngstroem);
3322#endif
3323 }
3324 }
3325 }
3326 }
3327 }
3328 ColorList[Walker->nr] = black;
3329 *out << Verbose(1) << "Coloring Walker " << Walker->Name << " black." << endl;
3330 }
3331 Free((void **)&PredecessorList, "molecule::BreadthFirstSearchAdd: **PredecessorList");
3332 Free((void **)&ShortestPathList, "molecule::BreadthFirstSearchAdd: **ShortestPathList");
3333 Free((void **)&ColorList, "molecule::BreadthFirstSearchAdd: **ColorList");
3334 delete(AtomStack);
3335};
3336
3337/** Adds bond structure to this molecule from \a Father molecule.
3338 * This basically causes this molecule to become an induced subgraph of the \a Father, i.e. for every bond in Father
3339 * with end points present in this molecule, bond is created in this molecule.
3340 * Special care was taken to ensure that this is of complexity O(N), where N is the \a Father's molecule::AtomCount.
3341 * \param *out output stream for debugging
3342 * \param *Father father molecule
3343 * \return true - is induced subgraph, false - there are atoms with fathers not in \a Father
3344 * \todo not checked, not fully working probably
3345 */
3346bool molecule::BuildInducedSubgraph(ofstream *out, const molecule *Father)
3347{
3348 atom *Walker = NULL, *OtherAtom = NULL;
3349 bool status = true;
3350 atom **ParentList = (atom **) Malloc(sizeof(atom *)*Father->AtomCount, "molecule::BuildInducedSubgraph: **ParentList");
3351
3352 *out << Verbose(2) << "Begin of BuildInducedSubgraph." << endl;
3353
3354 // reset parent list
3355 *out << Verbose(3) << "Resetting ParentList." << endl;
3356 for (int i=Father->AtomCount;i--;)
3357 ParentList[i] = NULL;
3358
3359 // fill parent list with sons
3360 *out << Verbose(3) << "Filling Parent List." << endl;
3361 Walker = start;
3362 while (Walker->next != end) {
3363 Walker = Walker->next;
3364 ParentList[Walker->father->nr] = Walker;
3365 // Outputting List for debugging
3366 *out << Verbose(4) << "Son["<< Walker->father->nr <<"] of " << Walker->father << " is " << ParentList[Walker->father->nr] << "." << endl;
3367 }
3368
3369 // check each entry of parent list and if ok (one-to-and-onto matching) create bonds
3370 *out << Verbose(3) << "Creating bonds." << endl;
3371 Walker = Father->start;
3372 while (Walker->next != Father->end) {
3373 Walker = Walker->next;
3374 if (ParentList[Walker->nr] != NULL) {
3375 if (ParentList[Walker->nr]->father != Walker) {
3376 status = false;
3377 } else {
3378 for (int i=0;i<Father->NumberOfBondsPerAtom[Walker->nr];i++) {
3379 OtherAtom = Father->ListOfBondsPerAtom[Walker->nr][i]->GetOtherAtom(Walker);
3380 if (ParentList[OtherAtom->nr] != NULL) { // if otheratom is also a father of an atom on this molecule, create the bond
3381 *out << Verbose(4) << "Endpoints of Bond " << Father->ListOfBondsPerAtom[Walker->nr][i] << " are both present: " << ParentList[Walker->nr]->Name << " and " << ParentList[OtherAtom->nr]->Name << "." << endl;
3382 AddBond(ParentList[Walker->nr], ParentList[OtherAtom->nr], Father->ListOfBondsPerAtom[Walker->nr][i]->BondDegree);
3383 }
3384 }
3385 }
3386 }
3387 }
3388
3389 Free((void **)&ParentList, "molecule::BuildInducedSubgraph: **ParentList");
3390 *out << Verbose(2) << "End of BuildInducedSubgraph." << endl;
3391 return status;
3392};
3393
3394
3395/** Looks through a StackClass<atom *> and returns the likeliest removal candiate.
3396 * \param *out output stream for debugging messages
3397 * \param *&Leaf KeySet to look through
3398 * \param *&ShortestPathList list of the shortest path to decide which atom to suggest as removal candidate in the end
3399 * \param index of the atom suggested for removal
3400 */
3401int molecule::LookForRemovalCandidate(ofstream *&out, KeySet *&Leaf, int *&ShortestPathList)
3402{
3403 atom *Runner = NULL;
3404 int SP, Removal;
3405
3406 *out << Verbose(2) << "Looking for removal candidate." << endl;
3407 SP = -1; //0; // not -1, so that Root is never removed
3408 Removal = -1;
3409 for (KeySet::iterator runner = Leaf->begin(); runner != Leaf->end(); runner++) {
3410 Runner = FindAtom((*runner));
3411 if (Runner->type->Z != 1) { // skip all those added hydrogens when re-filling snake stack
3412 if (ShortestPathList[(*runner)] > SP) { // remove the oldest one with longest shortest path
3413 SP = ShortestPathList[(*runner)];
3414 Removal = (*runner);
3415 }
3416 }
3417 }
3418 return Removal;
3419};
3420
3421/** Stores a fragment from \a KeySet into \a molecule.
3422 * First creates the minimal set of atoms from the KeySet, then creates the bond structure from the complete
3423 * molecule and adds missing hydrogen where bonds were cut.
3424 * \param *out output stream for debugging messages
3425 * \param &Leaflet pointer to KeySet structure
3426 * \param IsAngstroem whether we have Ansgtroem or bohrradius
3427 * \return pointer to constructed molecule
3428 */
3429molecule * molecule::StoreFragmentFromKeySet(ofstream *out, KeySet &Leaflet, bool IsAngstroem)
3430{
3431 atom *Runner = NULL, *FatherOfRunner = NULL, *OtherFather = NULL;
3432 atom **SonList = (atom **) Malloc(sizeof(atom *)*AtomCount, "molecule::StoreFragmentFromStack: **SonList");
3433 molecule *Leaf = new molecule(elemente);
3434 bool LonelyFlag = false;
3435 int size;
3436
3437// *out << Verbose(1) << "Begin of StoreFragmentFromKeyset." << endl;
3438
3439 Leaf->BondDistance = BondDistance;
3440 for(int i=NDIM*2;i--;)
3441 Leaf->cell_size[i] = cell_size[i];
3442
3443 // initialise SonList (indicates when we need to replace a bond with hydrogen instead)
3444 for(int i=AtomCount;i--;)
3445 SonList[i] = NULL;
3446
3447 // first create the minimal set of atoms from the KeySet
3448 size = 0;
3449 for(KeySet::iterator runner = Leaflet.begin(); runner != Leaflet.end(); runner++) {
3450 FatherOfRunner = FindAtom((*runner)); // find the id
3451 SonList[FatherOfRunner->nr] = Leaf->AddCopyAtom(FatherOfRunner);
3452 size++;
3453 }
3454
3455 // create the bonds between all: Make it an induced subgraph and add hydrogen
3456// *out << Verbose(2) << "Creating bonds from father graph (i.e. induced subgraph creation)." << endl;
3457 Runner = Leaf->start;
3458 while (Runner->next != Leaf->end) {
3459 Runner = Runner->next;
3460 LonelyFlag = true;
3461 FatherOfRunner = Runner->father;
3462 if (SonList[FatherOfRunner->nr] != NULL) { // check if this, our father, is present in list
3463 // create all bonds
3464 for (int i=0;i<NumberOfBondsPerAtom[FatherOfRunner->nr];i++) { // go through every bond of father
3465 OtherFather = ListOfBondsPerAtom[FatherOfRunner->nr][i]->GetOtherAtom(FatherOfRunner);
3466// *out << Verbose(2) << "Father " << *FatherOfRunner << " of son " << *SonList[FatherOfRunner->nr] << " is bound to " << *OtherFather;
3467 if (SonList[OtherFather->nr] != NULL) {
3468// *out << ", whose son is " << *SonList[OtherFather->nr] << "." << endl;
3469 if (OtherFather->nr > FatherOfRunner->nr) { // add bond (nr check is for adding only one of both variants: ab, ba)
3470// *out << Verbose(3) << "Adding Bond: ";
3471// *out <<
3472 Leaf->AddBond(Runner, SonList[OtherFather->nr], ListOfBondsPerAtom[FatherOfRunner->nr][i]->BondDegree);
3473// *out << "." << endl;
3474 //NumBonds[Runner->nr]++;
3475 } else {
3476// *out << Verbose(3) << "Not adding bond, labels in wrong order." << endl;
3477 }
3478 LonelyFlag = false;
3479 } else {
3480// *out << ", who has no son in this fragment molecule." << endl;
3481#ifdef ADDHYDROGEN
3482 //*out << Verbose(3) << "Adding Hydrogen to " << Runner->Name << " and a bond in between." << endl;
3483 Leaf->AddHydrogenReplacementAtom(out, ListOfBondsPerAtom[FatherOfRunner->nr][i], Runner, FatherOfRunner, OtherFather, ListOfBondsPerAtom[FatherOfRunner->nr],NumberOfBondsPerAtom[FatherOfRunner->nr], IsAngstroem);
3484#endif
3485 //NumBonds[Runner->nr] += ListOfBondsPerAtom[FatherOfRunner->nr][i]->BondDegree;
3486 }
3487 }
3488 } else {
3489 *out << Verbose(0) << "ERROR: Son " << Runner->Name << " has father " << FatherOfRunner->Name << " but its entry in SonList is " << SonList[FatherOfRunner->nr] << "!" << endl;
3490 }
3491 if ((LonelyFlag) && (size > 1)) {
3492 *out << Verbose(0) << *Runner << "has got bonds only to hydrogens!" << endl;
3493 }
3494#ifdef ADDHYDROGEN
3495 while ((Runner->next != Leaf->end) && (Runner->next->type->Z == 1)) // skip added hydrogen
3496 Runner = Runner->next;
3497#endif
3498 }
3499 Leaf->CreateListOfBondsPerAtom(out);
3500 //Leaflet->Leaf->ScanForPeriodicCorrection(out);
3501 Free((void **)&SonList, "molecule::StoreFragmentFromStack: **SonList");
3502// *out << Verbose(1) << "End of StoreFragmentFromKeyset." << endl;
3503 return Leaf;
3504};
3505
3506/** Creates \a MoleculeListClass of all unique fragments of the \a molecule containing \a Order atoms or vertices.
3507 * The picture to have in mind is that of a DFS "snake" of a certain length \a Order, i.e. as in the infamous
3508 * computer game, that winds through the connected graph representing the molecule. Color (white,
3509 * lightgray, darkgray, black) indicates whether a vertex has been discovered so far or not. Labels will help in
3510 * creating only unique fragments and not additional ones with vertices simply in different sequence.
3511 * The Predecessor is always the one that came before in discovering, needed on backstepping. And
3512 * finally, the ShortestPath is needed for removing vertices from the snake stack during the back-
3513 * stepping.
3514 * \param *out output stream for debugging
3515 * \param Order number of atoms in each fragment
3516 * \param *configuration configuration for writing config files for each fragment
3517 * \return List of all unique fragments with \a Order atoms
3518 */
3519/*
3520MoleculeListClass * molecule::CreateListOfUniqueFragmentsOfOrder(ofstream *out, int Order, config *configuration)
3521{
3522 atom **PredecessorList = (atom **) Malloc(sizeof(atom *)*AtomCount, "molecule::CreateListOfUniqueFragmentsOfOrder: **PredecessorList");
3523 int *ShortestPathList = (int *) Malloc(sizeof(int)*AtomCount, "molecule::CreateListOfUniqueFragmentsOfOrder: *ShortestPathList");
3524 int *Labels = (int *) Malloc(sizeof(int)*AtomCount, "molecule::CreateListOfUniqueFragmentsOfOrder: *Labels");
3525 enum Shading *ColorVertexList = (enum Shading *) Malloc(sizeof(enum Shading)*AtomCount, "molecule::CreateListOfUniqueFragmentsOfOrder: *ColorList");
3526 enum Shading *ColorEdgeList = (enum Shading *) Malloc(sizeof(enum Shading)*BondCount, "molecule::CreateListOfUniqueFragmentsOfOrder: *ColorBondList");
3527 StackClass<atom *> *RootStack = new StackClass<atom *>(AtomCount);
3528 StackClass<atom *> *TouchedStack = new StackClass<atom *>((int)pow(4,Order)+2); // number of atoms reached from one with maximal 4 bonds plus Root itself
3529 StackClass<atom *> *SnakeStack = new StackClass<atom *>(Order+1); // equal to Order is not possible, as then the StackClass<atom *> cannot discern between full and empty stack!
3530 MoleculeLeafClass *Leaflet = NULL, *TempLeaf = NULL;
3531 MoleculeListClass *FragmentList = NULL;
3532 atom *Walker = NULL, *OtherAtom = NULL, *Root = NULL, *Removal = NULL;
3533 bond *Binder = NULL;
3534 int RunningIndex = 0, FragmentCounter = 0;
3535
3536 *out << Verbose(1) << "Begin of CreateListOfUniqueFragmentsOfOrder." << endl;
3537
3538 // reset parent list
3539 *out << Verbose(3) << "Resetting labels, parent, predecessor, color and shortest path lists." << endl;
3540 for (int i=0;i<AtomCount;i++) { // reset all atom labels
3541 // initialise each vertex as white with no predecessor, empty queue, color lightgray, not labelled, no sons
3542 Labels[i] = -1;
3543 SonList[i] = NULL;
3544 PredecessorList[i] = NULL;
3545 ColorVertexList[i] = white;
3546 ShortestPathList[i] = -1;
3547 }
3548 for (int i=0;i<BondCount;i++)
3549 ColorEdgeList[i] = white;
3550 RootStack->ClearStack(); // clearstack and push first atom if exists
3551 TouchedStack->ClearStack();
3552 Walker = start->next;
3553 while ((Walker != end)
3554#ifdef ADDHYDROGEN
3555 && (Walker->type->Z == 1)
3556#endif
3557 ) { // search for first non-hydrogen atom
3558 *out << Verbose(4) << "Current Root candidate is " << Walker->Name << "." << endl;
3559 Walker = Walker->next;
3560 }
3561 if (Walker != end)
3562 RootStack->Push(Walker);
3563 else
3564 *out << Verbose(0) << "ERROR: Could not find an appropriate Root atom!" << endl;
3565 *out << Verbose(3) << "Root " << Walker->Name << " is on AtomStack, beginning loop through all vertices ..." << endl;
3566
3567 ///// OUTER LOOP ////////////
3568 while (!RootStack->IsEmpty()) {
3569 // get new root vertex from atom stack
3570 Root = RootStack->PopFirst();
3571 ShortestPathList[Root->nr] = 0;
3572 if (Labels[Root->nr] == -1)
3573 Labels[Root->nr] = RunningIndex++; // prevent it from getting again on AtomStack
3574 PredecessorList[Root->nr] = Root;
3575 TouchedStack->Push(Root);
3576 *out << Verbose(0) << "Root for this loop is: " << Root->Name << ".\n";
3577
3578 // clear snake stack
3579 SnakeStack->ClearStack();
3580 //SnakeStack->TestImplementation(out, start->next);
3581
3582 ///// INNER LOOP ////////////
3583 // Problems:
3584 // - what about cyclic bonds?
3585 Walker = Root;
3586 do {
3587 *out << Verbose(1) << "Current Walker is: " << Walker->Name;
3588 // initial setting of the new Walker: label, color, shortest path and put on stacks
3589 if (Labels[Walker->nr] == -1) { // give atom a unique, monotonely increasing number
3590 Labels[Walker->nr] = RunningIndex++;
3591 RootStack->Push(Walker);
3592 }
3593 *out << ", has label " << Labels[Walker->nr];
3594 if ((ColorVertexList[Walker->nr] == white) || ((Binder != NULL) && (ColorEdgeList[Binder->nr] == white))) { // color it if newly discovered and push on stacks (and if within reach!)
3595 if ((Binder != NULL) && (ColorEdgeList[Binder->nr] == white)) {
3596 // Binder ought to be set still from last neighbour search
3597 *out << ", coloring bond " << *Binder << " black";
3598 ColorEdgeList[Binder->nr] = black; // mark this bond as used
3599 }
3600 if (ShortestPathList[Walker->nr] == -1) {
3601 ShortestPathList[Walker->nr] = ShortestPathList[PredecessorList[Walker->nr]->nr]+1;
3602 TouchedStack->Push(Walker); // mark every atom for lists cleanup later, whose shortest path has been changed
3603 }
3604 if ((ShortestPathList[Walker->nr] < Order) && (ColorVertexList[Walker->nr] != darkgray)) { // if not already on snake stack
3605 SnakeStack->Push(Walker);
3606 ColorVertexList[Walker->nr] = darkgray; // mark as dark gray of on snake stack
3607 }
3608 }
3609 *out << ", SP of " << ShortestPathList[Walker->nr] << " and its color is " << GetColor(ColorVertexList[Walker->nr]) << "." << endl;
3610
3611 // then check the stack for a newly stumbled upon fragment
3612 if (SnakeStack->ItemCount() == Order) { // is stack full?
3613 // store the fragment if it is one and get a removal candidate
3614 Removal = StoreFragmentFromStack(out, Root, Walker, Leaflet, SnakeStack, ShortestPathList, SonList, Labels, &FragmentCounter, configuration);
3615 // remove the candidate if one was found
3616 if (Removal != NULL) {
3617 *out << Verbose(2) << "Removing item " << Removal->Name << " with SP of " << ShortestPathList[Removal->nr] << " from snake stack." << endl;
3618 SnakeStack->RemoveItem(Removal);
3619 ColorVertexList[Removal->nr] = lightgray; // return back to not on snake stack but explored marking
3620 if (Walker == Removal) { // if the current atom is to be removed, we also have to take a step back
3621 Walker = PredecessorList[Removal->nr];
3622 *out << Verbose(2) << "Stepping back to " << Walker->Name << "." << endl;
3623 }
3624 }
3625 } else
3626 Removal = NULL;
3627
3628 // finally, look for a white neighbour as the next Walker
3629 Binder = NULL;
3630 if ((Removal == NULL) || (Walker != PredecessorList[Removal->nr])) { // don't look, if a new walker has been set above
3631 *out << Verbose(2) << "Snake has currently " << SnakeStack->ItemCount() << " item(s)." << endl;
3632 OtherAtom = NULL; // this is actually not needed, every atom has at least one neighbour
3633 if (ShortestPathList[Walker->nr] < Order) {
3634 for(int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++) {
3635 Binder = ListOfBondsPerAtom[Walker->nr][i];
3636 *out << Verbose(2) << "Current bond is " << *Binder << ": ";
3637 OtherAtom = Binder->GetOtherAtom(Walker);
3638 if ((Labels[OtherAtom->nr] != -1) && (Labels[OtherAtom->nr] < Labels[Root->nr])) { // we don't step up to labels bigger than us
3639 *out << "Label " << Labels[OtherAtom->nr] << " is smaller than Root's " << Labels[Root->nr] << "." << endl;
3640 //ColorVertexList[OtherAtom->nr] = lightgray; // mark as explored
3641 } else { // otherwise check its colour and element
3642 if (
3643#ifdef ADDHYDROGEN
3644 (OtherAtom->type->Z != 1) &&
3645#endif
3646 (ColorEdgeList[Binder->nr] == white)) { // skip hydrogen, look for unexplored vertices
3647 *out << "Moving along " << GetColor(ColorEdgeList[Binder->nr]) << " bond " << Binder << " to " << ((ColorVertexList[OtherAtom->nr] == white) ? "unexplored" : "explored") << " item: " << OtherAtom->Name << "." << endl;
3648 // i find it currently rather sensible to always set the predecessor in order to find one's way back
3649 //if (PredecessorList[OtherAtom->nr] == NULL) {
3650 PredecessorList[OtherAtom->nr] = Walker;
3651 *out << Verbose(3) << "Setting Predecessor of " << OtherAtom->Name << " to " << PredecessorList[OtherAtom->nr]->Name << "." << endl;
3652 //} else {
3653 // *out << Verbose(3) << "Predecessor of " << OtherAtom->Name << " is " << PredecessorList[OtherAtom->nr]->Name << "." << endl;
3654 //}
3655 Walker = OtherAtom;
3656 break;
3657 } else {
3658 if (OtherAtom->type->Z == 1)
3659 *out << "Links to a hydrogen atom." << endl;
3660 else
3661 *out << "Bond has not white but " << GetColor(ColorEdgeList[Binder->nr]) << " color." << endl;
3662 }
3663 }
3664 }
3665 } else { // means we have stepped beyond the horizon: Return!
3666 Walker = PredecessorList[Walker->nr];
3667 OtherAtom = Walker;
3668 *out << Verbose(3) << "We have gone too far, stepping back to " << Walker->Name << "." << endl;
3669 }
3670 if (Walker != OtherAtom) { // if no white neighbours anymore, color it black
3671 *out << Verbose(2) << "Coloring " << Walker->Name << " black." << endl;
3672 ColorVertexList[Walker->nr] = black;
3673 Walker = PredecessorList[Walker->nr];
3674 }
3675 }
3676 } while ((Walker != Root) || (ColorVertexList[Root->nr] != black));
3677 *out << Verbose(2) << "Inner Looping is finished." << endl;
3678
3679 // if we reset all AtomCount atoms, we have again technically O(N^2) ...
3680 *out << Verbose(2) << "Resetting lists." << endl;
3681 Walker = NULL;
3682 Binder = NULL;
3683 while (!TouchedStack->IsEmpty()) {
3684 Walker = TouchedStack->PopLast();
3685 *out << Verbose(3) << "Re-initialising entries of " << *Walker << "." << endl;
3686 for(int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++)
3687 ColorEdgeList[ListOfBondsPerAtom[Walker->nr][i]->nr] = white;
3688 PredecessorList[Walker->nr] = NULL;
3689 ColorVertexList[Walker->nr] = white;
3690 ShortestPathList[Walker->nr] = -1;
3691 }
3692 }
3693 *out << Verbose(1) << "Outer Looping over all vertices is done." << endl;
3694
3695 // copy together
3696 *out << Verbose(1) << "Copying all fragments into MoleculeList structure." << endl;
3697 FragmentList = new MoleculeListClass(FragmentCounter, AtomCount);
3698 RunningIndex = 0;
3699 while ((Leaflet != NULL) && (RunningIndex < FragmentCounter)) {
3700 FragmentList->ListOfMolecules[RunningIndex++] = Leaflet->Leaf;
3701 Leaflet->Leaf = NULL; // prevent molecule from being removed
3702 TempLeaf = Leaflet;
3703 Leaflet = Leaflet->previous;
3704 delete(TempLeaf);
3705 };
3706
3707 // free memory and exit
3708 Free((void **)&PredecessorList, "molecule::CreateListOfUniqueFragmentsOfOrder: **PredecessorList");
3709 Free((void **)&ShortestPathList, "molecule::CreateListOfUniqueFragmentsOfOrder: *ShortestPathList");
3710 Free((void **)&Labels, "molecule::CreateListOfUniqueFragmentsOfOrder: *Labels");
3711 Free((void **)&ColorVertexList, "molecule::CreateListOfUniqueFragmentsOfOrder: *ColorList");
3712 delete(RootStack);
3713 delete(TouchedStack);
3714 delete(SnakeStack);
3715
3716 *out << Verbose(1) << "End of CreateListOfUniqueFragmentsOfOrder." << endl;
3717 return FragmentList;
3718};
3719*/
3720
3721/** Structure containing all values in power set combination generation.
3722 */
3723struct UniqueFragments {
3724 config *configuration;
3725 atom *Root;
3726 Graph *Leaflet;
3727 KeySet *FragmentSet;
3728 int ANOVAOrder;
3729 int FragmentCounter;
3730 int CurrentIndex;
3731 double TEFactor;
3732 int *ShortestPathList;
3733 bool **UsedList;
3734 bond **BondsPerSPList;
3735 int *BondsPerSPCount;
3736};
3737
3738/** From a given set of Bond sorted by Shortest Path distance, create all possible fragments of size \a SetDimension.
3739 * -# loops over every possible combination (2^dimension of edge set)
3740 * -# inserts current set, if there's still space left
3741 * -# yes: calls SPFragmentGenerator with structure, created new edge list and size respective to root dist
3742ance+1
3743 * -# no: stores fragment into keyset list by calling InsertFragmentIntoGraph
3744 * -# removes all items added into the snake stack (in UniqueFragments structure) added during level (root
3745distance) and current set
3746 * \param *out output stream for debugging
3747 * \param FragmentSearch UniqueFragments structure with all values needed
3748 * \param RootDistance current shortest path level, whose set of edges is represented by **BondsSet
3749 * \param SetDimension Number of possible bonds on this level (i.e. size of the array BondsSet[])
3750 * \param SubOrder remaining number of allowed vertices to add
3751 */
3752void molecule::SPFragmentGenerator(ofstream *out, struct UniqueFragments *FragmentSearch, int RootDistance, bond **BondsSet, int SetDimension, int SubOrder)
3753{
3754 atom *OtherWalker = NULL;
3755 int verbosity = 0; //FragmentSearch->ANOVAOrder-SubOrder;
3756 int NumCombinations;
3757 bool bit;
3758 int bits, TouchedIndex, SubSetDimension, SP, Added;
3759 int Removal;
3760 int SpaceLeft;
3761 int *TouchedList = (int *) Malloc(sizeof(int)*(SubOrder+1), "molecule::SPFragmentGenerator: *TouchedList");
3762 bond *Binder = NULL;
3763 bond **BondsList = NULL;
3764 KeySetTestPair TestKeySetInsert;
3765
3766 NumCombinations = 1 << SetDimension;
3767
3768 // Hier muessen von 1 bis NumberOfBondsPerAtom[Walker->nr] alle Kombinationen
3769 // von Endstuecken (aus den Bonds) hinzugefᅵᅵgt werden und fᅵᅵr verbleibende ANOVAOrder
3770 // rekursiv GraphCrawler in der nᅵᅵchsten Ebene aufgerufen werden
3771
3772 *out << Verbose(1+verbosity) << "Begin of SPFragmentGenerator." << endl;
3773 *out << Verbose(1+verbosity) << "We are " << RootDistance << " away from Root, which is " << *FragmentSearch->Root << ", SubOrder is " << SubOrder << ", SetDimension is " << SetDimension << " and this means " << NumCombinations-1 << " combination(s)." << endl;
3774
3775 // initialised touched list (stores added atoms on this level)
3776 *out << Verbose(1+verbosity) << "Clearing touched list." << endl;
3777 for (TouchedIndex=SubOrder+1;TouchedIndex--;) // empty touched list
3778 TouchedList[TouchedIndex] = -1;
3779 TouchedIndex = 0;
3780
3781 // create every possible combination of the endpieces
3782 *out << Verbose(1+verbosity) << "Going through all combinations of the power set." << endl;
3783 for (int i=1;i<NumCombinations;i++) { // sweep through all power set combinations (skip empty set!)
3784 // count the set bit of i
3785 bits = 0;
3786 for (int j=SetDimension;j--;)
3787 bits += (i & (1 << j)) >> j;
3788
3789 *out << Verbose(1+verbosity) << "Current set is " << Binary(i | (1 << SetDimension)) << ", number of bits is " << bits << "." << endl;
3790 if (bits <= SubOrder) { // if not greater than additional atoms allowed on stack, continue
3791 // --1-- add this set of the power set of bond partners to the snake stack
3792 Added = 0;
3793 for (int j=0;j<SetDimension;j++) { // pull out every bit by shifting
3794 bit = ((i & (1 << j)) != 0); // mask the bit for the j-th bond
3795 if (bit) { // if bit is set, we add this bond partner
3796 OtherWalker = BondsSet[j]->rightatom; // rightatom is always the one more distant, i.e. the one to add
3797 //*out << Verbose(1+verbosity) << "Current Bond is " << ListOfBondsPerAtom[Walker->nr][i] << ", checking on " << *OtherWalker << "." << endl;
3798 *out << Verbose(2+verbosity) << "Adding " << *OtherWalker << " with nr " << OtherWalker->nr << "." << endl;
3799 TestKeySetInsert = FragmentSearch->FragmentSet->insert(OtherWalker->nr);
3800 if (TestKeySetInsert.second) {
3801 TouchedList[TouchedIndex++] = OtherWalker->nr; // note as added
3802 Added++;
3803 } else {
3804 *out << Verbose(2+verbosity) << "This was item was already present in the keyset." << endl;
3805 }
3806 //FragmentSearch->UsedList[OtherWalker->nr][i] = true;
3807 //}
3808 } else {
3809 *out << Verbose(2+verbosity) << "Not adding." << endl;
3810 }
3811 }
3812
3813 SpaceLeft = SubOrder - Added ;// SubOrder - bits; // due to item's maybe being already present, this does not work anymore
3814 if (SpaceLeft > 0) {
3815 *out << Verbose(1+verbosity) << "There's still some space left on stack: " << SpaceLeft << "." << endl;
3816 if (SubOrder > 1) { // Due to Added above we have to check extra whether we're not already reaching beyond the desired Order
3817 // --2-- look at all added end pieces of this combination, construct bond subsets and sweep through a power set of these by recursion
3818 SP = RootDistance+1; // this is the next level
3819 // first count the members in the subset
3820 SubSetDimension = 0;
3821 Binder = FragmentSearch->BondsPerSPList[2*SP]; // start node for this level
3822 while (Binder->next != FragmentSearch->BondsPerSPList[2*SP+1]) { // compare to end node of this level
3823 Binder = Binder->next;
3824 for (int k=TouchedIndex;k--;) {
3825 if (Binder->Contains(TouchedList[k])) // if we added this very endpiece
3826 SubSetDimension++;
3827 }
3828 }
3829 // then allocate and fill the list
3830 BondsList = (bond **) Malloc(sizeof(bond *)*SubSetDimension, "molecule::SPFragmentGenerator: **BondsList");
3831 SubSetDimension = 0;
3832 Binder = FragmentSearch->BondsPerSPList[2*SP];
3833 while (Binder->next != FragmentSearch->BondsPerSPList[2*SP+1]) {
3834 Binder = Binder->next;
3835 for (int k=0;k<TouchedIndex;k++) {
3836 if (Binder->leftatom->nr == TouchedList[k]) // leftatom is always the close one
3837 BondsList[SubSetDimension++] = Binder;
3838 }
3839 }
3840 *out << Verbose(2+verbosity) << "Calling subset generator " << SP << " away from root " << *FragmentSearch->Root << " with sub set dimension " << SubSetDimension << "." << endl;
3841 SPFragmentGenerator(out, FragmentSearch, SP, BondsList, SubSetDimension, SubOrder-bits);
3842 Free((void **)&BondsList, "molecule::SPFragmentGenerator: **BondsList");
3843 }
3844 } else {
3845 // --2-- otherwise store the complete fragment
3846 *out << Verbose(1+verbosity) << "Enough items on stack for a fragment!" << endl;
3847 // store fragment as a KeySet
3848 *out << Verbose(2) << "Found a new fragment[" << FragmentSearch->FragmentCounter << "], local nr.s are: ";
3849 for(KeySet::iterator runner = FragmentSearch->FragmentSet->begin(); runner != FragmentSearch->FragmentSet->end(); runner++)
3850 *out << (*runner) << " ";
3851 *out << endl;
3852 //if (!CheckForConnectedSubgraph(out, FragmentSearch->FragmentSet))
3853 //*out << Verbose(0) << "ERROR: The found fragment is not a connected subgraph!" << endl;
3854 InsertFragmentIntoGraph(out, FragmentSearch);
3855 //Removal = LookForRemovalCandidate(out, FragmentSearch->FragmentSet, FragmentSearch->ShortestPathList);
3856 //Removal = StoreFragmentFromStack(out, FragmentSearch->Root, FragmentSearch->Leaflet, FragmentSearch->FragmentStack, FragmentSearch->ShortestPathList, &FragmentSearch->FragmentCounter, FragmentSearch->configuration);
3857 }
3858
3859 // --3-- remove all added items in this level from snake stack
3860 *out << Verbose(1+verbosity) << "Removing all items that were added on this SP level " << RootDistance << "." << endl;
3861 for(int j=0;j<TouchedIndex;j++) {
3862 Removal = TouchedList[j];
3863 *out << Verbose(2+verbosity) << "Removing item nr. " << Removal << " from snake stack." << endl;
3864 FragmentSearch->FragmentSet->erase(Removal);
3865 TouchedList[j] = -1;
3866 }
3867 *out << Verbose(2) << "Remaining local nr.s on snake stack are: ";
3868 for(KeySet::iterator runner = FragmentSearch->FragmentSet->begin(); runner != FragmentSearch->FragmentSet->end(); runner++)
3869 *out << (*runner) << " ";
3870 *out << endl;
3871 TouchedIndex = 0; // set Index to 0 for list of atoms added on this level
3872 } else {
3873 *out << Verbose(2+verbosity) << "More atoms to add for this set (" << bits << ") than space left on stack " << SubOrder << ", skipping this set." << endl;
3874 }
3875 }
3876 Free((void **)&TouchedList, "molecule::SPFragmentGenerator: *TouchedList");
3877 *out << Verbose(1+verbosity) << "End of SPFragmentGenerator, " << RootDistance << " away from Root " << *FragmentSearch->Root << " and SubOrder is " << SubOrder << "." << endl;
3878};
3879
3880/** For a given keyset \a *Fragment, checks whether it is connected in the current molecule.
3881 * \param *out output stream for debugging
3882 * \param *Fragment Keyset of fragment's vertices
3883 * \return true - connected, false - disconnected
3884 * \note this is O(n^2) for it's just a bug checker not meant for permanent use!
3885 */
3886bool molecule::CheckForConnectedSubgraph(ofstream *out, KeySet *Fragment)
3887{
3888 atom *Walker = NULL, *Walker2 = NULL;
3889 bool BondStatus = false;
3890 int size;
3891
3892 *out << Verbose(1) << "Begin of CheckForConnectedSubgraph" << endl;
3893 *out << Verbose(2) << "Disconnected atom: ";
3894
3895 // count number of atoms in graph
3896 size = 0;
3897 for(KeySet::iterator runner = Fragment->begin(); runner != Fragment->end(); runner++)
3898 size++;
3899 if (size > 1)
3900 for(KeySet::iterator runner = Fragment->begin(); runner != Fragment->end(); runner++) {
3901 Walker = FindAtom(*runner);
3902 BondStatus = false;
3903 for(KeySet::iterator runners = Fragment->begin(); runners != Fragment->end(); runners++) {
3904 Walker2 = FindAtom(*runners);
3905 for (int i=0;i<NumberOfBondsPerAtom[Walker->nr]; i++) {
3906 if (ListOfBondsPerAtom[Walker->nr][i]->GetOtherAtom(Walker) == Walker2) {
3907 BondStatus = true;
3908 break;
3909 }
3910 if (BondStatus)
3911 break;
3912 }
3913 }
3914 if (!BondStatus) {
3915 *out << (*Walker) << endl;
3916 return false;
3917 }
3918 }
3919 else {
3920 *out << "none." << endl;
3921 return true;
3922 }
3923 *out << "none." << endl;
3924
3925 *out << Verbose(1) << "End of CheckForConnectedSubgraph" << endl;
3926
3927 return true;
3928}
3929
3930/** Creates a list of all unique fragments of certain vertex size from a given graph \a Fragment for a given root vertex in the context of \a this molecule.
3931 * -# initialises UniqueFragments structure
3932 * -# fills edge list via BFS
3933 * -# creates the fragment by calling recursive function SPFragmentGenerator with UniqueFragments structure, 0 as
3934 root distance, the edge set, its dimension and the current suborder
3935 * -# Free'ing structure
3936 * Note that we may use the fact that the atoms are SP-ordered on the atomstack. I.e. when popping always the last, we first get all
3937 * with SP of 2, then those with SP of 3, then those with SP of 4 and so on.
3938 * \param *out output stream for debugging
3939 * \param Order bond order (limits BFS exploration and "number of digits" in power set generation
3940 * \param FragmentSearch UniqueFragments structure containing TEFactor, root atom and so on
3941 * \param RestrictedKeySet Restricted vertex set to use in context of molecule
3942 * \return number of inserted fragments
3943 * \note ShortestPathList in FragmentSearch structure is probably due to NumberOfAtomsSPLevel and SP not needed anymore
3944 */
3945int molecule::PowerSetGenerator(ofstream *out, int Order, struct UniqueFragments &FragmentSearch, KeySet RestrictedKeySet)
3946{
3947 int SP, AtomKeyNr;
3948 atom *Walker = NULL, *OtherWalker = NULL, *Predecessor = NULL;
3949 bond *Binder = NULL;
3950 bond *CurrentEdge = NULL;
3951 bond **BondsList = NULL;
3952 int RootKeyNr = FragmentSearch.Root->GetTrueFather()->nr;
3953 int Counter = FragmentSearch.FragmentCounter;
3954 int RemainingWalkers;
3955
3956 *out << endl;
3957 *out << Verbose(0) << "Begin of PowerSetGenerator with order " << Order << " at Root " << *FragmentSearch.Root << "." << endl;
3958
3959 // prepare Label and SP arrays of the BFS search
3960 FragmentSearch.ShortestPathList[FragmentSearch.Root->nr] = 0;
3961
3962 // prepare root level (SP = 0) and a loop bond denoting Root
3963 for (int i=1;i<Order;i++)
3964 FragmentSearch.BondsPerSPCount[i] = 0;
3965 FragmentSearch.BondsPerSPCount[0] = 1;
3966 Binder = new bond(FragmentSearch.Root, FragmentSearch.Root);
3967 add(Binder, FragmentSearch.BondsPerSPList[1]);
3968
3969 // do a BFS search to fill the SP lists and label the found vertices
3970 // Actually, we should construct a spanning tree vom the root atom and select all edges therefrom and put them into
3971 // according shortest path lists. However, we don't. Rather we fill these lists right away, as they do form a spanning
3972 // tree already sorted into various SP levels. That's why we just do loops over the depth (CurrentSP) and breadth
3973 // (EdgeinSPLevel) of this tree ...
3974 // In another picture, the bonds always contain a direction by rightatom being the one more distant from root and hence
3975 // naturally leftatom forming its predecessor, preventing the BFS"seeker" from continuing in the wrong direction.
3976 *out << endl;
3977 *out << Verbose(0) << "Starting BFS analysis ..." << endl;
3978 for (SP = 0; SP < (Order-1); SP++) {
3979 *out << Verbose(1) << "New SP level reached: " << SP << ", creating new SP list with " << FragmentSearch.BondsPerSPCount[SP] << " item(s)";
3980 if (SP > 0) {
3981 *out << ", old level closed with " << FragmentSearch.BondsPerSPCount[SP-1] << " item(s)." << endl;
3982 FragmentSearch.BondsPerSPCount[SP] = 0;
3983 } else
3984 *out << "." << endl;
3985
3986 RemainingWalkers = FragmentSearch.BondsPerSPCount[SP];
3987 CurrentEdge = FragmentSearch.BondsPerSPList[2*SP]; /// start of this SP level's list
3988 while (CurrentEdge->next != FragmentSearch.BondsPerSPList[2*SP+1]) { /// end of this SP level's list
3989 CurrentEdge = CurrentEdge->next;
3990 RemainingWalkers--;
3991 Walker = CurrentEdge->rightatom; // rightatom is always the one more distant
3992 Predecessor = CurrentEdge->leftatom; // ... and leftatom is predecessor
3993 AtomKeyNr = Walker->nr;
3994 *out << Verbose(0) << "Current Walker is: " << *Walker << " with nr " << Walker->nr << " and SP of " << SP << ", with " << RemainingWalkers << " remaining walkers on this level." << endl;
3995 // check for new sp level
3996 // go through all its bonds
3997 *out << Verbose(1) << "Going through all bonds of Walker." << endl;
3998 for (int i=0;i<NumberOfBondsPerAtom[AtomKeyNr];i++) {
3999 Binder = ListOfBondsPerAtom[AtomKeyNr][i];
4000 OtherWalker = Binder->GetOtherAtom(Walker);
4001 if ((RestrictedKeySet.find(OtherWalker->nr) != RestrictedKeySet.end())
4002 #ifdef ADDHYDROGEN
4003 && (OtherWalker->type->Z != 1)
4004 #endif
4005 ) { // skip hydrogens and restrict to fragment
4006 *out << Verbose(2) << "Current partner is " << *OtherWalker << " with nr " << OtherWalker->nr << " in bond " << *Binder << "." << endl;
4007 // set the label if not set (and push on root stack as well)
4008 if ((OtherWalker != Predecessor) && (OtherWalker->GetTrueFather()->nr > RootKeyNr)) { // only pass through those with label bigger than Root's
4009 FragmentSearch.ShortestPathList[OtherWalker->nr] = SP+1;
4010 *out << Verbose(3) << "Set Shortest Path to " << FragmentSearch.ShortestPathList[OtherWalker->nr] << "." << endl;
4011 // add the bond in between to the SP list
4012 Binder = new bond(Walker, OtherWalker); // create a new bond in such a manner, that bond::rightatom is always the one more distant
4013 add(Binder, FragmentSearch.BondsPerSPList[2*(SP+1)+1]);
4014 FragmentSearch.BondsPerSPCount[SP+1]++;
4015 *out << Verbose(3) << "Added its bond to SP list, having now " << FragmentSearch.BondsPerSPCount[SP+1] << " item(s)." << endl;
4016 } else {
4017 if (OtherWalker != Predecessor)
4018 *out << Verbose(3) << "Not passing on, as index of " << *OtherWalker << " " << OtherWalker->GetTrueFather()->nr << " is smaller than that of Root " << RootKeyNr << "." << endl;
4019 else
4020 *out << Verbose(3) << "This is my predecessor " << *Predecessor << "." << endl;
4021 }
4022 } else *out << Verbose(2) << "Is not in the restricted keyset or skipping hydrogen " << *OtherWalker << "." << endl;
4023 }
4024 }
4025 }
4026
4027 // outputting all list for debugging
4028 *out << Verbose(0) << "Printing all found lists." << endl;
4029 for(int i=1;i<Order;i++) { // skip the root edge in the printing
4030 Binder = FragmentSearch.BondsPerSPList[2*i];
4031 *out << Verbose(1) << "Current SP level is " << i << "." << endl;
4032 while (Binder->next != FragmentSearch.BondsPerSPList[2*i+1]) {
4033 Binder = Binder->next;
4034 *out << Verbose(2) << *Binder << endl;
4035 }
4036 }
4037
4038 // creating fragments with the found edge sets (may be done in reverse order, faster)
4039 SP = -1; // the Root <-> Root edge must be subtracted!
4040 for(int i=Order;i--;) { // sum up all found edges
4041 Binder = FragmentSearch.BondsPerSPList[2*i];
4042 while (Binder->next != FragmentSearch.BondsPerSPList[2*i+1]) {
4043 Binder = Binder->next;
4044 SP ++;
4045 }
4046 }
4047 *out << Verbose(0) << "Total number of edges is " << SP << "." << endl;
4048 if (SP >= (Order-1)) {
4049 // start with root (push on fragment stack)
4050 *out << Verbose(0) << "Starting fragment generation with " << *FragmentSearch.Root << ", local nr is " << FragmentSearch.Root->nr << "." << endl;
4051 FragmentSearch.FragmentSet->clear();
4052 *out << Verbose(0) << "Preparing subset for this root and calling generator." << endl;
4053 // prepare the subset and call the generator
4054 BondsList = (bond **) Malloc(sizeof(bond *)*FragmentSearch.BondsPerSPCount[0], "molecule::PowerSetGenerator: **BondsList");
4055 BondsList[0] = FragmentSearch.BondsPerSPList[0]->next; // on SP level 0 there's only the root bond
4056
4057 SPFragmentGenerator(out, &FragmentSearch, 0, BondsList, FragmentSearch.BondsPerSPCount[0], Order);
4058
4059 Free((void **)&BondsList, "molecule::PowerSetGenerator: **BondsList");
4060 } else {
4061 *out << Verbose(0) << "Not enough total number of edges to build " << Order << "-body fragments." << endl;
4062 }
4063
4064 // as FragmentSearch structure is used only once, we don't have to clean it anymore
4065 // remove root from stack
4066 *out << Verbose(0) << "Removing root again from stack." << endl;
4067 FragmentSearch.FragmentSet->erase(FragmentSearch.Root->nr);
4068
4069 // free'ing the bonds lists
4070 *out << Verbose(0) << "Free'ing all found lists. and resetting index lists" << endl;
4071 for(int i=Order;i--;) {
4072 *out << Verbose(1) << "Current SP level is " << i << ": ";
4073 Binder = FragmentSearch.BondsPerSPList[2*i];
4074 while (Binder->next != FragmentSearch.BondsPerSPList[2*i+1]) {
4075 Binder = Binder->next;
4076 // *out << "Removing atom " << Binder->leftatom->nr << " and " << Binder->rightatom->nr << "." << endl; // make sure numbers are local
4077 FragmentSearch.ShortestPathList[Binder->leftatom->nr] = -1;
4078 FragmentSearch.ShortestPathList[Binder->rightatom->nr] = -1;
4079 }
4080 // delete added bonds
4081 cleanup(FragmentSearch.BondsPerSPList[2*i], FragmentSearch.BondsPerSPList[2*i+1]);
4082 // also start and end node
4083 *out << "cleaned." << endl;
4084 }
4085
4086 // return list
4087 *out << Verbose(0) << "End of PowerSetGenerator." << endl;
4088 return (FragmentSearch.FragmentCounter - Counter);
4089};
4090
4091/** Corrects the nuclei position if the fragment was created over the cell borders.
4092 * Scans all bonds, checks the distance, if greater than typical, we have a candidate for the correction.
4093 * We remove the bond whereafter the graph probably separates. Then, we translate the one component periodically
4094 * and re-add the bond. Looping on the distance check.
4095 * \param *out ofstream for debugging messages
4096 */
4097void molecule::ScanForPeriodicCorrection(ofstream *out)
4098{
4099 bond *Binder = NULL;
4100 bond *OtherBinder = NULL;
4101 atom *Walker = NULL;
4102 atom *OtherWalker = NULL;
4103 double *matrix = ReturnFullMatrixforSymmetric(cell_size);
4104 enum Shading *ColorList = NULL;
4105 double tmp;
4106 Vector Translationvector;
4107 //class StackClass<atom *> *CompStack = NULL;
4108 class StackClass<atom *> *AtomStack = new StackClass<atom *>(AtomCount);
4109 bool flag = true;
4110
4111 *out << Verbose(2) << "Begin of ScanForPeriodicCorrection." << endl;
4112
4113 ColorList = (enum Shading *) Malloc(sizeof(enum Shading)*AtomCount, "molecule::ScanForPeriodicCorrection: *ColorList");
4114 while (flag) {
4115 // remove bonds that are beyond bonddistance
4116 for(int i=NDIM;i--;)
4117 Translationvector.x[i] = 0.;
4118 // scan all bonds
4119 Binder = first;
4120 flag = false;
4121 while ((!flag) && (Binder->next != last)) {
4122 Binder = Binder->next;
4123 for (int i=NDIM;i--;) {
4124 tmp = fabs(Binder->leftatom->x.x[i] - Binder->rightatom->x.x[i]);
4125 //*out << Verbose(3) << "Checking " << i << "th distance of " << *Binder->leftatom << " to " << *Binder->rightatom << ": " << tmp << "." << endl;
4126 if (tmp > BondDistance) {
4127 OtherBinder = Binder->next; // note down binding partner for later re-insertion
4128 unlink(Binder); // unlink bond
4129 *out << Verbose(2) << "Correcting at bond " << *Binder << "." << endl;
4130 flag = true;
4131 break;
4132 }
4133 }
4134 }
4135 if (flag) {
4136 // create translation vector from their periodically modified distance
4137 for (int i=NDIM;i--;) {
4138 tmp = Binder->leftatom->x.x[i] - Binder->rightatom->x.x[i];
4139 if (fabs(tmp) > BondDistance)
4140 Translationvector.x[i] = (tmp < 0) ? +1. : -1.;
4141 }
4142 Translationvector.MatrixMultiplication(matrix);
4143 //*out << Verbose(3) << "Translation vector is ";
4144 Translationvector.Output(out);
4145 *out << endl;
4146 // apply to all atoms of first component via BFS
4147 for (int i=AtomCount;i--;)
4148 ColorList[i] = white;
4149 AtomStack->Push(Binder->leftatom);
4150 while (!AtomStack->IsEmpty()) {
4151 Walker = AtomStack->PopFirst();
4152 //*out << Verbose (3) << "Current Walker is: " << *Walker << "." << endl;
4153 ColorList[Walker->nr] = black; // mark as explored
4154 Walker->x.AddVector(&Translationvector); // translate
4155 for (int i=0;i<NumberOfBondsPerAtom[Walker->nr];i++) { // go through all binding partners
4156 if (ListOfBondsPerAtom[Walker->nr][i] != Binder) {
4157 OtherWalker = ListOfBondsPerAtom[Walker->nr][i]->GetOtherAtom(Walker);
4158 if (ColorList[OtherWalker->nr] == white) {
4159 AtomStack->Push(OtherWalker); // push if yet unexplored
4160 }
4161 }
4162 }
4163 }
4164 // re-add bond
4165 link(Binder, OtherBinder);
4166 } else {
4167 *out << Verbose(3) << "No corrections for this fragment." << endl;
4168 }
4169 //delete(CompStack);
4170 }
4171
4172 // free allocated space from ReturnFullMatrixforSymmetric()
4173 delete(AtomStack);
4174 Free((void **)&ColorList, "molecule::ScanForPeriodicCorrection: *ColorList");
4175 Free((void **)&matrix, "molecule::ScanForPeriodicCorrection: *matrix");
4176 *out << Verbose(2) << "End of ScanForPeriodicCorrection." << endl;
4177};
4178
4179/** Blows the 6-dimensional \a cell_size array up to a full NDIM by NDIM matrix.
4180 * \param *symm 6-dim array of unique symmetric matrix components
4181 * \return allocated NDIM*NDIM array with the symmetric matrix
4182 */
4183double * molecule::ReturnFullMatrixforSymmetric(double *symm)
4184{
4185 double *matrix = (double *) Malloc(sizeof(double)*NDIM*NDIM, "molecule::ReturnFullMatrixforSymmetric: *matrix");
4186 matrix[0] = symm[0];
4187 matrix[1] = symm[1];
4188 matrix[2] = symm[3];
4189 matrix[3] = symm[1];
4190 matrix[4] = symm[2];
4191 matrix[5] = symm[4];
4192 matrix[6] = symm[3];
4193 matrix[7] = symm[4];
4194 matrix[8] = symm[5];
4195 return matrix;
4196};
4197
4198bool KeyCompare::operator() (const KeySet SubgraphA, const KeySet SubgraphB) const
4199{
4200 //cout << "my check is used." << endl;
4201 if (SubgraphA.size() < SubgraphB.size()) {
4202 return true;
4203 } else {
4204 if (SubgraphA.size() > SubgraphB.size()) {
4205 return false;
4206 } else {
4207 KeySet::iterator IteratorA = SubgraphA.begin();
4208 KeySet::iterator IteratorB = SubgraphB.begin();
4209 while ((IteratorA != SubgraphA.end()) && (IteratorB != SubgraphB.end())) {
4210 if ((*IteratorA) < (*IteratorB))
4211 return true;
4212 else if ((*IteratorA) > (*IteratorB)) {
4213 return false;
4214 } // else, go on to next index
4215 IteratorA++;
4216 IteratorB++;
4217 } // end of while loop
4218 }// end of check in case of equal sizes
4219 }
4220 return false; // if we reach this point, they are equal
4221};
4222
4223//bool operator < (KeySet SubgraphA, KeySet SubgraphB)
4224//{
4225// return KeyCompare(SubgraphA, SubgraphB);
4226//};
4227
4228/** Checking whether KeySet is not already present in Graph, if so just adds factor.
4229 * \param *out output stream for debugging
4230 * \param &set KeySet to insert
4231 * \param &graph Graph to insert into
4232 * \param *counter pointer to unique fragment count
4233 * \param factor energy factor for the fragment
4234 */
4235inline void InsertFragmentIntoGraph(ofstream *out, struct UniqueFragments *Fragment)
4236{
4237 GraphTestPair testGraphInsert;
4238
4239 testGraphInsert = Fragment->Leaflet->insert(GraphPair (*Fragment->FragmentSet,pair<int,double>(Fragment->FragmentCounter,Fragment->TEFactor))); // store fragment number and current factor
4240 if (testGraphInsert.second) {
4241 *out << Verbose(2) << "KeySet " << Fragment->FragmentCounter << " successfully inserted." << endl;
4242 Fragment->FragmentCounter++;
4243 } else {
4244 *out << Verbose(2) << "KeySet " << Fragment->FragmentCounter << " failed to insert, present fragment is " << ((*(testGraphInsert.first)).second).first << endl;
4245 ((*(testGraphInsert.first)).second).second += Fragment->TEFactor; // increase the "created" counter
4246 *out << Verbose(2) << "New factor is " << ((*(testGraphInsert.first)).second).second << "." << endl;
4247 }
4248};
4249//void inline InsertIntoGraph(ofstream *out, KeyStack &stack, Graph &graph, int *counter, double factor)
4250//{
4251// // copy stack contents to set and call overloaded function again
4252// KeySet set;
4253// for(KeyStack::iterator runner = stack.begin(); runner != stack.begin(); runner++)
4254// set.insert((*runner));
4255// InsertIntoGraph(out, set, graph, counter, factor);
4256//};
4257
4258/** Inserts each KeySet in \a graph2 into \a graph1.
4259 * \param *out output stream for debugging
4260 * \param graph1 first (dest) graph
4261 * \param graph2 second (source) graph
4262 * \param *counter keyset counter that gets increased
4263 */
4264inline void InsertGraphIntoGraph(ofstream *out, Graph &graph1, Graph &graph2, int *counter)
4265{
4266 GraphTestPair testGraphInsert;
4267
4268 for(Graph::iterator runner = graph2.begin(); runner != graph2.end(); runner++) {
4269 testGraphInsert = graph1.insert(GraphPair ((*runner).first,pair<int,double>((*counter)++,((*runner).second).second))); // store fragment number and current factor
4270 if (testGraphInsert.second) {
4271 *out << Verbose(2) << "KeySet " << (*counter)-1 << " successfully inserted." << endl;
4272 } else {
4273 *out << Verbose(2) << "KeySet " << (*counter)-1 << " failed to insert, present fragment is " << ((*(testGraphInsert.first)).second).first << endl;
4274 ((*(testGraphInsert.first)).second).second += (*runner).second.second;
4275 *out << Verbose(2) << "New factor is " << (*(testGraphInsert.first)).second.second << "." << endl;
4276 }
4277 }
4278};
4279
4280
4281/** Performs BOSSANOVA decomposition at selected sites, increasing the cutoff by one at these sites.
4282 * -# constructs a complete keyset of the molecule
4283 * -# In a loop over all possible roots from the given rootstack
4284 * -# increases order of root site
4285 * -# calls PowerSetGenerator with this order, the complete keyset and the rootkeynr
4286 * -# for all consecutive lower levels PowerSetGenerator is called with the suborder, the higher order keyset
4287as the restricted one and each site in the set as the root)
4288 * -# these are merged into a fragment list of keysets
4289 * -# All fragment lists (for all orders, i.e. from all destination fields) are merged into one list for return
4290 * Important only is that we create all fragments, it is not important if we create them more than once
4291 * as these copies are filtered out via use of the hash table (KeySet).
4292 * \param *out output stream for debugging
4293 * \param Fragment&*List list of already present keystacks (adaptive scheme) or empty list
4294 * \param &RootStack stack with all root candidates (unequal to each atom in complete molecule if adaptive scheme is applied)
4295 * \param *MinimumRingSize minimum ring size for each atom (molecule::Atomcount)
4296 * \return pointer to Graph list
4297 */
4298void molecule::FragmentBOSSANOVA(ofstream *out, Graph *&FragmentList, KeyStack &RootStack, int *MinimumRingSize)
4299{
4300 Graph ***FragmentLowerOrdersList = NULL;
4301 int NumLevels, NumMolecules, TotalNumMolecules = 0, *NumMoleculesOfOrder = NULL;
4302 int counter = 0, Order;
4303 int UpgradeCount = RootStack.size();
4304 KeyStack FragmentRootStack;
4305 int RootKeyNr, RootNr;
4306 struct UniqueFragments FragmentSearch;
4307
4308 *out << Verbose(0) << "Begin of FragmentBOSSANOVA." << endl;
4309
4310 // FragmentLowerOrdersList is a 2D-array of pointer to MoleculeListClass objects, one dimension represents the ANOVA expansion of a single order (i.e. 5)
4311 // with all needed lower orders that are subtracted, the other dimension is the BondOrder (i.e. from 1 to 5)
4312 NumMoleculesOfOrder = (int *) Malloc(sizeof(int)*UpgradeCount, "molecule::FragmentBOSSANOVA: *NumMoleculesOfOrder");
4313 FragmentLowerOrdersList = (Graph ***) Malloc(sizeof(Graph **)*UpgradeCount, "molecule::FragmentBOSSANOVA: ***FragmentLowerOrdersList");
4314
4315 // initialise the fragments structure
4316 FragmentSearch.ShortestPathList = (int *) Malloc(sizeof(int)*AtomCount, "molecule::PowerSetGenerator: *ShortestPathList");
4317 FragmentSearch.FragmentCounter = 0;
4318 FragmentSearch.FragmentSet = new KeySet;
4319 FragmentSearch.Root = FindAtom(RootKeyNr);
4320 for (int i=AtomCount;i--;) {
4321 FragmentSearch.ShortestPathList[i] = -1;
4322 }
4323
4324 // Construct the complete KeySet which we need for topmost level only (but for all Roots)
4325 atom *Walker = start;
4326 KeySet CompleteMolecule;
4327 while (Walker->next != end) {
4328 Walker = Walker->next;
4329 CompleteMolecule.insert(Walker->GetTrueFather()->nr);
4330 }
4331
4332 // this can easily be seen: if Order is 5, then the number of levels for each lower order is the total sum of the number of levels above, as
4333 // each has to be split up. E.g. for the second level we have one from 5th, one from 4th, two from 3th (which in turn is one from 5th, one from 4th),
4334 // hence we have overall four 2th order levels for splitting. This also allows for putting all into a single array (FragmentLowerOrdersList[])
4335 // with the order along the cells as this: 5433222211111111 for BondOrder 5 needing 16=pow(2,5-1) cells (only we use bit-shifting which is faster)
4336 RootNr = 0; // counts through the roots in RootStack
4337 while ((RootNr < UpgradeCount) && (!RootStack.empty())) {
4338 RootKeyNr = RootStack.front();
4339 RootStack.pop_front();
4340 Walker = FindAtom(RootKeyNr);
4341 // check cyclic lengths
4342 //if ((MinimumRingSize[Walker->GetTrueFather()->nr] != -1) && (Walker->GetTrueFather()->AdaptiveOrder+1 > MinimumRingSize[Walker->GetTrueFather()->nr])) {
4343 // *out << Verbose(0) << "Bond order " << Walker->GetTrueFather()->AdaptiveOrder << " of Root " << *Walker << " greater than or equal to Minimum Ring size of " << MinimumRingSize << " found is not allowed." << endl;
4344 //} else
4345 {
4346 // increase adaptive order by one
4347 Walker->GetTrueFather()->AdaptiveOrder++;
4348 Order = Walker->AdaptiveOrder = Walker->GetTrueFather()->AdaptiveOrder;
4349
4350 // initialise Order-dependent entries of UniqueFragments structure
4351 FragmentSearch.BondsPerSPList = (bond **) Malloc(sizeof(bond *)*Order*2, "molecule::PowerSetGenerator: ***BondsPerSPList");
4352 FragmentSearch.BondsPerSPCount = (int *) Malloc(sizeof(int)*Order, "molecule::PowerSetGenerator: *BondsPerSPCount");
4353 for (int i=Order;i--;) {
4354 FragmentSearch.BondsPerSPList[2*i] = new bond(); // start node
4355 FragmentSearch.BondsPerSPList[2*i+1] = new bond(); // end node
4356 FragmentSearch.BondsPerSPList[2*i]->next = FragmentSearch.BondsPerSPList[2*i+1]; // intertwine these two
4357 FragmentSearch.BondsPerSPList[2*i+1]->previous = FragmentSearch.BondsPerSPList[2*i];
4358 FragmentSearch.BondsPerSPCount[i] = 0;
4359 }
4360
4361 // allocate memory for all lower level orders in this 1D-array of ptrs
4362 NumLevels = 1 << (Order-1); // (int)pow(2,Order);
4363 FragmentLowerOrdersList[RootNr] = (Graph **) Malloc(sizeof(Graph *)*NumLevels, "molecule::FragmentBOSSANOVA: **FragmentLowerOrdersList[]");
4364 for (int i=0;i<NumLevels;i++)
4365 FragmentLowerOrdersList[RootNr][i] = NULL;
4366
4367 // create top order where nothing is reduced
4368 *out << Verbose(0) << "==============================================================================================================" << endl;
4369 *out << Verbose(0) << "Creating KeySets of Bond Order " << Order << " for " << *Walker << ", " << (RootStack.size()-RootNr) << " Roots remaining." << endl; // , NumLevels is " << NumLevels << "
4370
4371 // Create list of Graphs of current Bond Order (i.e. F_{ij})
4372 FragmentLowerOrdersList[RootNr][0] = new Graph;
4373 FragmentSearch.TEFactor = 1.;
4374 FragmentSearch.Leaflet = FragmentLowerOrdersList[RootNr][0]; // set to insertion graph
4375 FragmentSearch.Root = Walker;
4376 NumMoleculesOfOrder[RootNr] = PowerSetGenerator(out, Walker->AdaptiveOrder, FragmentSearch, CompleteMolecule);
4377 *out << Verbose(1) << "Number of resulting KeySets is: " << NumMoleculesOfOrder[RootNr] << "." << endl;
4378 if (NumMoleculesOfOrder[RootNr] != 0) {
4379 NumMolecules = 0;
4380
4381 // we don't have to dive into suborders! These keysets are all already created on lower orders!
4382 // this was all ancient stuff, when we still depended on the TEFactors (and for those the suborders were needed)
4383
4384// if ((NumLevels >> 1) > 0) {
4385// // create lower order fragments
4386// *out << Verbose(0) << "Creating list of unique fragments of lower Bond Order terms to be subtracted." << endl;
4387// Order = Walker->AdaptiveOrder;
4388// for (int source=0;source<(NumLevels >> 1);source++) { // 1-terms don't need any more splitting, that's why only half is gone through (shift again)
4389// // step down to next order at (virtual) boundary of powers of 2 in array
4390// while (source >= (1 << (Walker->AdaptiveOrder-Order))) // (int)pow(2,Walker->AdaptiveOrder-Order))
4391// Order--;
4392// *out << Verbose(0) << "Current Order is: " << Order << "." << endl;
4393// for (int SubOrder=Order-1;SubOrder>0;SubOrder--) {
4394// int dest = source + (1 << (Walker->AdaptiveOrder-(SubOrder+1)));
4395// *out << Verbose(0) << "--------------------------------------------------------------------------------------------------------------" << endl;
4396// *out << Verbose(0) << "Current SubOrder is: " << SubOrder << " with source " << source << " to destination " << dest << "." << endl;
4397//
4398// // every molecule is split into a list of again (Order - 1) molecules, while counting all molecules
4399// //*out << Verbose(1) << "Splitting the " << (*FragmentLowerOrdersList[RootNr][source]).size() << " molecules of the " << source << "th cell in the array." << endl;
4400// //NumMolecules = 0;
4401// FragmentLowerOrdersList[RootNr][dest] = new Graph;
4402// for(Graph::iterator runner = (*FragmentLowerOrdersList[RootNr][source]).begin();runner != (*FragmentLowerOrdersList[RootNr][source]).end(); runner++) {
4403// for (KeySet::iterator sprinter = (*runner).first.begin();sprinter != (*runner).first.end(); sprinter++) {
4404// Graph TempFragmentList;
4405// FragmentSearch.TEFactor = -(*runner).second.second;
4406// FragmentSearch.Leaflet = &TempFragmentList; // set to insertion graph
4407// FragmentSearch.Root = FindAtom(*sprinter);
4408// NumMoleculesOfOrder[RootNr] += PowerSetGenerator(out, SubOrder, FragmentSearch, (*runner).first);
4409// // insert new keysets FragmentList into FragmentLowerOrdersList[Walker->AdaptiveOrder-1][dest]
4410// *out << Verbose(1) << "Merging resulting key sets with those present in destination " << dest << "." << endl;
4411// InsertGraphIntoGraph(out, *FragmentLowerOrdersList[RootNr][dest], TempFragmentList, &NumMolecules);
4412// }
4413// }
4414// *out << Verbose(1) << "Number of resulting molecules for SubOrder " << SubOrder << " is: " << NumMolecules << "." << endl;
4415// }
4416// }
4417// }
4418 } else {
4419 Walker->GetTrueFather()->MaxOrder = true;
4420// *out << Verbose(1) << "Hence, we don't dive into SubOrders ... " << endl;
4421 }
4422 // now, we have completely filled each cell of FragmentLowerOrdersList[] for the current Walker->AdaptiveOrder
4423 //NumMoleculesOfOrder[Walker->AdaptiveOrder-1] = NumMolecules;
4424 TotalNumMolecules += NumMoleculesOfOrder[RootNr];
4425// *out << Verbose(1) << "Number of resulting molecules for Order " << (int)Walker->GetTrueFather()->AdaptiveOrder << " is: " << NumMoleculesOfOrder[RootNr] << "." << endl;
4426 RootStack.push_back(RootKeyNr); // put back on stack
4427 RootNr++;
4428
4429 // free Order-dependent entries of UniqueFragments structure for next loop cycle
4430 Free((void **)&FragmentSearch.BondsPerSPCount, "molecule::PowerSetGenerator: *BondsPerSPCount");
4431 for (int i=Order;i--;) {
4432 delete(FragmentSearch.BondsPerSPList[2*i]);
4433 delete(FragmentSearch.BondsPerSPList[2*i+1]);
4434 }
4435 Free((void **)&FragmentSearch.BondsPerSPList, "molecule::PowerSetGenerator: ***BondsPerSPList");
4436 }
4437 }
4438 *out << Verbose(0) << "==============================================================================================================" << endl;
4439 *out << Verbose(1) << "Total number of resulting molecules is: " << TotalNumMolecules << "." << endl;
4440 *out << Verbose(0) << "==============================================================================================================" << endl;
4441
4442 // cleanup FragmentSearch structure
4443 Free((void **)&FragmentSearch.ShortestPathList, "molecule::PowerSetGenerator: *ShortestPathList");
4444 delete(FragmentSearch.FragmentSet);
4445
4446 // now, FragmentLowerOrdersList is complete, it looks - for BondOrder 5 - as this (number is the ANOVA Order of the terms therein)
4447 // 5433222211111111
4448 // 43221111
4449 // 3211
4450 // 21
4451 // 1
4452
4453 // Subsequently, we combine all into a single list (FragmentList)
4454
4455 *out << Verbose(0) << "Combining the lists of all orders per order and finally into a single one." << endl;
4456 if (FragmentList == NULL) {
4457 FragmentList = new Graph;
4458 counter = 0;
4459 } else {
4460 counter = FragmentList->size();
4461 }
4462 RootNr = 0;
4463 while (!RootStack.empty()) {
4464 RootKeyNr = RootStack.front();
4465 RootStack.pop_front();
4466 Walker = FindAtom(RootKeyNr);
4467 NumLevels = 1 << (Walker->AdaptiveOrder - 1);
4468 for(int i=0;i<NumLevels;i++) {
4469 if (FragmentLowerOrdersList[RootNr][i] != NULL) {
4470 InsertGraphIntoGraph(out, *FragmentList, (*FragmentLowerOrdersList[RootNr][i]), &counter);
4471 delete(FragmentLowerOrdersList[RootNr][i]);
4472 }
4473 }
4474 Free((void **)&FragmentLowerOrdersList[RootNr], "molecule::FragmentBOSSANOVA: **FragmentLowerOrdersList[]");
4475 RootNr++;
4476 }
4477 Free((void **)&FragmentLowerOrdersList, "molecule::FragmentBOSSANOVA: ***FragmentLowerOrdersList");
4478 Free((void **)&NumMoleculesOfOrder, "molecule::FragmentBOSSANOVA: *NumMoleculesOfOrder");
4479
4480 *out << Verbose(0) << "End of FragmentBOSSANOVA." << endl;
4481};
4482
4483/** Comparison function for GSL heapsort on distances in two molecules.
4484 * \param *a
4485 * \param *b
4486 * \return <0, \a *a less than \a *b, ==0 if equal, >0 \a *a greater than \a *b
4487 */
4488inline int CompareDoubles (const void * a, const void * b)
4489{
4490 if (*(double *)a > *(double *)b)
4491 return -1;
4492 else if (*(double *)a < *(double *)b)
4493 return 1;
4494 else
4495 return 0;
4496};
4497
4498/** Determines whether two molecules actually contain the same atoms and coordination.
4499 * \param *out output stream for debugging
4500 * \param *OtherMolecule the molecule to compare this one to
4501 * \param threshold upper limit of difference when comparing the coordination.
4502 * \return NULL - not equal, otherwise an allocated (molecule::AtomCount) permutation map of the atom numbers (which corresponds to which)
4503 */
4504int * molecule::IsEqualToWithinThreshold(ofstream *out, molecule *OtherMolecule, double threshold)
4505{
4506 int flag;
4507 double *Distances = NULL, *OtherDistances = NULL;
4508 Vector CenterOfGravity, OtherCenterOfGravity;
4509 size_t *PermMap = NULL, *OtherPermMap = NULL;
4510 int *PermutationMap = NULL;
4511 atom *Walker = NULL;
4512 bool result = true; // status of comparison
4513
4514 *out << Verbose(3) << "Begin of IsEqualToWithinThreshold." << endl;
4515 /// first count both their atoms and elements and update lists thereby ...
4516 //*out << Verbose(0) << "Counting atoms, updating list" << endl;
4517 CountAtoms(out);
4518 OtherMolecule->CountAtoms(out);
4519 CountElements();
4520 OtherMolecule->CountElements();
4521
4522 /// ... and compare:
4523 /// -# AtomCount
4524 if (result) {
4525 if (AtomCount != OtherMolecule->AtomCount) {
4526 *out << Verbose(4) << "AtomCounts don't match: " << AtomCount << " == " << OtherMolecule->AtomCount << endl;
4527 result = false;
4528 } else *out << Verbose(4) << "AtomCounts match: " << AtomCount << " == " << OtherMolecule->AtomCount << endl;
4529 }
4530 /// -# ElementCount
4531 if (result) {
4532 if (ElementCount != OtherMolecule->ElementCount) {
4533 *out << Verbose(4) << "ElementCount don't match: " << ElementCount << " == " << OtherMolecule->ElementCount << endl;
4534 result = false;
4535 } else *out << Verbose(4) << "ElementCount match: " << ElementCount << " == " << OtherMolecule->ElementCount << endl;
4536 }
4537 /// -# ElementsInMolecule
4538 if (result) {
4539 for (flag=MAX_ELEMENTS;flag--;) {
4540 //*out << Verbose(5) << "Element " << flag << ": " << ElementsInMolecule[flag] << " <-> " << OtherMolecule->ElementsInMolecule[flag] << "." << endl;
4541 if (ElementsInMolecule[flag] != OtherMolecule->ElementsInMolecule[flag])
4542 break;
4543 }
4544 if (flag < MAX_ELEMENTS) {
4545 *out << Verbose(4) << "ElementsInMolecule don't match." << endl;
4546 result = false;
4547 } else *out << Verbose(4) << "ElementsInMolecule match." << endl;
4548 }
4549 /// then determine and compare center of gravity for each molecule ...
4550 if (result) {
4551 *out << Verbose(5) << "Calculating Centers of Gravity" << endl;
4552 DetermineCenter(CenterOfGravity);
4553 OtherMolecule->DetermineCenter(OtherCenterOfGravity);
4554 *out << Verbose(5) << "Center of Gravity: ";
4555 CenterOfGravity.Output(out);
4556 *out << endl << Verbose(5) << "Other Center of Gravity: ";
4557 OtherCenterOfGravity.Output(out);
4558 *out << endl;
4559 if (CenterOfGravity.Distance(&OtherCenterOfGravity) > threshold) {
4560 *out << Verbose(4) << "Centers of gravity don't match." << endl;
4561 result = false;
4562 }
4563 }
4564
4565 /// ... then make a list with the euclidian distance to this center for each atom of both molecules
4566 if (result) {
4567 *out << Verbose(5) << "Calculating distances" << endl;
4568 Distances = (double *) Malloc(sizeof(double)*AtomCount, "molecule::IsEqualToWithinThreshold: Distances");
4569 OtherDistances = (double *) Malloc(sizeof(double)*AtomCount, "molecule::IsEqualToWithinThreshold: OtherDistances");
4570 Walker = start;
4571 while (Walker->next != end) {
4572 Walker = Walker->next;
4573 Distances[Walker->nr] = CenterOfGravity.Distance(&Walker->x);
4574 }
4575 Walker = OtherMolecule->start;
4576 while (Walker->next != OtherMolecule->end) {
4577 Walker = Walker->next;
4578 OtherDistances[Walker->nr] = OtherCenterOfGravity.Distance(&Walker->x);
4579 }
4580
4581 /// ... sort each list (using heapsort (o(N log N)) from GSL)
4582 *out << Verbose(5) << "Sorting distances" << endl;
4583 PermMap = (size_t *) Malloc(sizeof(size_t)*AtomCount, "molecule::IsEqualToWithinThreshold: *PermMap");
4584 OtherPermMap = (size_t *) Malloc(sizeof(size_t)*AtomCount, "molecule::IsEqualToWithinThreshold: *OtherPermMap");
4585 gsl_heapsort_index (PermMap, Distances, AtomCount, sizeof(double), CompareDoubles);
4586 gsl_heapsort_index (OtherPermMap, OtherDistances, AtomCount, sizeof(double), CompareDoubles);
4587 PermutationMap = (int *) Malloc(sizeof(int)*AtomCount, "molecule::IsEqualToWithinThreshold: *PermutationMap");
4588 *out << Verbose(5) << "Combining Permutation Maps" << endl;
4589 for(int i=AtomCount;i--;)
4590 PermutationMap[PermMap[i]] = (int) OtherPermMap[i];
4591
4592 /// ... and compare them step by step, whether the difference is individiually(!) below \a threshold for all
4593 *out << Verbose(4) << "Comparing distances" << endl;
4594 flag = 0;
4595 for (int i=0;i<AtomCount;i++) {
4596 *out << Verbose(5) << "Distances: |" << Distances[PermMap[i]] << " - " << OtherDistances[OtherPermMap[i]] << "| = " << fabs(Distances[PermMap[i]] - OtherDistances[OtherPermMap[i]]) << " ?<? " << threshold << endl;
4597 if (fabs(Distances[PermMap[i]] - OtherDistances[OtherPermMap[i]]) > threshold)
4598 flag = 1;
4599 }
4600 Free((void **)&PermMap, "molecule::IsEqualToWithinThreshold: *PermMap");
4601 Free((void **)&OtherPermMap, "molecule::IsEqualToWithinThreshold: *OtherPermMap");
4602
4603 /// free memory
4604 Free((void **)&Distances, "molecule::IsEqualToWithinThreshold: Distances");
4605 Free((void **)&OtherDistances, "molecule::IsEqualToWithinThreshold: OtherDistances");
4606 if (flag) { // if not equal
4607 Free((void **)&PermutationMap, "molecule::IsEqualToWithinThreshold: *PermutationMap");
4608 result = false;
4609 }
4610 }
4611 /// return pointer to map if all distances were below \a threshold
4612 *out << Verbose(3) << "End of IsEqualToWithinThreshold." << endl;
4613 if (result) {
4614 *out << Verbose(3) << "Result: Equal." << endl;
4615 return PermutationMap;
4616 } else {
4617 *out << Verbose(3) << "Result: Not equal." << endl;
4618 return NULL;
4619 }
4620};
4621
4622/** Returns an index map for two father-son-molecules.
4623 * The map tells which atom in this molecule corresponds to which one in the other molecul with their fathers.
4624 * \param *out output stream for debugging
4625 * \param *OtherMolecule corresponding molecule with fathers
4626 * \return allocated map of size molecule::AtomCount with map
4627 * \todo make this with a good sort O(n), not O(n^2)
4628 */
4629int * molecule::GetFatherSonAtomicMap(ofstream *out, molecule *OtherMolecule)
4630{
4631 atom *Walker = NULL, *OtherWalker = NULL;
4632 *out << Verbose(3) << "Begin of GetFatherAtomicMap." << endl;
4633 int *AtomicMap = (int *) Malloc(sizeof(int)*AtomCount, "molecule::GetAtomicMap: *AtomicMap"); //Calloc
4634 for (int i=AtomCount;i--;)
4635 AtomicMap[i] = -1;
4636 if (OtherMolecule == this) { // same molecule
4637 for (int i=AtomCount;i--;) // no need as -1 means already that there is trivial correspondence
4638 AtomicMap[i] = i;
4639 *out << Verbose(4) << "Map is trivial." << endl;
4640 } else {
4641 *out << Verbose(4) << "Map is ";
4642 Walker = start;
4643 while (Walker->next != end) {
4644 Walker = Walker->next;
4645 if (Walker->father == NULL) {
4646 AtomicMap[Walker->nr] = -2;
4647 } else {
4648 OtherWalker = OtherMolecule->start;
4649 while (OtherWalker->next != OtherMolecule->end) {
4650 OtherWalker = OtherWalker->next;
4651 //for (int i=0;i<AtomCount;i++) { // search atom
4652 //for (int j=0;j<OtherMolecule->AtomCount;j++) {
4653 //*out << Verbose(4) << "Comparing father " << Walker->father << " with the other one " << OtherWalker->father << "." << endl;
4654 if (Walker->father == OtherWalker)
4655 AtomicMap[Walker->nr] = OtherWalker->nr;
4656 }
4657 }
4658 *out << AtomicMap[Walker->nr] << "\t";
4659 }
4660 *out << endl;
4661 }
4662 *out << Verbose(3) << "End of GetFatherAtomicMap." << endl;
4663 return AtomicMap;
4664};
4665
4666/** Stores the temperature evaluated from velocities in molecule::Trajectories.
4667 * We simply use the formula equivaleting temperature and kinetic energy:
4668 * \f$k_B T = \sum_i m_i v_i^2\f$
4669 * \param *out output stream for debugging
4670 * \param startstep first MD step in molecule::Trajectories
4671 * \param endstep last plus one MD step in molecule::Trajectories
4672 * \param *output output stream of temperature file
4673 * \return file written (true), failure on writing file (false)
4674 */
4675bool molecule::OutputTemperatureFromTrajectories(ofstream *out, int startstep, int endstep, ofstream *output)
4676{
4677 double temperature;
4678 atom *Walker = NULL;
4679 // test stream
4680 if (output == NULL)
4681 return false;
4682 else
4683 *output << "# Step Temperature [K] Temperature [a.u.]" << endl;
4684 for (int step=startstep;step < endstep; step++) { // loop over all time steps
4685 temperature = 0.;
4686 Walker = start;
4687 while (Walker->next != end) {
4688 Walker = Walker->next;
4689 for (int i=NDIM;i--;)
4690 temperature += Walker->type->mass * Trajectories[Walker].U.at(step).x[i]* Trajectories[Walker].U.at(step).x[i];
4691 }
4692 *output << step << "\t" << temperature*AtomicEnergyToKelvin << "\t" << temperature << endl;
4693 }
4694 return true;
4695};
Note: See TracBrowser for help on using the repository browser.