da9031abb82b40b91daefafe620f3ba63d6f68c5
[alexxy/gromacs.git] / src / gromacs / trajectoryanalysis / analysissettings.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2010,2011,2012,2013,2014, 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 classes in analysissettings.h.
38  *
39  * \author Teemu Murtola <teemu.murtola@gmail.com>
40  * \ingroup module_trajectoryanalysis
41  */
42 #include "gmxpre.h"
43
44 #include "analysissettings.h"
45
46 #include "gromacs/fileio/trxio.h"
47 #include "gromacs/math/vec.h"
48 #include "gromacs/topology/topology.h"
49 #include "gromacs/utility/exceptions.h"
50 #include "gromacs/utility/smalloc.h"
51
52 #include "analysissettings-impl.h"
53
54 namespace gmx
55 {
56
57
58 /********************************************************************
59  * TrajectoryAnalysisSettings
60  */
61
62 TrajectoryAnalysisSettings::TrajectoryAnalysisSettings()
63     : impl_(new Impl)
64 {
65     impl_->frflags |= TRX_NEED_X;
66 }
67
68
69 TrajectoryAnalysisSettings::~TrajectoryAnalysisSettings()
70 {
71 }
72
73
74 const TimeUnitManager &
75 TrajectoryAnalysisSettings::timeUnitManager() const
76 {
77     return impl_->timeUnitManager;
78 }
79
80
81 const AnalysisDataPlotSettings &
82 TrajectoryAnalysisSettings::plotSettings() const
83 {
84     return impl_->plotSettings;
85 }
86
87
88 unsigned long
89 TrajectoryAnalysisSettings::flags() const
90 {
91     return impl_->flags;
92 }
93
94
95 bool
96 TrajectoryAnalysisSettings::hasFlag(unsigned long flag) const
97 {
98     return impl_->flags & flag;
99 }
100
101
102 bool
103 TrajectoryAnalysisSettings::hasPBC() const
104 {
105     return impl_->bPBC;
106 }
107
108
109 bool
110 TrajectoryAnalysisSettings::hasRmPBC() const
111 {
112     return impl_->bRmPBC;
113 }
114
115
116 int
117 TrajectoryAnalysisSettings::frflags() const
118 {
119     return impl_->frflags;
120 }
121
122
123 void
124 TrajectoryAnalysisSettings::setFlags(unsigned long flags)
125 {
126     impl_->flags = flags;
127 }
128
129
130 void
131 TrajectoryAnalysisSettings::setFlag(unsigned long flag, bool bSet)
132 {
133     if (bSet)
134     {
135         impl_->flags |= flag;
136     }
137     else
138     {
139         impl_->flags &= ~flag;
140     }
141 }
142
143
144 void
145 TrajectoryAnalysisSettings::setPBC(bool bPBC)
146 {
147     impl_->bPBC = bPBC;
148 }
149
150
151 void
152 TrajectoryAnalysisSettings::setRmPBC(bool bRmPBC)
153 {
154     impl_->bRmPBC = bRmPBC;
155 }
156
157
158 void
159 TrajectoryAnalysisSettings::setFrameFlags(int frflags)
160 {
161     impl_->frflags = frflags;
162 }
163
164
165 /********************************************************************
166  * TopologyInformation
167  */
168
169 TopologyInformation::TopologyInformation()
170     : top_(NULL), bTop_(false), xtop_(NULL), ePBC_(-1)
171 {
172     clear_mat(boxtop_);
173 }
174
175
176 TopologyInformation::~TopologyInformation()
177 {
178     if (top_)
179     {
180         free_t_atoms(&top_->atoms, TRUE);
181         done_top(top_);
182         sfree(top_);
183     }
184     sfree(xtop_);
185 }
186
187
188 void
189 TopologyInformation::getTopologyConf(rvec **x, matrix box) const
190 {
191     if (box)
192     {
193         copy_mat(const_cast<rvec *>(boxtop_), box);
194     }
195     if (x)
196     {
197         if (!xtop_)
198         {
199             *x = NULL;
200             GMX_THROW(APIError("Topology coordinates requested without setting efUseTopX"));
201         }
202         *x = xtop_;
203     }
204 }
205
206 } // namespace gmx