Skip to main content
← OpenMECP Documentation

CustomInterface

Struct CustomInterface 

Source
pub struct CustomInterface {
    config: CustomInterfaceConfig,
    energy_regex: Regex,
    forces_regex: Option<Regex>,
}
Expand description

Custom QM interface that reads configuration from JSON

Fields§

§config: CustomInterfaceConfig§energy_regex: Regex§forces_regex: Option<Regex>

Implementations§

Source§

impl CustomInterface

Source

pub fn from_file(config_path: &Path) -> Result<Self, QMError>

Creates a new CustomInterface by loading configuration from a JSON file.

This function reads a JSON configuration file that defines how to interact with a custom quantum chemistry program. The configuration includes:

  • Program command
  • Input file template with placeholders
  • Output file extension
  • Regular expressions for parsing energy and forces
§Arguments
  • config_path - Path to the JSON configuration file
§Returns

Returns a Result containing:

  • Ok(Self) - Successfully created CustomInterface
  • Err(QMError::Parse) - Failed to read or parse the configuration file
§Examples
use omecp::qm_interface::CustomInterface;
use std::path::Path;

let custom_interface = CustomInterface::from_file(Path::new("my_qm_config.json"))?;

Trait Implementations§

Source§

impl QMInterface for CustomInterface

Source§

fn write_input( &self, geom: &Geometry, header: &str, tail: &str, path: &Path, ) -> Result<(), QMError>

Writes a calculation input file for the quantum chemistry program. Read more
Source§

fn run_calculation(&self, input_path: &Path) -> Result<(), QMError>

Executes the quantum chemistry calculation. Read more
Source§

fn read_output( &self, output_path: &Path, _original_geometry: &Geometry, _state: usize, ) -> Result<State, QMError>

Parses the calculation output file to extract results. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.