occ
Loading...
Searching...
No Matches
occ::mults::MultipoleESP Class Reference

Electrostatic Potential (ESP) evaluation using multipoles and S-functions. More...

#include <esp.h>

Public Member Functions

 MultipoleESP (int max_rank=4)
 Constructor.
 
double compute_esp_at_point (const occ::dma::Mult &multipole, const Vec3 &site_position, const Vec3 &eval_point) const
 Compute ESP at a point due to a single multipole site.
 
std::vector< double > compute_esp_at_points (const occ::dma::Mult &multipole, const Vec3 &site_position, const std::vector< Vec3 > &eval_points) const
 Compute ESP at multiple points due to a single multipole site.
 
double compute_interaction_energy (const occ::dma::Mult &mult1, const Vec3 &pos1, const occ::dma::Mult &mult2, const Vec3 &pos2) const
 Compute interaction energy between two multipole sites.
 

Detailed Description

Electrostatic Potential (ESP) evaluation using multipoles and S-functions.

This class evaluates the electrostatic potential at points in space due to multipole distributions, following Orient's implementation.

Constructor & Destructor Documentation

◆ MultipoleESP()

occ::mults::MultipoleESP::MultipoleESP ( int  max_rank = 4)
explicit

Constructor.

Parameters
max_rankMaximum multipole rank to handle

Member Function Documentation

◆ compute_esp_at_point()

double occ::mults::MultipoleESP::compute_esp_at_point ( const occ::dma::Mult multipole,
const Vec3 site_position,
const Vec3 eval_point 
) const

Compute ESP at a point due to a single multipole site.

Parameters
multipoleThe multipole object
site_positionPosition of the multipole site
eval_pointPosition where ESP is evaluated
Returns
ESP value in atomic units

◆ compute_esp_at_points()

std::vector< double > occ::mults::MultipoleESP::compute_esp_at_points ( const occ::dma::Mult multipole,
const Vec3 site_position,
const std::vector< Vec3 > &  eval_points 
) const

Compute ESP at multiple points due to a single multipole site.

Parameters
multipoleThe multipole object
site_positionPosition of the multipole site
eval_pointsPositions where ESP is evaluated
Returns
ESP values in atomic units

◆ compute_interaction_energy()

double occ::mults::MultipoleESP::compute_interaction_energy ( const occ::dma::Mult mult1,
const Vec3 pos1,
const occ::dma::Mult mult2,
const Vec3 pos2 
) const

Compute interaction energy between two multipole sites.

Parameters
mult1First multipole
pos1Position of first multipole
mult2Second multipole
pos2Position of second multipole
Returns
Interaction energy in atomic units

The documentation for this class was generated from the following file: