votca 2024.2-dev
Loading...
Searching...
No Matches
qmcalculator.h
Go to the documentation of this file.
1/*
2 * Copyright 2009-2020 The VOTCA Development Team
3 * (http://www.votca.org)
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License")
6 *
7 * You may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 */
19
20#pragma once
21#ifndef VOTCA_XTP_QMCALCULATOR_H
22#define VOTCA_XTP_QMCALCULATOR_H
23
24// VOTCA includes
26
27namespace votca {
28namespace xtp {
29
30class Topology;
31
33 public:
34 QMCalculator() = default;
35 ~QMCalculator() override = default;
36
37 std::string Identify() const override = 0;
38
39 std::string Package() const final { return "xtp"; }
40
41 virtual bool WriteToStateFile() const = 0;
42
43 bool EvaluateFrame(Topology& top);
44
45 void Initialize(const tools::Property& opt) final;
46
47 protected:
48 virtual void ParseOptions(const tools::Property& opt) = 0;
49 virtual bool Evaluate(Topology& top) = 0;
50};
51
52} // namespace xtp
53} // namespace votca
54
55#endif // VOTCA_XTP_QMCALCULATOR_H
Base class for all calculators.
Definition calculator.h:40
class to manage program options with xml serialization functionality
Definition property.h:55
virtual bool Evaluate(Topology &top)=0
virtual void ParseOptions(const tools::Property &opt)=0
void Initialize(const tools::Property &opt) final
Initializes a calculator from an XML file with options.
bool EvaluateFrame(Topology &top)
virtual bool WriteToStateFile() const =0
std::string Identify() const override=0
Calculator name.
std::string Package() const final
Package name.
~QMCalculator() override=default
Container for segments and box and atoms.
Definition topology.h:41
base class for all analysis tools
Definition basebead.h:33