api/nblib/simulationstate.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, 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 "gromacs/utility/arrayref.h"
  50 #include "nblib/exception.h"
  51 #include "nblib/simulationstate.h"
  52 #include "nblib/simulationstateimpl.h"
  53 #include "nblib/util/setup.h"
  54
  55 namespace nblib
  56 {
  57
  58 SimulationState::SimulationState(const std::vector<Vec3>& coordinates,
  59                                  const std::vector<Vec3>& velocities,
  60                                  const std::vector<Vec3>& forces,
  61                                  Box                      box,
  62                                  Topology                 topology) :
  63     simulationStatePtr_(std::make_shared<Impl>(coordinates, velocities, forces, box, topology))
  64 {
  65 }
  66
  67 SimulationState::Impl::Impl(const std::vector<Vec3>& coordinates,
  68                             const std::vector<Vec3>& velocities,
  69                             const std::vector<Vec3>& forces,
  70                             const Box&               box,
  71                             Topology                 topology) :
  72     box_(box), topology_(std::move(topology))
  73 {
  74     auto numParticles = topology_.numParticles();
  75
  76     if (int(coordinates.size()) != numParticles)
  77     {
  78         throw InputException("Coordinates array size mismatch");
  79     }
  80
  81     if (int(velocities.size()) != numParticles)
  82     {
  83         throw InputException("Velocities array size mismatch");
  84     }
  85
  86     if (int(forces.size()) != numParticles)
  87     {
  88         throw InputException("Force buffer array size mismatch");
  89     }
  90
  91     if (!isRealValued(coordinates))
  92     {
  93         throw InputException("Input coordinates has at least one NaN");
  94     }
  95     coordinates_ = coordinates;
  96     if (!isRealValued(velocities))
  97     {
  98         throw InputException("Input velocities has at least one NaN");
  99     }
 100
 101     velocities_ = velocities;
 102
 103     forces_ = forces;
 104
 105     // Ensure that the coordinates are in a box following PBC
 106     put_atoms_in_box(PbcType::Xyz, box.legacyMatrix(), coordinates_);
 107 }
 108
 109 const Topology& SimulationState::Impl::topology() const
 110 {
 111     return topology_;
 112 }
 113
 114 Box SimulationState::Impl::box() const
 115 {
 116     return box_;
 117 }
 118
 119 std::vector<Vec3>& SimulationState::Impl::coordinates()
 120 {
 121     return coordinates_;
 122 }
 123
 124 std::vector<Vec3>& SimulationState::Impl::velocities()
 125 {
 126     return velocities_;
 127 }
 128
 129 std::vector<Vec3>& SimulationState::Impl::forces()
 130 {
 131     return forces_;
 132 }
 133
 134 const Topology& SimulationState::topology() const
 135 {
 136     return simulationStatePtr_->topology();
 137 }
 138
 139 Box SimulationState::box() const
 140 {
 141     return simulationStatePtr_->box();
 142 }
 143
 144 std::vector<Vec3>& SimulationState::coordinates()
 145 {
 146     return simulationStatePtr_->coordinates();
 147 }
 148
 149 const std::vector<Vec3>& SimulationState::coordinates() const
 150 {
 151     return simulationStatePtr_->coordinates();
 152 }
 153
 154 std::vector<Vec3>& SimulationState::velocities()
 155 {
 156     return simulationStatePtr_->velocities();
 157 }
 158
 159 std::vector<Vec3>& SimulationState::forces()
 160 {
 161     return simulationStatePtr_->forces();
 162 }
 163
 164 } // namespace nblib