votca 2024.2-dev
Loading...
Searching...
No Matches
csg_imc_solve.h
Go to the documentation of this file.
1/*
2 * Copyright 2009-2021 The VOTCA Development Team (http://www.votca.org)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17
18#ifndef VOTCA_CSG_CSG_IMC_SOLVE_H
19#define VOTCA_CSG_CSG_IMC_SOLVE_H
20
21// VOTCA includes
24
25// Local VOTCA includes
26#include "votca/csg/version.h"
27
34 public:
35 std::string ProgramName() override { return "csg_imc_solve"; }
36 void HelpText(std::ostream &out) override {
37 out << "Solves the linear system for IMCs";
38 }
39
40 void ShowHelpText(std::ostream &out) override {
41 std::string name = ProgramName();
42 if (VersionString() != "") {
43 name = name + ", version " + VersionString();
44 }
45
47 HelpText(out);
48
49 out << "\n\n" << VisibleOptions() << std::endl;
50 }
51
52 bool EvaluateOptions() override;
53 void Initialize() override;
54 void Run() override;
55};
56
57#endif // VOTCA_CSG_CSG_IMC_SOLVE_H
Solves linear system for IMCS.
void Initialize() override
Initialize application data.
void ShowHelpText(std::ostream &out) override
std::string ProgramName() override
program name
void Run() override
Main body of application.
void HelpText(std::ostream &out) override
help text of application without version information
bool EvaluateOptions() override
Process command line options.
boost::program_options::options_description & VisibleOptions()
filters out the Hidden group from the options descriptions
virtual std::string VersionString()
version string of application
Definition application.h:55
void HelpTextHeader(const std::string &tool_name)
Definition version.cc:42