| 1 | /*
 | 
|---|
| 2 |  * Project: MoleCuilder
 | 
|---|
| 3 |  * Description: creates and alters molecular systems
 | 
|---|
| 4 |  * Copyright (C)  2010-2012 University of Bonn. All rights reserved.
 | 
|---|
| 5 |  * 
 | 
|---|
| 6 |  *
 | 
|---|
| 7 |  *   This file is part of MoleCuilder.
 | 
|---|
| 8 |  *
 | 
|---|
| 9 |  *    MoleCuilder is free software: you can redistribute it and/or modify
 | 
|---|
| 10 |  *    it under the terms of the GNU General Public License as published by
 | 
|---|
| 11 |  *    the Free Software Foundation, either version 2 of the License, or
 | 
|---|
| 12 |  *    (at your option) any later version.
 | 
|---|
| 13 |  *
 | 
|---|
| 14 |  *    MoleCuilder is distributed in the hope that it will be useful,
 | 
|---|
| 15 |  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
|---|
| 16 |  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
|---|
| 17 |  *    GNU General Public License for more details.
 | 
|---|
| 18 |  *
 | 
|---|
| 19 |  *    You should have received a copy of the GNU General Public License
 | 
|---|
| 20 |  *    along with MoleCuilder.  If not, see <http://www.gnu.org/licenses/>.
 | 
|---|
| 21 |  */
 | 
|---|
| 22 | 
 | 
|---|
| 23 | /*
 | 
|---|
| 24 |  * FillRegularGridAction.cpp
 | 
|---|
| 25 |  *
 | 
|---|
| 26 |  *  Created on: Jan 12, 2012
 | 
|---|
| 27 |  *      Author: heber
 | 
|---|
| 28 |  */
 | 
|---|
| 29 | 
 | 
|---|
| 30 | // include config.h
 | 
|---|
| 31 | #ifdef HAVE_CONFIG_H
 | 
|---|
| 32 | #include <config.h>
 | 
|---|
| 33 | #endif
 | 
|---|
| 34 | 
 | 
|---|
| 35 | #include "CodePatterns/MemDebug.hpp"
 | 
|---|
| 36 | 
 | 
|---|
| 37 | #include "Actions/UndoRedoHelpers.hpp"
 | 
|---|
| 38 | #include "Atom/atom.hpp"
 | 
|---|
| 39 | #include "Atom/AtomicInfo.hpp"
 | 
|---|
| 40 | #include "Atom/CopyAtoms/CopyAtoms_withBonds.hpp"
 | 
|---|
| 41 | #include "Bond/BondInfo.hpp"
 | 
|---|
| 42 | #include "CodePatterns/Log.hpp"
 | 
|---|
| 43 | #include "Descriptors/MoleculeOrderDescriptor.hpp"
 | 
|---|
| 44 | #include "Filling/Cluster.hpp"
 | 
|---|
| 45 | #include "Filling/Filler.hpp"
 | 
|---|
| 46 | #include "Filling/Preparators/BoxFillerPreparator.hpp"
 | 
|---|
| 47 | #include "molecule.hpp"
 | 
|---|
| 48 | #include "Parser/FormatParserInterface.hpp"
 | 
|---|
| 49 | #include "Parser/FormatParserStorage.hpp"
 | 
|---|
| 50 | #include "World.hpp"
 | 
|---|
| 51 | 
 | 
|---|
| 52 | #include <algorithm>
 | 
|---|
| 53 | #include <iostream>
 | 
|---|
| 54 | #include <string>
 | 
|---|
| 55 | #include <vector>
 | 
|---|
| 56 | 
 | 
|---|
| 57 | #include "Actions/FillAction/FillRegularGridAction.hpp"
 | 
|---|
| 58 | 
 | 
|---|
| 59 | using namespace MoleCuilder;
 | 
|---|
| 60 | 
 | 
|---|
| 61 | // and construct the stuff
 | 
|---|
| 62 | #include "FillRegularGridAction.def"
 | 
|---|
| 63 | #include "Action_impl_pre.hpp"
 | 
|---|
| 64 | /** =========== define the function ====================== */
 | 
|---|
| 65 | ActionState::ptr FillRegularGridAction::performCall() {
 | 
|---|
| 66 |   // get the filler molecule
 | 
|---|
| 67 |   std::vector<AtomicInfo> movedatoms;
 | 
|---|
| 68 |   const std::vector< molecule *> molecules = World::getInstance().getSelectedMolecules();
 | 
|---|
| 69 |   if (molecules.size() != 1) {
 | 
|---|
| 70 |     STATUS("No exactly one molecule selected, aborting,");
 | 
|---|
| 71 |     return Action::failure;
 | 
|---|
| 72 |   }
 | 
|---|
| 73 |   molecule *filler = *(molecules.begin());
 | 
|---|
| 74 |   for(molecule::const_iterator iter = const_cast<const molecule *>(filler)->begin();
 | 
|---|
| 75 |       iter != const_cast<const molecule *>(filler)->end(); ++iter)
 | 
|---|
| 76 |     movedatoms.push_back( AtomicInfo(*(*iter)) );
 | 
|---|
| 77 |   LOG(1, "INFO: Chosen molecule has " << filler->size() << " atoms.");
 | 
|---|
| 78 | 
 | 
|---|
| 79 |   // center filler's tip at origin
 | 
|---|
| 80 |   filler->CenterEdge();
 | 
|---|
| 81 | 
 | 
|---|
| 82 |   // prepare the filler preparator
 | 
|---|
| 83 |   BoxFillerPreparator filler_preparator(filler);
 | 
|---|
| 84 |   if (params.SphereRadius.get() != 0.) {
 | 
|---|
| 85 |     if (World::getInstance().beginAtomSelection() == World::getInstance().endAtomSelection()) {
 | 
|---|
| 86 |       STATUS("You have given a sphere radius "+toString(params.SphereRadius.get())
 | 
|---|
| 87 |           +" != 0, but have not select any atoms.");
 | 
|---|
| 88 |       return Action::failure;
 | 
|---|
| 89 |     }
 | 
|---|
| 90 |     std::vector<atom*> atoms(World::getInstance().getSelectedAtoms());
 | 
|---|
| 91 |     filler_preparator.addSurfacePredicate(
 | 
|---|
| 92 |         params.SphereRadius.get(),
 | 
|---|
| 93 |         atoms,
 | 
|---|
| 94 |         params.mindistance.get());
 | 
|---|
| 95 |   }
 | 
|---|
| 96 |   filler_preparator.addVoidPredicate(params.mindistance.get());
 | 
|---|
| 97 |   filler_preparator.addRandomInserter(
 | 
|---|
| 98 |       params.RandAtomDisplacement.get(),
 | 
|---|
| 99 |       params.RandMoleculeDisplacement.get(),
 | 
|---|
| 100 |       params.DoRotate.get());
 | 
|---|
| 101 |   filler_preparator.addCubeMesh(
 | 
|---|
| 102 |       params.counts.get(),
 | 
|---|
| 103 |       params.offset.get(),
 | 
|---|
| 104 |       World::getInstance().getDomain().getM());
 | 
|---|
| 105 |   if (!filler_preparator()) {
 | 
|---|
| 106 |     STATUS("Filler was not fully constructed.");
 | 
|---|
| 107 |     return Action::failure;
 | 
|---|
| 108 |   }
 | 
|---|
| 109 | 
 | 
|---|
| 110 |   // use filler
 | 
|---|
| 111 |   bool successflag = false;
 | 
|---|
| 112 |   FillRegularGridState *UndoState = NULL;
 | 
|---|
| 113 |   {
 | 
|---|
| 114 |     // fill
 | 
|---|
| 115 |     Filler *fillerFunction = filler_preparator.obtainFiller();
 | 
|---|
| 116 |     // TODO: When molecule::getBoundingSphere() does not use a sphere anymore,
 | 
|---|
| 117 |     // we need to check whether we rotate the molecule randomly. For this to
 | 
|---|
| 118 |     // work we need a sphere!
 | 
|---|
| 119 |     const Shape s = filler->getBoundingSphere(params.RandAtomDisplacement.get());
 | 
|---|
| 120 |     ClusterInterface::Cluster_impl cluster( new Cluster(filler->getAtomIds(), s) );
 | 
|---|
| 121 |     CopyAtoms_withBonds copyMethod;
 | 
|---|
| 122 |     Filler::ClusterVector_t ClonedClusters;
 | 
|---|
| 123 |     successflag = (*fillerFunction)(copyMethod, cluster, ClonedClusters);
 | 
|---|
| 124 |     delete fillerFunction;
 | 
|---|
| 125 | 
 | 
|---|
| 126 |     // append each cluster's atoms to clonedatoms (however not selected ones)
 | 
|---|
| 127 |     std::vector<const atom *> clonedatoms;
 | 
|---|
| 128 |     std::vector<AtomicInfo> clonedatominfos;
 | 
|---|
| 129 |     for (Filler::ClusterVector_t::const_iterator iter = ClonedClusters.begin();
 | 
|---|
| 130 |         iter != ClonedClusters.end(); ++iter) {
 | 
|---|
| 131 |       const AtomIdSet &atoms = (*iter)->getAtomIds();
 | 
|---|
| 132 |       clonedatoms.reserve(clonedatoms.size()+atoms.size());
 | 
|---|
| 133 |       for (AtomIdSet::const_iterator atomiter = atoms.begin(); atomiter != atoms.end(); ++atomiter)
 | 
|---|
| 134 |         if (!filler->containsAtom(*atomiter)) {
 | 
|---|
| 135 |           clonedatoms.push_back( *atomiter );
 | 
|---|
| 136 |           clonedatominfos.push_back( AtomicInfo(*(*atomiter)) );
 | 
|---|
| 137 |         }
 | 
|---|
| 138 |     }
 | 
|---|
| 139 |     std::vector< BondInfo > clonedbonds;
 | 
|---|
| 140 |     StoreBondInformationFromAtoms(clonedatoms, clonedbonds);
 | 
|---|
| 141 |     LOG(2, "DEBUG: There are " << clonedatominfos.size() << " newly created atoms.");
 | 
|---|
| 142 | 
 | 
|---|
| 143 |     if (!successflag) {
 | 
|---|
| 144 |       STATUS("Insertion failed, removing inserted clusters, translating original one back");
 | 
|---|
| 145 |       RemoveAtomsFromAtomicInfo(clonedatominfos);
 | 
|---|
| 146 |       clonedatoms.clear();
 | 
|---|
| 147 |       SetAtomsFromAtomicInfo(movedatoms);
 | 
|---|
| 148 |     } else {
 | 
|---|
| 149 |       std::vector<Vector> MovedToVector(filler->size(), zeroVec);
 | 
|---|
| 150 |       std::transform(filler->begin(), filler->end(), MovedToVector.begin(),
 | 
|---|
| 151 |           boost::bind(&AtomInfo::getPosition, _1) );
 | 
|---|
| 152 |       UndoState = new FillRegularGridState(clonedatominfos,clonedbonds,movedatoms,MovedToVector,params);
 | 
|---|
| 153 |     }
 | 
|---|
| 154 |   }
 | 
|---|
| 155 | 
 | 
|---|
| 156 |   if (successflag)
 | 
|---|
| 157 |     return ActionState::ptr(UndoState);
 | 
|---|
| 158 |   else {
 | 
|---|
| 159 |     return Action::failure;
 | 
|---|
| 160 |   }
 | 
|---|
| 161 | }
 | 
|---|
| 162 | 
 | 
|---|
| 163 | ActionState::ptr FillRegularGridAction::performUndo(ActionState::ptr _state) {
 | 
|---|
| 164 |   FillRegularGridState *state = assert_cast<FillRegularGridState*>(_state.get());
 | 
|---|
| 165 | 
 | 
|---|
| 166 |   // remove all created atoms
 | 
|---|
| 167 |   RemoveAtomsFromAtomicInfo(state->clonedatoms);
 | 
|---|
| 168 |   // add the original cluster
 | 
|---|
| 169 |   SetAtomsFromAtomicInfo(state->movedatoms);
 | 
|---|
| 170 | 
 | 
|---|
| 171 |   return ActionState::ptr(_state);
 | 
|---|
| 172 | }
 | 
|---|
| 173 | 
 | 
|---|
| 174 | ActionState::ptr FillRegularGridAction::performRedo(ActionState::ptr _state){
 | 
|---|
| 175 |   FillRegularGridState *state = assert_cast<FillRegularGridState*>(_state.get());
 | 
|---|
| 176 | 
 | 
|---|
| 177 |   // place filler cluster again at new spot
 | 
|---|
| 178 |   ResetAtomPosition(state->movedatoms, state->MovedToVector);
 | 
|---|
| 179 | 
 | 
|---|
| 180 |   // re-create all clusters
 | 
|---|
| 181 |   bool statusflag = AddAtomsFromAtomicInfo(state->clonedatoms);
 | 
|---|
| 182 | 
 | 
|---|
| 183 |   // re-create the bonds
 | 
|---|
| 184 |   if (statusflag)
 | 
|---|
| 185 |     AddBondsFromBondInfo(state->clonedbonds);
 | 
|---|
| 186 |   if (statusflag)
 | 
|---|
| 187 |     return ActionState::ptr(_state);
 | 
|---|
| 188 |   else {
 | 
|---|
| 189 |     STATUS("Failed re-adding filled in atoms.");
 | 
|---|
| 190 |     return Action::failure;
 | 
|---|
| 191 |   }
 | 
|---|
| 192 | }
 | 
|---|
| 193 | 
 | 
|---|
| 194 | bool FillRegularGridAction::canUndo() {
 | 
|---|
| 195 |   return true;
 | 
|---|
| 196 | }
 | 
|---|
| 197 | 
 | 
|---|
| 198 | bool FillRegularGridAction::shouldUndo() {
 | 
|---|
| 199 |   return true;
 | 
|---|
| 200 | }
 | 
|---|
| 201 | /** =========== end of function ====================== */
 | 
|---|