File: md.cpp

package info (click to toggle)
gromacs 2025.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 287,236 kB
  • sloc: xml: 3,718,478; cpp: 654,820; ansic: 75,282; python: 20,471; sh: 3,471; perl: 2,218; yacc: 644; fortran: 397; lisp: 265; makefile: 171; lex: 125; awk: 68; csh: 39
file content (136 lines) | stat: -rw-r--r-- 4,616 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright 2018- The GROMACS Authors
 * and the project initiators Erik Lindahl, Berk Hess and David van der Spoel.
 * Consult the AUTHORS/COPYING files and https://www.gromacs.org for details.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * https://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at https://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out https://www.gromacs.org.
 */
#include "gmxapi/md.h"

#include <memory>
#include <utility>

#include "gromacs/mdtypes/state.h"
#include "gromacs/utility/gmxassert.h"
#include "gromacs/utility/keyvaluetree.h"

#include "gmxapi/gmxapi.h"
#include "gmxapi/md/mdmodule.h"

#include "md_impl.h"

namespace gmxapi
{

const char* MDHolder::api_name = MDHolder_Name;

//! \cond internal
class MDWorkSpec::Impl
{
public:
    /*!
     * \brief container of objects glued together by the client.
     *
     * Note that the client can't be trusted to keep alive or destroy these,
     * and we do not yet have sufficient abstraction layers to allow the
     * client to interact asynchronously with code supporting MD simulation
     * through truly separate handles to the underlying objects, so ownership
     * is amongst the collaborators of the gmxapi::MDModule.
     * \todo Pass factory function objects instead of shared handles.
     * \todo Consolidate MDWorkSpec and gmxapi::Workflow under new Context umbrella.
     */
    std::vector<std::shared_ptr<gmxapi::MDModule>> modules;
};
//! \endcond

MDWorkSpec::MDWorkSpec() : impl_{ std::make_unique<Impl>() }
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
}

void MDWorkSpec::addModule(std::shared_ptr<gmxapi::MDModule> module)
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    impl_->modules.emplace_back(std::move(module));
}

std::vector<std::shared_ptr<gmxapi::MDModule>>& MDWorkSpec::getModules()
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    return impl_->modules;
}

MDWorkSpec::~MDWorkSpec() = default;

std::shared_ptr<::gmxapi::MDWorkSpec> MDHolder::getSpec()
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    GMX_ASSERT(impl_->spec_, "Expected non-null work specification.");
    return impl_->spec_;
}

std::shared_ptr<const ::gmxapi::MDWorkSpec> MDHolder::getSpec() const
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    GMX_ASSERT(impl_->spec_, "Expected non-null work specification.");
    return impl_->spec_;
}

MDHolder::MDHolder() : MDHolder{ std::make_shared<MDWorkSpec>() }
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    GMX_ASSERT(impl_->spec_, "Expected non-null work specification.");
}

MDHolder::MDHolder(std::shared_ptr<MDWorkSpec> spec) :
    impl_(std::make_shared<MDHolder::Impl>(std::move(spec)))
{
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    GMX_ASSERT(impl_->spec_, "Expected non-null work specification.");
}

MDHolder::Impl::Impl(std::shared_ptr<MDWorkSpec>&& spec) : spec_{ spec }
{
    GMX_ASSERT(spec_, "Expected non-null work specification.");
}

MDHolder::MDHolder(std::string name) : MDHolder{}
{
    name_ = std::move(name);
    GMX_ASSERT(impl_, "Expected non-null implementation object.");
    GMX_ASSERT(impl_->spec_, "Expected non-null work specification.");
}

std::string MDHolder::name() const
{
    return name_;
}


} // end namespace gmxapi