api/nblib/simulationstate.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS 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 GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements nblib SimulationState
  38  *
  39  * \author Berk Hess <hess@kth.se>
  40  * \author Victor Holanda <victor.holanda@cscs.ch>
  41  * \author Joe Jordan <ejjordan@kth.se>
  42  * \author Prashanth Kanduri <kanduri@cscs.ch>
  43  * \author Sebastian Keller <keller@cscs.ch>
  44  * \author Artem Zhmurov <zhmurov@gmail.com>
  45  */
  46 #include <vector>
  47
  48 #include "gromacs/pbcutil/pbc.h"
  49 #include "nblib/exception.h"
  50 #include "nblib/simulationstate.h"
  51 #include "nblib/simulationstateimpl.h"
  52
  53 namespace nblib
  54 {
  55
  56 SimulationState::SimulationState(const std::vector<Vec3>& coordinates,
  57                                  const std::vector<Vec3>& velocities,
  58                                  const std::vector<Vec3>& forces,
  59                                  Box                      box,
  60                                  Topology                 topology) :
  61     simulationStatePtr_(std::make_shared<Impl>(coordinates, velocities, forces, box, topology))
  62 {
  63 }
  64
  65 SimulationState::Impl::Impl(const std::vector<Vec3>& coordinates,
  66                             const std::vector<Vec3>& velocities,
  67                             const std::vector<Vec3>& forces,
  68                             const Box&               box,
  69                             Topology                 topology) :
  70     box_(box),
  71     topology_(std::move(topology))
  72 {
  73     if (!checkNumericValues(coordinates))
  74     {
  75         throw InputException("Input coordinates has at least one NaN");
  76     }
  77     coordinates_ = coordinates;
  78     if (!checkNumericValues(velocities))
  79     {
  80         throw InputException("Input velocities has at least one NaN");
  81     }
  82
  83     velocities_ = velocities;
  84
  85     forces_ = forces;
  86
  87     // Ensure that the coordinates are in a box following PBC
  88     put_atoms_in_box(PbcType::Xyz, box.legacyMatrix(), coordinates_);
  89 }
  90
  91 const Topology& SimulationState::Impl::topology() const
  92 {
  93     return topology_;
  94 }
  95
  96 Box SimulationState::Impl::box() const
  97 {
  98     return box_;
  99 }
 100
 101 std::vector<Vec3>& SimulationState::Impl::coordinates()
 102 {
 103     return coordinates_;
 104 }
 105
 106 std::vector<Vec3>& SimulationState::Impl::velocities()
 107 {
 108     return velocities_;
 109 }
 110
 111 std::vector<Vec3>& SimulationState::Impl::forces()
 112 {
 113     return forces_;
 114 }
 115
 116 const Topology& SimulationState::topology() const
 117 {
 118     return simulationStatePtr_->topology();
 119 }
 120
 121 Box SimulationState::box() const
 122 {
 123     return simulationStatePtr_->box();
 124 }
 125
 126 std::vector<Vec3>& SimulationState::coordinates()
 127 {
 128     return simulationStatePtr_->coordinates();
 129 }
 130
 131 const std::vector<Vec3>& SimulationState::coordinates() const
 132 {
 133     return simulationStatePtr_->coordinates();
 134 }
 135
 136 std::vector<Vec3>& SimulationState::velocities()
 137 {
 138     return simulationStatePtr_->velocities();
 139 }
 140
 141 std::vector<Vec3>& SimulationState::forces()
 142 {
 143     return simulationStatePtr_->forces();
 144 }
 145
 146 } // namespace nblib