librpa_compute.h Source File

librpa_compute.h Source File#

LibRPA: librpa_compute.h Source File
LibRPA
librpa_compute.h
Go to the documentation of this file.
1#pragma once
6
7#include "librpa_handler.h"
8#include "librpa_input.h"
9#include "librpa_options.h"
10
11// C APIs
12#ifdef __cplusplus
13extern "C" {
14#endif
15
28 double *omegas, double *weights);
29
54 int n_kpoints, const int* kpoints, int n_aos,
55 double* values_re, double* values_im);
56
57
72 int n_ibz_kpoints, double *rpa_corr_ibzk_contrib_re,
73 double *rpa_corr_ibzk_contrib_im);
74
76
81
83
97 const int n_spins, const int n_kpts_this, const int *iks_this,
98 int i_state_low, int i_state_high, double *vexx);
99
101
115 const int n_spins, const int n_kpts_band_this, const int *iks_band_this,
116 int i_state_low, int i_state_high, double *vexx_band);
117
119
124
126
147 const int n_spins, const int n_kpts_this,
148 const int *iks_this, int i_state_low, int i_state_high,
149 const double *vxc, const double *vexx, double *sigc_re, double *sigc_im);
150
152
177 const int n_spins, const int n_kpts_this,
178 const int *iks_this, int i_state_low, int i_state_high,
179 const double *vxc, const double *vexx, double *sigc_re,
180 double *sigc_im, double *eqp);
181
183
207 LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins,
208 const int n_kpts_this, const int *iks_this, int i_state_low, int i_state_high,
209 const int n_omegas, const double *omegas, const double *vxc, const double *vexx,
210 double *spectral_function, double *sigc);
211
213
234 const int n_spins, const int n_kpts_band_this,
235 const int *iks_band_this, int i_state_low, int i_state_high,
236 const double *vxc_band, const double *vexx_band, double *sigc_band_re, double *sigc_band_im);
237
239
264 const int n_spins, const int n_kpts_band_this,
265 const int *iks_band_this, int i_state_low, int i_state_high,
266 const double *vxc_band, const double *vexx_band,
267 double *sigc_band_re, double *sigc_band_im,
268 double *eqp_band);
269
271
294 LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins,
295 const int n_kpts_band_this, const int *iks_band_this, int i_state_low,
296 int i_state_high, const int n_omegas, const double *omegas,
297 const double *vxc_band, const double *vexx_band, double *spectral_function_band,
298 double *sigc_band);
299
307 const LibrpaNativeVelocityInput *root_input,
308 int prepare_optical);
309
325{
326 int n_spins, n_kpoints, n_states, n_frequencies;
327 int head_rows, head_columns, wing_rows, wing_columns;
328 const double *velocity_ri;
329 const double *frequencies_ha;
330 const double *head_ri;
331 const double *wing_ri;
333
336
343
344typedef enum
345{
346 LIBRPA_QSGW_ITERATIONS,
347 LIBRPA_QSGW_EIGENVALUES,
348 LIBRPA_QSGW_MATRICES,
349 LIBRPA_QSGW_QUASIPARTICLES,
350 LIBRPA_QSGW_ENERGY_QP,
351 LIBRPA_QSGW_GW_BAND,
352 LIBRPA_QSGW_KS_BAND,
353 LIBRPA_QSGW_EXX_BAND,
354 LIBRPA_QSGW_QSGW_BAND,
355 LIBRPA_QSGW_HAMILTONIAN,
356 LIBRPA_QSGW_HEAD_HAMILTONIAN,
357 LIBRPA_QSGW_HARTREE
358} LibrpaQsgwOutputKind;
362typedef struct
363{
364 LibrpaQsgwOutputKind kind;
365 int iteration, spin, append;
366 const char *text;
367 size_t text_size;
368 const LibrpaLocalizedOperator *hamiltonian;
370typedef int (*LibrpaQsgwOutputSink)(const LibrpaQsgwOutput *, void *user_data);
371
380 const LibrpaQsgwControls *);
387void librpa_set_qsgw_output_sink(LibrpaQsgwTask *, LibrpaQsgwOutputSink, void *user_data);
388void librpa_run_qsgw_task(LibrpaQsgwTask *);
389void librpa_delete_qsgw_task(LibrpaQsgwTask *);
390
394void librpa_get_meanfield_dimensions(const LibrpaHandler *h, int band_path, int *nspins, int *nkpts,
395 int *nstates, int *naos, int *nspinor);
396
402 typedef struct
403 {
404 int n_spins, n_spinor, n_kpoints, n_bands, n_aos, n_groups;
405 double fermi_ha, highest_occupied_ha;
406 double min_overlap_eigenvalue, max_norm_error, max_sum_error, max_sqrt_residual;
408
409 typedef struct
410 {
411 int atom_index, type_index, l;
412 const char* channel; // s, p, eg, t2g, or lN; global Cartesian axes.
414
415 typedef struct
416 {
417 double energy_ha, occupation, kweight, norm;
418 const double* mulliken_ao;
419 const double* lowdin_ao;
420 const double* mulliken_group;
421 const double* lowdin_group;
423
435 LibrpaOrbitalResult* librpa_analyze_orbitals(const LibrpaHandler* h, int n_kpoints, int n_aos,
436 const double* overlap_k_ri, double residual_tol);
437 void librpa_delete_orbital_result(LibrpaOrbitalResult* result);
438 void librpa_orbital_info(const LibrpaOrbitalResult* result, LibrpaOrbitalInfo* info);
439 void librpa_orbital_group(const LibrpaOrbitalResult* result, int group,
440 LibrpaOrbitalGroup* view);
441 void librpa_orbital_state(const LibrpaOrbitalResult* result, int spin, int k, int band,
442 LibrpaOrbitalState* view);
443
450 void librpa_orbital_pdos(const LibrpaOrbitalResult* result, int n_energies,
451 const double* energy_grid_ha, double sigma_ha, double* mulliken,
452 double* lowdin);
453
462 typedef struct
463 {
464 int n_spins, n_spinor, n_kpoints, n_bands, n_aos, n_atoms;
465 int n_parent, n_output, n_parent_sites, n_output_sites;
466 double fermi_ha;
467 const double* lattice_bohr; /* [3][3], row lattice vectors */
468 const double* positions_bohr; /* [atom][3] */
469 const int* atom_types;
470 const int* ao_counts; /* spatial AO count per atom */
471 const double* k_fractional; /* [k][3] */
472 const double* k_weights; /* sum to one */
473 const int* output_columns; /* indices in joint parent frame */
474 int n_shells;
475 const int* shell_offsets; /* [atom+1], indexing shell_l */
476 const int* shell_l; /* radial shells in producer AO order */
477 const int* basis_convention; /* phase, ratom, order, coeff_negative, coeff_positive */
479
488 typedef struct
489 {
490 const double* energies_ha;
491 const double* occupations;
492 const double* coefficients_ri;
493 const double* overlap_ri;
494 const double* parent_phi_ri;
495 const double* output_phi_ri;
496 const double* parent_projector_ri;
497 const double* output_projector_ri;
498 const double* parent_h_ha_ri;
499 const double* output_h_ha_ri;
500 const double* parent_density_ri;
501 const double* output_density_ri;
502 double parent_capture_min;
504
505 void librpa_crpa_model_info(const LibrpaCrpaResult* result, LibrpaCrpaModelInfo* info);
506 void librpa_crpa_model_k(const LibrpaCrpaResult* result, int spin, int kpoint,
507 LibrpaCrpaModelK* view);
508 void librpa_crpa_model_site(const LibrpaCrpaResult* result, int parent, int site, int* atom,
509 int* column_start, int* n_orbitals);
510 const char* librpa_crpa_model_label(const LibrpaCrpaResult* result, int parent, int site,
511 int orbital);
514 void librpa_crpa_model_local(const LibrpaCrpaResult* result, int parent, int spin, int site,
515 double* h_ha_ri, double* density_ri);
518 void librpa_crpa_model_hopping(const LibrpaCrpaResult* result, int parent, int spin,
519 const int* lattice_R, double* h_ha_ri);
522 void librpa_crpa_project_one_body(int n_orbitals, int n_bands, const double* projector_ri,
523 const double* diagonal, double* operator_ri);
527 void librpa_crpa_project_orbitals(int n_aos, int n_spinor, int n_bands, int n_orbitals,
528 const double* coefficients_ri, const double* overlap_ri,
529 const double* phi_ri, double* projector_ri);
531 void librpa_crpa_rotate_projector(int n_bands, int n_old, int n_new, const double* projector_ri,
532 const double* rotation_ri, double* rotated_projector_ri);
535 void librpa_crpa_rotate_tensor(int n_old, int n_new, const double* tensor_ri,
536 const double* left_rotation_ri, const double* right_rotation_ri,
537 double* rotated_ri);
541 void librpa_crpa_tensor_to_fermion(int n_orbitals, const double* density_ri,
542 double* fermion_ri);
543
548 void librpa_crpa_tensor_averages(int n_orbitals, const double* tensor_ri,
549 double* averages_ha_ri);
550
551 typedef struct
552 {
553 int atom_index, spin_left, spin_right, n_orbitals;
554 const double* values_ha_ri;
555 const int* status; /* [M^4], zero means numerical diagnostics pass */
556 const double* subset_spread_ha; /* [M^4] */
557 double max_source_residual_ha, max_holdout_residual_ha;
559
567 const double* queries_ha_ri, int n_parameters,
568 double tolerance_ha);
576 int n_queries,
577 const double* queries_ha_ri,
578 const LibrpaOptions* options,
579 double tolerance_ha);
580
581 void librpa_delete_crpa_continued_result(LibrpaCrpaContinuedResult* result);
582 int librpa_crpa_continued_size(const LibrpaCrpaContinuedResult* result);
583 void librpa_crpa_continued_tensor(const LibrpaCrpaContinuedResult* result, int tensor,
584 int query, LibrpaCrpaContinuedTensor* view);
585
591 typedef struct
592 {
593 int atom_index;
594 int spin_left;
595 int spin_right;
596 int n_orbitals;
597 double frequency_ha;
598 const double* bare_ri;
599 const double* partially_screened_ri;
601 const double* fully_screened_ri;
603
604
606 void librpa_get_crpa_kgrid(const LibrpaHandler* h, int n_kpoints, double* fractional_k);
611 const LibrpaOptions* options,
612 const LibrpaCrpaInput* input);
613
623 const LibrpaOptions* options,
624 const LibrpaCrpaInput* input);
625
636 const LibrpaCrpaInput* input);
637
646 const LibrpaOptions* options,
647 const LibrpaCrpaInput* input);
648
652 void librpa_write_crpa_tracking_checkpoint(const LibrpaCrpaResult* result, const char* filename,
653 int iteration, const char* definition,
654 int n_energies, const double* energies_ha);
655
656
661 typedef int (*LibrpaCrpaOutputSink)(const LibrpaCrpaResult*, const LibrpaOrbitalResult*,
662 int state_index, int gw_update, int final_state,
663 void* user_data);
667 const LibrpaQsgwCrpaControls* controls, LibrpaCrpaOutputSink sink,
668 void* user_data);
669
670 void librpa_delete_crpa_result(LibrpaCrpaResult* result);
671 int librpa_crpa_result_size(const LibrpaCrpaResult* result);
672 void librpa_crpa_result_tensor(const LibrpaCrpaResult* result, int index,
673 LibrpaCrpaTensor* tensor);
674
678 void librpa_crpa_result_bands(const LibrpaCrpaResult* result, int response_window, int spin,
679 int kpoint, int* count, const int** bands);
682 void librpa_crpa_result_weights(const LibrpaCrpaResult* result, int spin, int kpoint,
683 int* count, const double** weights);
684
688 const char* librpa_crpa_result_orbital_label(const LibrpaCrpaResult* result, int atom,
689 int orbital);
690
691#ifdef __cplusplus
692}
693#endif
LibrpaQsgwTask * librpa_create_qsgw_task(LibrpaHandler *, const LibrpaOptions *, const LibrpaQsgwControls *)
void librpa_crpa_rotate_projector(int n_bands, int n_old, int n_new, const double *projector_ri, const double *rotation_ri, double *rotated_projector_ri)
LibrpaOrbitalResult * librpa_analyze_orbitals(const LibrpaHandler *h, int n_kpoints, int n_aos, const double *overlap_k_ri, double residual_tol)
void librpa_get_g0w0_sigc_kgrid(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_this, const int *iks_this, int i_state_low, int i_state_high, const double *vxc, const double *vexx, double *sigc_re, double *sigc_im)
Obtain correlation self-energies for selected states.
void librpa_get_g0w0_qpe_band_k(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_band_this, const int *iks_band_this, int i_state_low, int i_state_high, const double *vxc_band, const double *vexx_band, double *sigc_band_re, double *sigc_band_im, double *eqp_band)
Obtain correlation self-energies and QP energies for selected band-k states.
void librpa_build_exx(LibrpaHandler *h, const LibrpaOptions *p_opts)
Build exact-exchange matrix.
LibrpaOpticalResult * librpa_get_optical_result(const LibrpaHandler *h)
void librpa_delete_optical_result(LibrpaOpticalResult *result)
void librpa_crpa_tensor_to_fermion(int n_orbitals, const double *density_ri, double *fermion_ri)
LibrpaCrpaResult * librpa_build_g0w0_sigma_crpa(LibrpaHandler *h, const LibrpaOptions *options, const LibrpaCrpaInput *input)
void librpa_get_g0w0_spectral_function_kgrid(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_this, const int *iks_this, int i_state_low, int i_state_high, const int n_omegas, const double *omegas, const double *vxc, const double *vexx, double *spectral_function, double *sigc)
Obtain spectral functions for selected k-grid states.
void librpa_get_crpa_kgrid(const LibrpaHandler *h, int n_kpoints, double *fractional_k)
LibrpaCrpaContinuedResult * librpa_continue_crpa(const LibrpaCrpaResult *result, int n_queries, const double *queries_ha_ri, int n_parameters, double tolerance_ha)
LibrpaCrpaResult * librpa_compute_crpa_u_window(const LibrpaHandler *h, const LibrpaOptions *options, const LibrpaCrpaInput *input)
void librpa_write_crpa_tracking_checkpoint(const LibrpaCrpaResult *result, const char *filename, int iteration, const char *definition, int n_energies, const double *energies_ha)
void librpa_get_g0w0_qpe_kgrid(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_this, const int *iks_this, int i_state_low, int i_state_high, const double *vxc, const double *vexx, double *sigc_re, double *sigc_im, double *eqp)
Obtain correlation self-energies and QP energies for selected states.
void librpa_build_g0w0_sigma(LibrpaHandler *h, const LibrpaOptions *p_opts)
Build self-energy matrix of G0W0, including the correlation and exchange contributions.
LibrpaCrpaContinuedResult * librpa_continue_crpa_with_options(const LibrpaCrpaResult *result, int n_queries, const double *queries_ha_ri, const LibrpaOptions *options, double tolerance_ha)
void librpa_get_meanfield_dimensions(const LibrpaHandler *h, int band_path, int *nspins, int *nkpts, int *nstates, int *naos, int *nspinor)
LibrpaCrpaResult * librpa_prepare_crpa_model(const LibrpaHandler *h, const LibrpaOptions *options, const LibrpaCrpaInput *input)
void librpa_get_exx_pot_band_k(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_band_this, const int *iks_band_this, int i_state_low, int i_state_high, double *vexx_band)
Obtain exact-exchange potential for selected states at band k-points.
double librpa_get_rpa_correlation_energy(LibrpaHandler *h, const LibrpaOptions *p_opts, int n_ibz_kpoints, double *rpa_corr_ibzk_contrib_re, double *rpa_corr_ibzk_contrib_im)
Compute RPA correlation energy.
void librpa_orbital_pdos(const LibrpaOrbitalResult *result, int n_energies, const double *energy_grid_ha, double sigma_ha, double *mulliken, double *lowdin)
void librpa_crpa_project_one_body(int n_orbitals, int n_bands, const double *projector_ri, const double *diagonal, double *operator_ri)
const char * librpa_crpa_result_orbital_label(const LibrpaCrpaResult *result, int atom, int orbital)
void librpa_crpa_project_orbitals(int n_aos, int n_spinor, int n_bands, int n_orbitals, const double *coefficients_ri, const double *overlap_ri, const double *phi_ri, double *projector_ri)
void librpa_get_imaginary_frequency_grids(LibrpaHandler *h, const LibrpaOptions *p_opts, double *omegas, double *weights)
Construct and return frequency grids for numerical integration.
void librpa_crpa_result_bands(const LibrpaCrpaResult *result, int response_window, int spin, int kpoint, int *count, const int **bands)
void librpa_get_g0w0_sigc_band_k(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_band_this, const int *iks_band_this, int i_state_low, int i_state_high, const double *vxc_band, const double *vexx_band, double *sigc_band_re, double *sigc_band_im)
Obtain correlation self-energies for selected states at band k-points.
LibrpaOpticalResult LibrpaOpticalView
Definition librpa_compute.h:335
int(* LibrpaCrpaOutputSink)(const LibrpaCrpaResult *, const LibrpaOrbitalResult *, int state_index, int gw_update, int final_state, void *user_data)
Definition librpa_compute.h:661
void librpa_prepare_qsgw_task(LibrpaQsgwTask *)
void librpa_compute_hartree_ao(LibrpaHandler *h, const LibrpaOptions *p_opts, int n_kpoints, const int *kpoints, int n_aos, double *values_re, double *values_im)
Compute the physical, spin-summed periodic Hartree potential in the spatial AO basis.
void librpa_get_g0w0_spectral_function_band_k(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_band_this, const int *iks_band_this, int i_state_low, int i_state_high, const int n_omegas, const double *omegas, const double *vxc_band, const double *vexx_band, double *spectral_function_band, double *sigc_band)
Obtain spectral functions for selected band-k states.
void librpa_get_exx_pot_kgrid(LibrpaHandler *h, const LibrpaOptions *p_opts, const int n_spins, const int n_kpts_this, const int *iks_this, int i_state_low, int i_state_high, double *vexx)
Obtain exact-exchange potential for selected states.
LibrpaOpticalView librpa_get_optical_view(const LibrpaOpticalResult *result)
LibrpaCrpaResult * librpa_compute_crpa_window(const LibrpaHandler *h, const LibrpaOptions *options, const LibrpaCrpaInput *input)
void librpa_prepare_native_velocity(LibrpaHandler *h, const LibrpaOptions *options, const LibrpaNativeVelocityInput *root_input, int prepare_optical)
void librpa_crpa_rotate_tensor(int n_old, int n_new, const double *tensor_ri, const double *left_rotation_ri, const double *right_rotation_ri, double *rotated_ri)
void librpa_crpa_model_hopping(const LibrpaCrpaResult *result, int parent, int spin, const int *lattice_R, double *h_ha_ri)
void librpa_set_qsgw_crpa(LibrpaQsgwTask *task, const LibrpaCrpaInput *input, const LibrpaQsgwCrpaControls *controls, LibrpaCrpaOutputSink sink, void *user_data)
void librpa_crpa_model_local(const LibrpaCrpaResult *result, int parent, int spin, int site, double *h_ha_ri, double *density_ri)
void librpa_crpa_result_weights(const LibrpaCrpaResult *result, int spin, int kpoint, int *count, const double **weights)
void librpa_crpa_tensor_averages(int n_orbitals, const double *tensor_ri, double *averages_ha_ri)
Handler management for LibRPA instances.
struct LibrpaCrpaContinuedResult LibrpaCrpaContinuedResult
Definition librpa_handler.h:48
struct LibrpaQsgwTask LibrpaQsgwTask
Definition librpa_handler.h:32
struct LibrpaCrpaResult LibrpaCrpaResult
Definition librpa_handler.h:42
Input data APIs for LibRPA.
Runtime options for LibRPA calculations.
Definition librpa_compute.h:552
Definition librpa_input.h:623
Definition librpa_compute.h:463
Definition librpa_compute.h:489
Definition librpa_compute.h:592
const double * fully_screened_ri
Definition librpa_compute.h:601
Opaque handle to a LibRPA instance.
Definition librpa_handler.h:26
Definition librpa_input.h:31
Definition librpa_input.h:47
Definition librpa_compute.h:325
Runtime options structure for LibRPA calculations.
Definition librpa_options.h:35
Definition librpa_compute.h:410
Definition librpa_compute.h:403
Definition librpa_compute.h:416
Definition librpa_options.h:793
Definition librpa_options.h:828
Definition librpa_compute.h:363