librpa_handler.h File Reference

librpa_handler.h File Reference#

LibRPA: librpa_handler.h File Reference
LibRPA
librpa_handler.h File Reference

Handler management for LibRPA instances. More...

#include <mpi.h>
Include dependency graph for librpa_handler.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  LibrpaHandler
 Opaque handle to a LibRPA instance. More...
 

Typedefs

typedef struct LibrpaQsgwTask LibrpaQsgwTask
 
typedef struct LibrpaCrpaResult LibrpaCrpaResult
 
typedef struct LibrpaOrbitalResult LibrpaOrbitalResult
 
typedef struct LibrpaCrpaContinuedResult LibrpaCrpaContinuedResult
 

Functions

LibrpaHandler * librpa_create_handler (MPI_Comm comm)
 Create a new LibRPA handler instance.
 
void librpa_destroy_handler (LibrpaHandler *h)
 Destroy a LibRPA handler instance.
 

Detailed Description

Handler management for LibRPA instances.

Typedef Documentation

◆ LibrpaCrpaContinuedResult

Independently owned continuation result, valid after its source cRPA result is deleted. Release with librpa_delete_crpa_continued_result. Arrays returned by its accessors remain borrowed and valid only until this result is deleted.

◆ LibrpaCrpaResult

Indexed cRPA and orbital result handles; numerical views and accessors are declared in librpa_compute.h. Standalone factory results own snapshots that survive handler changes or destruction. Release each owned result on its rank with librpa_delete_crpa_result or librpa_delete_orbital_result. Accessor arrays and strings are borrowed, read-only, and valid until the owning result is deleted. The handles passed to LibrpaCrpaOutputSink are borrowed instead: do not delete them or retain them or their views after that callback returns.

◆ LibrpaQsgwTask

Opaque QSGW execution state; create and delete it through librpa_compute.h.

Function Documentation

◆ librpa_create_handler()

LibrpaHandler * librpa_create_handler ( MPI_Comm comm)

Create a new LibRPA handler instance.

Allocates and initializes a new LibRPA handler associated with the given MPI communicator. This handle is used in subsequent API calls to perform RPA/EXX/G0W0 calculations.

Parameters
[in]commMPI communicator (e.g., MPI_COMM_WORLD).
Returns
Pointer to newly created LibrpaHandler. Must be freed with librpa_destroy_handler() when no longer needed.
See also
librpa_destroy_handler

◆ librpa_destroy_handler()

void librpa_destroy_handler ( LibrpaHandler * h)

Destroy a LibRPA handler instance.

Frees all internal resources associated with the handler. After this call, the handler pointer becomes invalid and should not be used.

Parameters
[in]hPointer to the LibrpaHandler to destroy. If NULL, no action is taken.
See also
librpa_create_handler