Constraints::ExternalPotential< Coupling, Field > Class Template Reference

Constraint interface for ExternalField::PotentialField. More...

#include <ExternalPotential.hpp>

Inheritance diagram for Constraints::ExternalPotential< Coupling, Field >:

Collaboration diagram for Constraints::ExternalPotential< Coupling, Field >:

Public Member Functions
template<typename... Args>
	ExternalPotential (Args &&...args)
const Coupling &	coupling () const
const Field &	field () const
void	add_energy (const Particle &p, const Utils::Vector3d &folded_pos, double time, Observable_stat &obs_energy) const override
ParticleForce	force (const Particle &p, const Utils::Vector3d &folded_pos, double time) override
bool	fits_in_box (Utils::Vector3d const &box) const override
Public Member Functions inherited from Constraints::Constraint
virtual void	reset_force ()
virtual	~Constraint ()=default

Detailed Description

template<typename Coupling, typename Field>
class Constraints::ExternalPotential< Coupling, Field >

Constraint interface for ExternalField::PotentialField.

Definition at line 31 of file core/constraints/ExternalPotential.hpp.

Constructor & Destructor Documentation

ExternalPotential()

template<typename Coupling , typename Field >

template<typename... Args>

Constraints::ExternalPotential< Coupling, Field >::ExternalPotential ( Args &&...  args )

inline

Definition at line 36 of file core/constraints/ExternalPotential.hpp.

Member Function Documentation

add_energy()

template<typename Coupling , typename Field >

void Constraints::ExternalPotential< Coupling, Field >::add_energy ( const Particle &  p, const Utils::Vector3d &  folded_pos, double  time, Observable_stat &  obs_energy  ) const

inlineoverridevirtual

Implements Constraints::Constraint.

Definition at line 41 of file core/constraints/ExternalPotential.hpp.

References FieldCoupling::PotentialField< Coupling, Field >::energy(), and Observable_stat::external_fields.

coupling()

template<typename Coupling , typename Field >

const Coupling & Constraints::ExternalPotential< Coupling, Field >::coupling ( ) const

inline

Definition at line 38 of file core/constraints/ExternalPotential.hpp.

field()

template<typename Coupling , typename Field >

const Field & Constraints::ExternalPotential< Coupling, Field >::field ( ) const

inline

Definition at line 39 of file core/constraints/ExternalPotential.hpp.

fits_in_box()

template<typename Coupling , typename Field >

bool Constraints::ExternalPotential< Coupling, Field >::fits_in_box ( Utils::Vector3d const &  box ) const

inlineoverridevirtual

Implements Constraints::Constraint.

Definition at line 51 of file core/constraints/ExternalPotential.hpp.

force()

template<typename Coupling , typename Field >

ParticleForce Constraints::ExternalPotential< Coupling, Field >::force ( const Particle &  p, const Utils::Vector3d &  folded_pos, double  time  )

inlineoverridevirtual

Implements Constraints::Constraint.

Definition at line 46 of file core/constraints/ExternalPotential.hpp.

References FieldCoupling::PotentialField< Coupling, Field >::force().

---

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

• core/constraints/ExternalPotential.hpp