Inheritance diagram for CsgParallelTestApp:

[legend]

Collaboration diagram for CsgParallelTestApp:

[legend]

Protected Attributes
votca::tools::Histogram	rdf_
double	cut_off_
Protected Attributes inherited from votca::csg::CsgApplication
std::list< CGObserver * >	observers_
bool	do_mapping_
std::vector< std::unique_ptr< Worker > >	myWorkers_
Index	nframes_
bool	is_first_frame_
Index	nthreads_
tools::Mutex	nframesMutex_
tools::Mutex	traj_readerMutex_
std::vector< std::unique_ptr< tools::Mutex > >	threadsMutexesIn_
	stores Mutexes used to impose order for input
std::vector< std::unique_ptr< tools::Mutex > >	threadsMutexesOut_
	stores Mutexes used to impose order for output
std::unique_ptr< TrajectoryReader >	traj_reader_
Protected Attributes inherited from votca::tools::Application
std::map< std::string, boost::program_options::options_description >	op_groups_
bool	continue_execution_ = true

Private Member Functions
string	ProgramName () override
	program name
void	HelpText (ostream &out) override
	help text of application without version information
void	Initialize () override
	Initialize application data.
bool	DoTrajectory () override
	overload and return true to enable trajectory command line options
bool	DoThreaded () override
void	BeginEvaluate (Topology top, Topology top_ref) override
	called before the first frame
void	EndEvaluate () override
	called after the last frame
std::unique_ptr< CsgApplication::Worker >	ForkWorker (void) override
void	MergeWorker (Worker *worker) override

Additional Inherited Members
Public Member Functions inherited from votca::csg::CsgApplication
	CsgApplication ()=default
	~CsgApplication () override=default
bool	EvaluateOptions () override
	Process command line options.
void	Run (void) override
	Main body of application.
void	ShowHelpText (std::ostream &out) override
virtual bool	DoMapping (void)
	overload and return true to enable mapping command line options
virtual bool	DoMappingDefault (void)
	if DoMapping is true, will by default require mapping or not
virtual bool	SynchronizeThreads (void)
virtual bool	NeedsTopology (void)
	if topology is always needed
virtual bool	EvaluateTopology (Topology , Topology =nullptr)
	called after topology was loaded
void	AddObserver (CGObserver *observer)
virtual void	EvalConfiguration (Topology top, Topology top_ref=nullptr)
bool	ProcessData (Worker *worker)
	Gets frames from TrajectoryReader in an ordered way and, if successful, calls Worker::EvalConfiguration for that frame.
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

Detailed Description

Definition at line 40 of file template_threaded.cc.

Member Function Documentation

◆ BeginEvaluate()

void CsgParallelTestApp::BeginEvaluate	(	Topology *	top,
		Topology *	top_ref )

overrideprivatevirtual

called before the first frame

Reimplemented from votca::csg::CsgApplication.

Definition at line 108 of file template_threaded.cc.

◆ DoThreaded()

bool CsgParallelTestApp::DoThreaded ( void )

inlineoverrideprivatevirtual

Reimplemented from votca::csg::CsgApplication.

Definition at line 62 of file template_threaded.cc.

◆ DoTrajectory()

bool CsgParallelTestApp::DoTrajectory ( void )

inlineoverrideprivatevirtual

overload and return true to enable trajectory command line options

Reimplemented from votca::csg::CsgApplication.

Definition at line 50 of file template_threaded.cc.

◆ EndEvaluate()

void CsgParallelTestApp::EndEvaluate ( )

overrideprivatevirtual

called after the last frame

Reimplemented from votca::csg::CsgApplication.

Definition at line 167 of file template_threaded.cc.

◆ ForkWorker()

std::unique_ptr< CsgApplication::Worker > CsgParallelTestApp::ForkWorker ( void )

overrideprivatevirtual

User is required to overload ForkWorker and initialize workers.

Returns: worker

Reimplemented from votca::csg::CsgApplication.

Definition at line 117 of file template_threaded.cc.

◆ HelpText()

void CsgParallelTestApp::HelpText ( ostream & out )

inlineoverrideprivatevirtual

help text of application without version information

Parameters

out	ostream for output

Implements votca::tools::Application.

Definition at line 44 of file template_threaded.cc.

◆ Initialize()

void CsgParallelTestApp::Initialize ( )

overrideprivatevirtual

Initialize application data.

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

Reimplemented from votca::csg::CsgApplication.

Definition at line 101 of file template_threaded.cc.

◆ MergeWorker()

void CsgParallelTestApp::MergeWorker ( Worker * worker )

overrideprivatevirtual

User is required to overload MergeWorker and merge data from each worker.

Parameters

worker

Reimplemented from votca::csg::CsgApplication.

Definition at line 140 of file template_threaded.cc.

◆ ProgramName()

string CsgParallelTestApp::ProgramName ( )

inlineoverrideprivatevirtual

program name

Returns: string with program name

overload this function to set the program name

Implements votca::tools::Application.

Definition at line 42 of file template_threaded.cc.

Member Data Documentation

◆ cut_off_

double CsgParallelTestApp::cut_off_

protected

Definition at line 81 of file template_threaded.cc.

◆ rdf_

votca::tools::Histogram CsgParallelTestApp::rdf_

protected

Definition at line 80 of file template_threaded.cc.

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

csg/share/template/template_threaded.cc

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BeginEvaluate()

◆ DoThreaded()

◆ DoTrajectory()

◆ EndEvaluate()

◆ ForkWorker()

◆ HelpText()

◆ Initialize()

◆ MergeWorker()

◆ ProgramName()

Member Data Documentation

◆ cut_off_

◆ rdf_