votca 2024.2-dev
Loading...
Searching...
No Matches
calculator.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#ifndef VOTCA_TOOLS_CALCULATOR_H
21#define VOTCA_TOOLS_CALCULATOR_H
22
23// Local VOTCA includes
24#include "globals.h"
25#include "property.h"
27
28namespace votca {
29namespace tools {
30
41 public:
42 Calculator() = default;
43 virtual ~Calculator() = default;
53 virtual std::string Identify() const = 0;
54
63 virtual std::string Package() const = 0;
64
74 virtual void Initialize(const Property &user_options) = 0;
83 void setnThreads(Index nThreads) {
84 nThreads_ = nThreads;
85 maverick_ = (nThreads_ == 1) ? true : false;
86 }
87
88 protected:
91};
92
93} // namespace tools
94} // namespace votca
95
96#endif // VOTCA_TOOLS_CALCULATOR_H
Base class for all calculators.
Definition calculator.h:40
void setnThreads(Index nThreads)
Sets number of threads to use.
Definition calculator.h:83
virtual std::string Identify() const =0
Calculator name.
virtual ~Calculator()=default
virtual void Initialize(const Property &user_options)=0
Initializes a calculator from an XML file with options.
virtual std::string Package() const =0
Package name.
class to manage program options with xml serialization functionality
Definition property.h:55
base class for all analysis tools
Definition basebead.h:33
Eigen::Index Index
Definition types.h:26