Faunus::pairpotential::DipoleDipole Class Reference

Inheritance diagram for Faunus::pairpotential::DipoleDipole:

Collaboration diagram for Faunus::pairpotential::DipoleDipole:

Public Member Functions
	DipoleDipole (const std::string &name="dipoledipole", const std::string &cite=std::string())
double	operator() (const Particle &a, const Particle &b, double, const Point &b_towards_a) 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 {}
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)

Member Function Documentation

operator()()

double Faunus::pairpotential::DipoleDipole::operator() ( const Particle &  particle_a, const Particle &  particle_b, double  squared_distance, const Point &  b_towards_a  ) const

inlineoverridevirtual

Pair energy between two particles.

Parameters

particle_a	First particle
particle_b	Second particle
squared_distance	Squared distance, |𝐚-𝐛|²
b_towards_a	Distance vector 𝐛 -> 𝐚 = 𝐚 - 𝐛

Returns

Interaction energy in units of kT

Implements Faunus::pairpotential::PairPotential.

---

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

• src/potentials.h
• src/potentials.cpp