votca 2024-dev
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator Class Reference

#include <parallelxjobcalc.h>

Inheritance diagram for votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator:
Inheritance graph
[legend]
Collaboration diagram for votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator:
Collaboration graph
[legend]

Public Member Functions

 JobOperator (Index id, const Topology &top, ParallelXJobCalc< JobContainer > &master, Index openmp_threads)
 
 ~JobOperator () override=default
 
void Run () override
 Run() executes the actual code.
 
- Public Member Functions inherited from votca::xtp::QMThread
 QMThread ()=default
 
 QMThread (bool maverick)
 
 ~QMThread () override=default
 
Index getId () const
 
void setId (Index id)
 
bool isMaverick () const
 
LoggergetLogger ()
 
void Run (void) override
 Run() executes the actual code.
 
- Public Member Functions inherited from votca::tools::Thread
 Thread ()
 
virtual ~Thread ()
 
void Start ()
 Starts and runs a thread.
 
void WaitDone ()
 WaitDone() will not exit until thread ends computation.
 
bool IsFinished () const
 Checks to see if the thread is done.
 

Private Attributes

const Topologytop_
 
ParallelXJobCalc< JobContainer > & master_
 
Index openmp_threads_ = 1
 

Additional Inherited Members

virtual void Run (void)=0
 Run() executes the actual code.
 
- Protected Attributes inherited from votca::xtp::QMThread
Index id_
 
std::stringstream ss_
 
bool maverick_ = false
 
Logger logger_
 

Detailed Description

template<typename JobContainer>
class votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator

Definition at line 80 of file parallelxjobcalc.h.

Constructor & Destructor Documentation

◆ JobOperator()

template<typename JobContainer >
votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator::JobOperator ( Index  id,
const Topology top,
ParallelXJobCalc< JobContainer > &  master,
Index  openmp_threads 
)
inline

Definition at line 82 of file parallelxjobcalc.h.

◆ ~JobOperator()

template<typename JobContainer >
votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator::~JobOperator ( )
overridedefault

Member Function Documentation

◆ Run()

template<typename JobContainer >
void votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator::Run ( )
overridevirtual

Run() executes the actual code.

It is left blank here and must be overloaded, for the thread to do any work. This method should never be called by the user, it is called internally by the Start method.

Implements votca::tools::Thread.

Definition at line 89 of file parallelxjobcalc.cc.

Member Data Documentation

◆ master_

template<typename JobContainer >
ParallelXJobCalc<JobContainer>& votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator::master_
private

Definition at line 93 of file parallelxjobcalc.h.

◆ openmp_threads_

template<typename JobContainer >
Index votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator::openmp_threads_ = 1
private

Definition at line 94 of file parallelxjobcalc.h.

◆ top_

template<typename JobContainer >
const Topology& votca::xtp::ParallelXJobCalc< JobContainer >::JobOperator::top_
private

Definition at line 92 of file parallelxjobcalc.h.


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