faunus
Public Member Functions | Public Attributes | List of all members
Faunus::pairpotential::Coulomb Class Reference

Plain Coulomb potential. More...

#include <potentials.h>

Inheritance diagram for Faunus::pairpotential::Coulomb:
Inheritance graph
[legend]
Collaboration diagram for Faunus::pairpotential::Coulomb:
Collaboration graph
[legend]

Public Member Functions

 Coulomb (const std::string &name="coulomb")
 
double operator() (const Particle &a, const Particle &b, const double squared_distance, const Point &) const override
 Pair energy between two particles. More...
 
void to_json (json &j) const override
 
- Public Member Functions inherited from Faunus::pairpotential::PairPotential
virtual Point force (const Particle &a, const Particle &b, double squared_distance, const Point &b_towards_a) const
 Force on particle a due to particle b. More...
 

Public Attributes

double bjerrum_length = 0.0
 Bjerrum length.
 
- Public Attributes inherited from Faunus::pairpotential::PairPotential
std::string name
 unique name per polymorphic call; used in FunctorPotential::combinePairPotentials
 
std::string cite
 Typically a short-doi litterature reference.
 
bool isotropic = true
 true if pair-potential is independent of particle orientation
 
std::function< double(const Particle &)> selfEnergy = nullptr
 self energy of particle (kT)
 

Additional Inherited Members

- Protected Member Functions inherited from Faunus::pairpotential::PairPotential
 PairPotential (std::string name=std::string(), std::string cite=std::string(), bool isotropic=true)
 

Detailed Description

Plain Coulomb potential.

Member Function Documentation

◆ operator()()

double Faunus::pairpotential::Coulomb::operator() ( const Particle particle_a,
const Particle particle_b,
const double  squared_distance,
const Point b_towards_a 
) const
inlineoverridevirtual

Pair energy between two particles.

Parameters
particle_aFirst particle
particle_bSecond particle
squared_distanceSquared distance, |𝐚-𝐛|²
b_towards_aDistance vector 𝐛 -> 𝐚 = 𝐚 - 𝐛
Returns
Interaction energy in units of kT

Implements Faunus::pairpotential::PairPotential.


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