librpa Namespace Reference#
|
LibRPA
|
Main namespace for LibRPA C++ API. More...
Classes | |
| struct | FileReaderOptions |
| Options controlling dataset input from LibRPA files. More... | |
| struct | G0W0QpeResult |
| G0W0 correlation self-energies and quasiparticle energies. More... | |
| struct | G0W0SpectralFunctionResult |
| G0W0 spectral functions and continued correlation self-energies. More... | |
| class | Handler |
| Main handler class for LibRPA computations. More... | |
| class | Options |
| C++ wrapper for runtime options. More... | |
Typedefs | |
| using | QsgwTask = std::unique_ptr<LibrpaQsgwTask, decltype(&librpa_delete_qsgw_task)> |
| using | OpticalResult = std::unique_ptr<LibrpaOpticalResult, decltype(&librpa_delete_optical_result)> |
| using | OrbitalResult = std::unique_ptr<LibrpaOrbitalResult, decltype(&librpa_delete_orbital_result)> |
| using | CrpaResult = std::unique_ptr<LibrpaCrpaResult, decltype(&librpa_delete_crpa_result)> |
| using | CrpaContinuedResult |
| typedef LibrpaParallelRouting | ParallelRouting |
| Parallel routing strategy (C++ alias). | |
| typedef LibrpaTimeFreqGrid | TimeFreqGrid |
| Time/frequency grid type (C++ alias) | |
| typedef LibrpaSwitch | Switch |
| Boolean switch type (C++ alias) | |
| typedef LibrpaKind | Kind |
| DFT code kind type (C++ alias, reserved) | |
| typedef LibrpaVerbose | Verbose |
| Verbosity level type (C++ alias) | |
Functions | |
| std::shared_ptr< librpa_int::Dataset > | read_dataset_from_files (MPI_Comm comm, const FileReaderOptions &opts) |
| Read a LibRPA dataset from files. | |
| CrpaContinuedResult | 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 > | crpa_tensor_averages (int n_orbitals, const std::vector< std::complex< double > > &tensor) |
| CrpaContinuedResult | continue_crpa (const LibrpaCrpaResult *result, const std::vector< std::complex< double > > &queries, const Options &options, double tolerance_ha=0.0003674932217565499) |
| const char * | get_build_info (void) |
| Get build information string. | |
| int | get_major_version (void) |
| Get major version number. | |
| int | get_minor_version (void) |
| Get minor version number. | |
| int | get_patch_version (void) |
| Get patch version number. | |
| void | 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 | set_output_level (Verbose output_level) |
| Set the global LibRPA stdout verbosity. | |
| Verbose | get_output_level (void) |
| Get the global LibRPA stdout verbosity. | |
| void | finalize_global (void) |
| Finalize the global LibRPA environment. | |
| void | test (void) |
| Run internal self-tests. | |
| void | print_profile (void) |
| Print profiling information. | |
Detailed Description
Main namespace for LibRPA C++ API.
Typedef Documentation
◆ CrpaContinuedResult
| using librpa::CrpaContinuedResult |
◆ ParallelRouting
Parallel routing strategy (C++ alias).
- See also
- LibrpaParallelRouting
Function Documentation
◆ continue_crpa() [1/2]
| CrpaContinuedResult librpa::continue_crpa | ( | const LibrpaCrpaResult * | result, |
| const std::vector< std::complex< double > > & | queries, | ||
| const Options & | options, | ||
| double | tolerance_ha = 0.0003674932217565499 ) |
Continue with explicit method and penalty options; otherwise the same contract.
◆ continue_crpa() [2/2]
| CrpaContinuedResult librpa::continue_crpa | ( | const LibrpaCrpaResult * | result, |
| const std::vector< std::complex< double > > & | queries, | ||
| int | n_parameters = -1, | ||
| double | tolerance_ha = 0.0003674932217565499 ) |
Noncollective native continuation. Energies are Hartree; default diagnostic tolerance is 0.01 eV.
◆ crpa_tensor_averages()
| std::array< std::complex< double >, 3 > librpa::crpa_tensor_averages | ( | int | n_orbitals, |
| const std::vector< std::complex< double > > & | tensor ) |
Mean direct, inter-orbital direct and exchange tensor elements, in Hartree.
◆ finalize_global()
| void librpa::finalize_global | ( | void | ) |
Finalize the global LibRPA environment.
Must be called after all LibRPA operations are complete.
- See also
- librpa_finalize_global
◆ get_build_info()
| const char * librpa::get_build_info | ( | void | ) |
Get build information string.
- Returns
- C-string containing build information.
- See also
- librpa_get_build_info
◆ get_major_version()
| int librpa::get_major_version | ( | void | ) |
◆ get_minor_version()
| int librpa::get_minor_version | ( | void | ) |
◆ get_output_level()
| Verbose librpa::get_output_level | ( | void | ) |
Get the global LibRPA stdout verbosity.
- Returns
- Current verbosity level.
- See also
- librpa_get_output_level
◆ get_patch_version()
| int librpa::get_patch_version | ( | void | ) |
◆ init_global()
| 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.
Must be called after MPI_Init() and before any other LibRPA functions.
- Parameters
-
[in] switch_redirect_stdout If true, redirect stdout to a file. [in] redirect_path Path for redirected output (default: "stdout"). [in] switch_process_output If true, enable per-process output (default: true).
- See also
- librpa_init_global
◆ print_profile()
| void librpa::print_profile | ( | void | ) |
Print profiling information.
- See also
- librpa_print_profile
◆ read_dataset_from_files()
| std::shared_ptr< librpa_int::Dataset > librpa::read_dataset_from_files | ( | MPI_Comm | comm, |
| const FileReaderOptions & | opts ) |
Read a LibRPA dataset from files.
- Parameters
-
[in] comm MPI communicator used to initialize the dataset. [in] opts File reader options.
- Returns
- Shared pointer to the populated LibRPA dataset.
Initialize MPI and LibRPA before calling. Input is replicated on each rank, as in the original LibBSE loader. With read_band_data=false, SCF data is copied to the band data. Release the dataset before global finalization.
◆ set_output_level()
| void librpa::set_output_level | ( | Verbose | output_level | ) |
Set the global LibRPA stdout verbosity.
- Parameters
-
[in] output_level Verbosity level.
- See also
- librpa_set_output_level
◆ test()
| void librpa::test | ( | void | ) |
Run internal self-tests.
- See also
- librpa_test
Generated by