faunus
Public Member Functions | List of all members
Faunus::pairpotential::CompleteCigarPotential< PatchPotential, CylinderPotential, SphereWithSphere > Class Template Reference

Set pair potential between cigar-cigar, sphere-sphere, cigar-sphere. More...

#include <spherocylinder.h>

Inheritance diagram for Faunus::pairpotential::CompleteCigarPotential< PatchPotential, CylinderPotential, SphereWithSphere >:
Inheritance graph
[legend]
Collaboration diagram for Faunus::pairpotential::CompleteCigarPotential< PatchPotential, CylinderPotential, SphereWithSphere >:
Collaboration graph
[legend]

Public Member Functions

double operator() (const Particle &a, const Particle &b, [[maybe_unused]] double distance_squared, const Point &distance) const override
 
void to_json ([[maybe_unused]] json &j) const override
 
void from_json (const json &j) override
 
- Public Member Functions inherited from Faunus::pairpotential::PairPotential
virtual void to_json (json &) const =0
 
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...
 
virtual double operator() (const Particle &particle_a, const Particle &particle_b, double squared_distance, const Point &b_towards_a) const =0
 Pair energy between two particles. More...
 

Additional Inherited Members

- 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)
 
- Protected Member Functions inherited from Faunus::pairpotential::PairPotential
 PairPotential (std::string name=std::string(), std::string cite=std::string(), bool isotropic=true)
 

Detailed Description

template<pairpotential::RequirePairPotential PatchPotential, pairpotential::RequirePairPotential CylinderPotential, pairpotential::RequirePairPotential SphereWithSphere = CylinderPotential>
class Faunus::pairpotential::CompleteCigarPotential< PatchPotential, CylinderPotential, SphereWithSphere >

Set pair potential between cigar-cigar, sphere-sphere, cigar-sphere.

This takes three pair potentials that will be called dependent on the nature of the two particles. If the sphero-cylinder has zero length it is assumed to be a spherical, isotropic particle.

Template Parameters
PatchPotentialPair potential used for patch part (isotropic, e.g. CosAttract)
CylinderPotentialPair potential used for cylindrical path (isotropic, e.g. WCA)
CylinderPotentialPair potential used sphere-sphere interaction (isotropic, e.g. WCA)

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