struct rgpot::IPIDriverConfig

Overview

Where the driver connects, the species it serves, and how the geometry is handed to the evaluation. More…

#include <IPIDriver.hpp>
 
struct IPIDriverConfig {
    // fields
 
    std::string address;
    std::vector<int> species;
    std::string unix_prefix = “/tmp/ipi_”;
    double connect_timeout_s = 30.0;
    double timeout_s = 0.0;
    double cutoff = 0.0;
    double stress_step = 0.0;
    bool extras_json = true;
};

Detailed Documentation

Where the driver connects, the species it serves, and how the geometry is handed to the evaluation.

address is unix:/absolute/path, unix:<name> (connects to <unix_prefix><name>, by default /tmp/ipi_<name>), tcp:<host>:<port> or tcp:<port> (host 127.0.0.1).

Fields

std::vector<int> species

Atomic number of each atom, in the server’s atom order.

double connect_timeout_s = 30.0

Seconds connect() keeps retrying a refused or missing socket.

double timeout_s = 0.0

Seconds one message may take to arrive or send. 0 waits forever.

double cutoff = 0.0

Interaction range in Angstrom. A periodic cell narrower than twice this is tiled, and an open box (singular cell) is padded by it.

double stress_step = 0.0

Strain step of the central-difference virial used when the evaluation reports no stress. 0 sends a zero virial instead.

bool extras_json = true

Send a small JSON object as the FORCEREADY extra string. False sends an empty string.