MultiMolecularModelBuilder.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 Vishwesh Venkatraman <vishwesh.venkatraman@ntnu.no> and
 *   Marco Foscato <marco.foscato@uib.no>
 * 
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.molecularmodeling;
 
import java.util.ArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;
 
import org.openscience.cdk.interfaces.IAtom;
import org.openscience.cdk.interfaces.IAtomContainer;
 
import denoptim.constants.DENOPTIMConstants;
import denoptim.exception.DENOPTIMException;
import denoptim.fragspace.FragmentSpaceParameters;
import denoptim.graph.DGraph;
import denoptim.graph.rings.RingClosureParameters;
import denoptim.integration.rcoserver.RCOSocketServerClient;
import denoptim.integration.tinker.ConformationalSearchPSSROT;
import denoptim.integration.tinker.TinkerException;
import denoptim.io.DenoptimIO;
import denoptim.molecularmodeling.zmatrix.ZMatrix;
import denoptim.programs.RunTimeParameters.ParametersType;
import denoptim.programs.moldecularmodelbuilder.MMBuilderParameters;
import denoptim.utils.AtomOrganizer;
import denoptim.utils.DummyAtomHandler;
import denoptim.utils.ObjectPair;
import denoptim.utils.RotationalSpaceUtils;
 
public class MultiMolecularModelBuilder
{
    private String molName;
    private DGraph molGraph;
    
    private MMBuilderParameters settings;
    
    private Logger logger;
 
//------------------------------------------------------------------------------
 
    public MultiMolecularModelBuilder(String molName, DGraph molGraph,
            MMBuilderParameters settings)
    {
        this.settings = settings;
        this.logger = settings.getLogger();
        this.molName = molName;
        this.molGraph = molGraph;
    }
 
//------------------------------------------------------------------------------
 
    public ArrayList<IAtomContainer> buildMulti3DStructure() 
            throws DENOPTIMException
    {
        logger.log(Level.INFO, "Building Multiple 3D representations for "
                 + "graph = " + molGraph.toString());
 
        // Generate XYZ and INT representations
        long startTime = System.nanoTime();
        ChemicalObjectModel mol = build3DTree();
        long endTime = System.nanoTime();
        long time = (endTime - startTime);
        
        logger.log(Level.FINE, "TIME (build 3D model): " + time/1000000 + " ms"
                  + " #frags: " + mol.getGraph().getVertexList().size() 
                  + " #atoms: " + mol.getIAtomContainer().getAtomCount());
        
        // get settings //TODO: this should happen inside RunTimeParameters
        RingClosureParameters rcParams = new RingClosureParameters();
        if (settings.containsParameters(ParametersType.RC_PARAMS))
        {
            rcParams = (RingClosureParameters)settings.getParameters(
                    ParametersType.RC_PARAMS);
        }
 
        // Evaluate source of isomerism
        // 1: Attempt Ring Closures 
        RingClosureTool rct = new RingClosureTool(settings);
        ArrayList<ChemicalObjectModel> structures =new ArrayList<ChemicalObjectModel>();
        boolean skipConfSearch = false;
        if (rcParams.allowRingClosures() && mol.getGraph().hasOrEmbedsRings())
        {
            startTime = System.nanoTime();
            structures = rct.attemptAllRingClosures(mol);
            endTime = System.nanoTime();
            time = (endTime - startTime);
            int numAllClosedCombs = 0;
            for (ChemicalObjectModel rcMol : structures)
            {
                Object o = rcMol.getIAtomContainer().getProperty(
                        DENOPTIMConstants.MOLERRORTAG);
                if (o == null)
                    numAllClosedCombs++;
            }
            logger.log(Level.FINE, "TIME (close ring): "+time/1000000+" ms"
                      + " #frags: " + mol.getGraph().getVertexList().size()
                      + " #atoms: " + mol.getIAtomContainer().getAtomCount()
                      + " #rcaCombs: " + mol.getRCACombinations().size()
                      + " #allClosedRCSCombs: " + numAllClosedCombs);
            if (rcParams.requireCompleteRingclosure && numAllClosedCombs<1)
            {
                logger.log(Level.INFO, "No fully closed RCA combinaton. "
                        + "Nothing to send to conformational search.");
                skipConfSearch = true;
            }
            // Ring-closing conf search on the RCO server includes general
            // purpose conformational search, so no need to run a second 
            // conformational search.
            // RCO server is the default, so the condition checks for non-default
            // configuration.
            if (settings.getPSSROTTool() == null)
            {
                skipConfSearch = true;
            }
        } else {
            ChemicalObjectModel nMol = mol.deepcopy();
            rct.saturateRingClosingAttractor(nMol);
            structures = new ArrayList<ChemicalObjectModel>();
            structures.add(nMol);
        }
 
        // 2: Conformational search (if possible)
        if (!skipConfSearch)
        {
            if (settings.getPSSROTTool() != null)
            {
                try
                {
                    startTime = System.nanoTime();
                    ConformationalSearchPSSROT.performPSSROT(structures, 
                            settings.getTinkerMap(),
                            "cs",
                            settings.getParamFile(), 
                            settings.getKeyFileParams(),
                            settings.getInitPSSROTParams(),
                            settings.getRestPSSROTParams(),
                            settings.getPSSROTTool(),
                            settings.getXYZINTTool(),
                            settings.getWorkingDirectory(),
                            settings.getTaskID(), logger);
                    time = (endTime - startTime);
                }  catch (TinkerException te)
                {
                    String msg = "ERROR! Tinker failed on task '" 
                            + te.taskName + "'!";
                    if (te.solution != "")
                    {
                        msg = msg + settings.NL + te.solution;
                    }
                    logger.log(Level.SEVERE, msg);
                    throw new DENOPTIMException(msg, te);
                } 
            } else {
                RCOSocketServerClient rcoServer = RCOSocketServerClient.getInstance(
                    settings.getRCOServerHostname(), settings.getRCOServerPort());
                rcoServer.setRecordRequestsFileName(
                    settings.getPathnameForRecordingRCOServerRequests());
                for (ChemicalObjectModel com : structures)
                {
                    try
                    {
                        rcoServer.runConformationalOptimization(com, logger);
                    } catch (Exception e) {
                        e.printStackTrace();
                        String msg = "ERROR! RCOSocketServer failed!";
                        logger.log(Level.SEVERE, msg);
                        throw new DENOPTIMException(msg, e);
                    }
                    
                }
            }
            logger.log(Level.FINE, "TIME (conf. search): "+time/1000000+" ms"
                      + " #frags: " + mol.getGraph().getVertexList().size()
                      + " #atoms: " + mol.getIAtomContainer().getAtomCount()
                      + " #rotBnds: " + mol.getRotatableBonds().size());
        }
        
        // Convert and return results
        ArrayList<IAtomContainer> results = new ArrayList<IAtomContainer>();
        DummyAtomHandler dah = new DummyAtomHandler(
                DENOPTIMConstants.DUMMYATMSYMBOL, logger);
        for (ChemicalObjectModel mol3db : structures)
        {
            IAtomContainer iac = mol3db.getIAtomContainer();
            
            IAtomContainer originalOrderMol = AtomOrganizer.makeReorderedCopy(
                    iac, mol3db.getOldToNewOrder(), mol3db.getNewToOldOrder());
            iac = originalOrderMol;
            
            if (!settings.getKeepDummyFlag())
            {
                // To keep track of which vertexID should be removed from mol 
                // properties, we remove that property from the mol. It remains
                // defined in each atom.
                iac.removeProperty(DENOPTIMConstants.ATMPROPVERTEXID);
                
                iac = dah.removeDummyInHapto(iac);
                iac = dah.removeDummy(iac);
                
                // Now we put the property back among the molecular ones
                StringBuilder sbMolProp = new StringBuilder();
                for (IAtom atm : iac.atoms())
                {
                    sbMolProp.append(" ").append(atm.getProperty(
                            DENOPTIMConstants.ATMPROPVERTEXID).toString());
                }
                iac.setProperty(DENOPTIMConstants.ATMPROPVERTEXID, 
                        sbMolProp.toString().trim());
                results.add(iac);
            } else {
                results.add(iac);
            }
        }
 
        return results;
    }
 
//------------------------------------------------------------------------------
 
    public ChemicalObjectModel build3DTree() throws DENOPTIMException
    {   
        // Create 3D tree-like structure
        ThreeDimTreeBuilder tb = new ThreeDimTreeBuilder(logger, 
                settings.getRandomizer());
        IAtomContainer initMol = tb.convertGraphTo3DAtomContainer(molGraph, 
                false, //don't remove used RCAs
                true,  //set the CDK requirements 
                true); //rebuild low-quality structured embedded in templates
       
        // Reorder atoms and clone molecule.
        AtomOrganizer oa = new AtomOrganizer();
        oa.setScheme(settings.getAtomOrderingScheme());
        int seedAtm = 0;
        IAtomContainer reorderedMol = oa.reorderStartingFrom(seedAtm, initMol);
        ArrayList<Integer> newToOldMap = oa.getNewToOldOrder(seedAtm);
        ArrayList<Integer> oldToNewMap = oa.getOldToNewOrder(seedAtm);
        logger.log(Level.FINEST, "oldToNewMap: "+oldToNewMap);
        
        // Collect rotatable bonds defined by fragment-fragment connections
        ArrayList<ObjectPair> rotBonds = RotationalSpaceUtils
                .defineRotatableBonds(reorderedMol,
                        ((FragmentSpaceParameters) settings.getParameters(
                                ParametersType.FS_PARAMS)).getRotSpaceDefFile(),
                        true, true, settings.getLogger());
 
        //Apply constraints, if any
        RotationalSpaceUtils.processConstrainedRotatableBonds(reorderedMol, 
            rotBonds, ((FragmentSpaceParameters) settings.getParameters(
                ParametersType.FS_PARAMS)).getRotConstraintDefFile(), logger);
        
        logger.log(Level.FINE, "Rotatable bonds: "+rotBonds);
        if (logger.isLoggable(Level.FINEST))
        {
            logger.log(Level.FINEST, "Reordered IAtomContainer: 'iacToIC.sdf'");
            DenoptimIO.writeSDFFile("iacToIC.sdf",reorderedMol,false);
        }
        
        // Generate Internal Coordinates
        ZMatrix zmat= ZMatrix.getZMatrixFromIAC(reorderedMol);
        
        // Generate combined molecular representations (both XYZ and INT)
        return new ChemicalObjectModel(
                molGraph,
                reorderedMol,
                zmat,
                molName,
                rotBonds,
                oldToNewMap,
                newToOldMap,
                logger
        );
    }
 
//------------------------------------------------------------------------------
 
}