librpa_options.h File Reference

librpa_options.h File Reference#

LibRPA: librpa_options.h File Reference
LibRPA
librpa_options.h File Reference

Runtime options for LibRPA calculations. More...

#include "librpa_enums.h"
Include dependency graph for librpa_options.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  LibrpaOptions
 Runtime options structure for LibRPA calculations. More...
 
struct  LibrpaQsgwControls
 
struct  LibrpaQsgwCrpaControls
 

Macros

#define LIBRPA_MAX_STRLEN   200
 

Functions

void librpa_init_options (LibrpaOptions *opts)
 Initialize runtime options to default values.
 
void librpa_set_output_dir (LibrpaOptions *opts, const char *output_dir)
 Set the output directory for LibRPA results.
 
void librpa_set_restart_from_dir (LibrpaOptions *opts, const char *restart_from_dir)
 Set the directory to read restart checkpoint files from.
 
void librpa_init_qsgw_controls (LibrpaQsgwControls *)
 
void librpa_init_qsgw_crpa_controls (LibrpaQsgwCrpaControls *controls)
 

Detailed Description

Runtime options for LibRPA calculations.

This file defines the LibrpaOptions structure that controls runtime behavior for RPA, exact exchange, and G0W0 calculations.

Macro Definition Documentation

◆ LIBRPA_MAX_STRLEN

#define LIBRPA_MAX_STRLEN   200

Maximum length for string parameters (e.g., output directory path).

Function Documentation

◆ librpa_init_options()

void librpa_init_options ( LibrpaOptions * opts)

Initialize runtime options to default values.

Sets all options to their default settings. Must be called before modifying options and passing to computation functions.

Parameters
[out]optsPointer to the options structure to initialize.
Here is the caller graph for this function:

◆ librpa_init_qsgw_controls()

void librpa_init_qsgw_controls ( LibrpaQsgwControls * )

Defaults: min/max=1/10, unoccupied_keep=10, uncut, mixer=none, beta=0.2 (used only for single-k linear mixing), shift=2 eV, convergence=1e-4 eV, reference velocity, QP/HR outputs on, matrices off, restart=none and checkpoint=qsgw_checkpoint.bin, Hartree updates on. Indices are zero-based.

◆ librpa_set_output_dir()

void librpa_set_output_dir ( LibrpaOptions * opts,
const char * output_dir )

Set the output directory for LibRPA results.

Parameters
[in,out]optsPointer to the options structure.
[in]output_dirPath to directory where output files will be written.
Here is the caller graph for this function:

◆ librpa_set_restart_from_dir()

void librpa_set_restart_from_dir ( LibrpaOptions * opts,
const char * restart_from_dir )

Set the directory to read restart checkpoint files from.

Parameters
[in,out]optsPointer to the options structure.
[in]restart_from_dirPath to directory containing restart files. Empty uses output_dir.
Here is the caller graph for this function: