librpa.hpp File Reference

librpa.hpp File Reference#

LibRPA: librpa.hpp File Reference
LibRPA
librpa.hpp File Reference

C++ wrapper API for LibRPA. More...

#include "librpa_enums.h"
#include "librpa_options.h"
#include "librpa_handler.h"
#include "librpa_compute.h"
#include <array>
#include <vector>
#include <complex>
#include <memory>
Include dependency graph for librpa.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  librpa::G0W0QpeResult
 G0W0 correlation self-energies and quasiparticle energies. More...
 
struct  librpa::G0W0SpectralFunctionResult
 G0W0 spectral functions and continued correlation self-energies. More...
 
class  librpa::Options
 C++ wrapper for runtime options. More...
 
class  librpa::Handler
 Main handler class for LibRPA computations. More...
 

Namespaces

namespace  librpa
 Main namespace for LibRPA C++ API.
 

Typedefs

using librpa::QsgwTask = std::unique_ptr<LibrpaQsgwTask, decltype(&librpa_delete_qsgw_task)>
 
using librpa::OpticalResult = std::unique_ptr<LibrpaOpticalResult, decltype(&librpa_delete_optical_result)>
 
using librpa::OrbitalResult = std::unique_ptr<LibrpaOrbitalResult, decltype(&librpa_delete_orbital_result)>
 
using librpa::CrpaResult = std::unique_ptr<LibrpaCrpaResult, decltype(&librpa_delete_crpa_result)>
 
using librpa::CrpaContinuedResult
 
typedef LibrpaParallelRouting librpa::ParallelRouting
 Parallel routing strategy (C++ alias).
 
typedef LibrpaTimeFreqGrid librpa::TimeFreqGrid
 Time/frequency grid type (C++ alias)
 
typedef LibrpaSwitch librpa::Switch
 Boolean switch type (C++ alias)
 
typedef LibrpaKind librpa::Kind
 DFT code kind type (C++ alias, reserved)
 
typedef LibrpaVerbose librpa::Verbose
 Verbosity level type (C++ alias)
 

Functions

CrpaContinuedResult librpa::continue_crpa (const LibrpaCrpaResult *result, const std::vector< std::complex< double > > &queries, int n_parameters=-1, double tolerance_ha=0.0003674932217565499)
 
std::array< std::complex< double >, 3 > librpa::crpa_tensor_averages (int n_orbitals, const std::vector< std::complex< double > > &tensor)
 
CrpaContinuedResult librpa::continue_crpa (const LibrpaCrpaResult *result, const std::vector< std::complex< double > > &queries, const Options &options, double tolerance_ha=0.0003674932217565499)
 
const char * librpa::get_build_info (void)
 Get build information string.
 
int librpa::get_major_version (void)
 Get major version number.
 
int librpa::get_minor_version (void)
 Get minor version number.
 
int librpa::get_patch_version (void)
 Get patch version number.
 
void librpa::init_global (Switch switch_redirect_stdout=LIBRPA_SWITCH_OFF, const char *redirect_path="stdout", Switch switch_process_output=LIBRPA_SWITCH_ON)
 Initialize the global LibRPA environment.
 
void librpa::set_output_level (Verbose output_level)
 Set the global LibRPA stdout verbosity.
 
Verbose librpa::get_output_level (void)
 Get the global LibRPA stdout verbosity.
 
void librpa::finalize_global (void)
 Finalize the global LibRPA environment.
 
void librpa::test (void)
 Run internal self-tests.
 
void librpa::print_profile (void)
 Print profiling information.
 

Detailed Description

C++ wrapper API for LibRPA.

This file provides a convenient C++ interface to LibRPA functionality. It wraps the C API with STL containers for easier use.

Usage:

#include "librpa.hpp"
C++ wrapper API for LibRPA.
Note
This header includes librpa_options.h and librpa_handler.h which provide the underlying C types.