CG_IMC_solve Class Reference

Solves linear system for IMCS. More...

#include <csg_imc_solve.h>

Inheritance diagram for CG_IMC_solve:

Collaboration diagram for CG_IMC_solve:

Public Member Functions
std::string	ProgramName () override
	program name
void	HelpText (std::ostream &out) override
	help text of application without version information
void	ShowHelpText (std::ostream &out) override
bool	EvaluateOptions () override
	Process command line options.
void	Initialize () override
	Initialize application data.
void	Run () override
	Main body of application.
Public Member Functions inherited from votca::tools::Application
	Application ()
virtual	~Application ()
int	Exec (int argc, char **argv)
	executes the program
virtual std::string	VersionString ()
	version string of application
void	CheckRequired (const std::string &option_name, const std::string &error_msg="")
	Check weather required option is set.
boost::program_options::options_description_easy_init	AddProgramOptions (const std::string &group="")
	add option for command line
boost::program_options::variables_map &	OptionsMap ()
	get available program options & descriptions
boost::program_options::options_description &	OptionsDesc ()
boost::program_options::options_description &	VisibleOptions ()
	filters out the Hidden group from the options descriptions
void	StopExecution ()
	call StopExecution after EvaluateOptions

Additional Inherited Members
Protected Member Functions inherited from votca::tools::Application
Protected Attributes inherited from votca::tools::Application
std::map< std::string, boost::program_options::options_description >	op_groups_
bool	continue_execution_ = true

Detailed Description

Solves linear system for IMCS.

Definition at line 33 of file csg_imc_solve.h.

Member Function Documentation

EvaluateOptions()

bool CG_IMC_solve::EvaluateOptions ( )

overridevirtual

Process command line options.

Returns

true to continue, false to stop

EvaluateOptions is called by Run after parsing the command line. return true if everything is ok, false to stop and show help text.

Implements votca::tools::Application.

Definition at line 52 of file csg_imc_solve.cc.

HelpText()

void CG_IMC_solve::HelpText ( std::ostream & out )

inlineoverridevirtual

help text of application without version information

Parameters

out	ostream for output

Implements votca::tools::Application.

Definition at line 36 of file csg_imc_solve.h.

Initialize()

void CG_IMC_solve::Initialize ( )

overridevirtual

Initialize application data.

Initialize is called by run before parsing the command line. All necessary command line arguments can be added here

Implements votca::tools::Application.

Definition at line 35 of file csg_imc_solve.cc.

ProgramName()

std::string CG_IMC_solve::ProgramName ( )

inlineoverridevirtual

program name

Returns

string with program name

overload this function to set the program name

Implements votca::tools::Application.

Definition at line 35 of file csg_imc_solve.h.

Run()

void CG_IMC_solve::Run ( )

overridevirtual

Main body of application.

Run is called after command line was parsed + evaluated. All the work should be done in here.

Implements votca::tools::Application.

Definition at line 59 of file csg_imc_solve.cc.

ShowHelpText()

void CG_IMC_solve::ShowHelpText ( std::ostream & out )

inlineoverridevirtual

Reimplemented from votca::tools::Application.

Definition at line 40 of file csg_imc_solve.h.

---

The documentation for this class was generated from the following files:

• csg/src/tools/csg_imc_solve.h
• csg/src/tools/csg_imc_solve.cc