QMCPACK
Public Types | Public Member Functions | Protected Member Functions | List of all members
QMCDriverInterface Class Referenceabstract

Creates a common base class pointer for QMCDriver and QMCDriverNew to share. More...

+ Inheritance diagram for QMCDriverInterface:
+ Collaboration diagram for QMCDriverInterface:

Public Types

using BranchEngineType = SimpleFixedNodeBranch
 
using FullPrecRealType = QMCTraits::FullPrecRealType
 

Public Member Functions

virtual bool run ()=0
 
virtual bool put (xmlNodePtr cur)=0
 
virtual void recordBlock (int block)=0
 
virtual RandomBase< FullPrecRealType > & getRng (int i)=0
 return the i-th random generator More...
 
virtual void setStatus (const std::string &aname, const std::string &h5name, bool append)=0
 
virtual void setUpdateMode (bool pbyp)=0
 
virtual void add_H_and_Psi (QMCHamiltonian *h, TrialWaveFunction *psi)=0
 
virtual void putWalkers (std::vector< xmlNodePtr > &wset)=0
 
virtual void putTraces (xmlNodePtr txml)=0
 
virtual void requestTraces (bool allow_traces)=0
 
virtual void putWalkerLogs (xmlNodePtr wlxml)=0
 
virtual void requestWalkerLogs (bool allow_walker_logs_)=0
 
virtual void process (xmlNodePtr cur)=0
 
virtual QMCRunType getRunType ()=0
 
virtual std::string getEngineName ()=0
 
virtual unsigned long getDriverMode ()=0
 
virtual ~QMCDriverInterface ()
 
virtual void setBranchEngine (std::unique_ptr< BranchEngineType > &&be)
 
virtual std::unique_ptr< BranchEngineType > getBranchEngine ()
 

Protected Member Functions

virtual const std::string & get_root_name () const =0
 

Detailed Description

Creates a common base class pointer for QMCDriver and QMCDriverNew to share.

Once the "unified" driver is done this should be refactored away

Definition at line 33 of file QMCDriverInterface.h.

Member Typedef Documentation

◆ BranchEngineType

using BranchEngineType = SimpleFixedNodeBranch

Definition at line 36 of file QMCDriverInterface.h.

◆ FullPrecRealType

using FullPrecRealType = QMCTraits::FullPrecRealType

Definition at line 37 of file QMCDriverInterface.h.

Constructor & Destructor Documentation

◆ ~QMCDriverInterface()

virtual ~QMCDriverInterface ( )
inlinevirtual

Definition at line 58 of file QMCDriverInterface.h.

58 {}

Member Function Documentation

◆ add_H_and_Psi()

virtual void add_H_and_Psi ( QMCHamiltonian *  h,
TrialWaveFunction *  psi 
)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ get_root_name()

virtual const std::string& get_root_name ( ) const
protectedpure virtual

Implemented in QMCDriver, and QMCDriverNew.

◆ getBranchEngine()

virtual std::unique_ptr<BranchEngineType> getBranchEngine ( )
inlinevirtual

Reimplemented in QMCDriver.

Definition at line 61 of file QMCDriverInterface.h.

Referenced by qmcplusplus::TEST_CASE().

61 { return nullptr; }

◆ getDriverMode()

virtual unsigned long getDriverMode ( )
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ getEngineName()

virtual std::string getEngineName ( )
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ getRng()

virtual RandomBase<FullPrecRealType>& getRng ( int  i)
pure virtual

return the i-th random generator

Implemented in QMCDriver, and QMCDriverNew.

◆ getRunType()

virtual QMCRunType getRunType ( )
pure virtual

Implemented in DMCBatched, VMCBatched, WaveFunctionTester, QMCFixedSampleLinearOptimizeBatched, QMCFixedSampleLinearOptimize, QMCDriverNewTestWrapper, CSVMC, DMC, RMC, and VMC.

◆ process()

virtual void process ( xmlNodePtr  cur)
pure virtual

Implemented in QMCDriverNew, QMCDriver, DMCBatched, VMCBatched, QMCFixedSampleLinearOptimizeBatched, and QMCDriverNewTestWrapper.

◆ put()

virtual bool put ( xmlNodePtr  cur)
pure virtual

Implemented in QMCDriverNew, WaveFunctionTester, QMCFixedSampleLinearOptimize, CSVMC, DMC, RMC, and VMC.

Referenced by QMCDriver::process().

◆ putTraces()

virtual void putTraces ( xmlNodePtr  txml)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ putWalkerLogs()

virtual void putWalkerLogs ( xmlNodePtr  wlxml)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ putWalkers()

virtual void putWalkers ( std::vector< xmlNodePtr > &  wset)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ recordBlock()

virtual void recordBlock ( int  block)
pure virtual

Implemented in QMCDriver, and QMCDriverNew.

◆ requestTraces()

virtual void requestTraces ( bool  allow_traces)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ requestWalkerLogs()

virtual void requestWalkerLogs ( bool  allow_walker_logs_)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ run()

virtual bool run ( )
pure virtual

Implemented in QMCDriverNewTestWrapper, DMCBatched, VMCBatched, QMCFixedSampleLinearOptimizeBatched, WaveFunctionTester, QMCFixedSampleLinearOptimize, CSVMC, DMC, RMC, and VMC.

◆ setBranchEngine()

virtual void setBranchEngine ( std::unique_ptr< BranchEngineType > &&  be)
inlinevirtual

Definition at line 60 of file QMCDriverInterface.h.

60 {}

◆ setStatus()

virtual void setStatus ( const std::string &  aname,
const std::string &  h5name,
bool  append 
)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

◆ setUpdateMode()

virtual void setUpdateMode ( bool  pbyp)
pure virtual

Implemented in QMCDriverNew, and QMCDriver.

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