occ::driver::DMADriver Class Reference

#include <dma_driver.h>

Classes
struct	DMAOutput

Public Member Functions
	DMADriver ()=default
	DMADriver (const DMAConfig &config)
void	set_config (const DMAConfig &config)
const DMAConfig &	config () const
DMAOutput	run ()
DMAOutput	run (const occ::qm::Wavefunction &wfn)

Static Public Member Functions
static std::string	generate_punch_file (const occ::dma::DMAResult &result, const occ::dma::DMASites &sites)
static void	write_punch_file (const std::string &filename, const occ::dma::DMAResult &result, const occ::dma::DMASites &sites)
static std::string	generate_json (const DMAConfig &config, const DMAOutput &output)
	Structured results: settings actually used, the frame they are in, and per-site effective radii/limits.
static void	write_json (const std::string &filename, const DMAConfig &config, const DMAOutput &output)

Constructor & Destructor Documentation

DMADriver() [1/2]

occ::driver::DMADriver::DMADriver ( )

default

DMADriver() [2/2]

occ::driver::DMADriver::DMADriver ( const DMAConfig &  config )

inlineexplicit

Member Function Documentation

config()

const DMAConfig & occ::driver::DMADriver::config ( ) const

inline

generate_json()

static std::string occ::driver::DMADriver::generate_json ( const DMAConfig &  config, const DMAOutput &  output  )

static

Structured results: settings actually used, the frame they are in, and per-site effective radii/limits.

Serialized as JSON text.

generate_punch_file()

static std::string occ::driver::DMADriver::generate_punch_file ( const occ::dma::DMAResult &  result, const occ::dma::DMASites &  sites  )

static

run() [1/2]

DMAOutput occ::driver::DMADriver::run

(

)

run() [2/2]

DMAOutput occ::driver::DMADriver::run

(

const occ::qm::Wavefunction &

wfn

)

set_config()

void occ::driver::DMADriver::set_config ( const DMAConfig &  config )

inline

write_json()

static void occ::driver::DMADriver::write_json ( const std::string &  filename, const DMAConfig &  config, const DMAOutput &  output  )

static

write_punch_file()

static void occ::driver::DMADriver::write_punch_file ( const std::string &  filename, const occ::dma::DMAResult &  result, const occ::dma::DMASites &  sites  )

static

---

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

• /home/runner/work/occ/occ/include/occ/driver/dma_driver.h