Constraints::HomogeneousMagneticField Class Reference

#include <HomogeneousMagneticField.hpp>

Inheritance diagram for Constraints::HomogeneousMagneticField:

Collaboration diagram for Constraints::HomogeneousMagneticField:

Public Member Functions
	HomogeneousMagneticField ()
void	set_H (Utils::Vector3d const &H)
Utils::Vector3d const &	H () const
void	add_energy (const Particle &p, const Utils::Vector3d &, double, Observable_stat &energy) const override
ParticleForce	force (const Particle &p, const Utils::Vector3d &, double) override
bool	fits_in_box (Utils::Vector3d const &) const override
Public Member Functions inherited from Constraints::Constraint
virtual void	reset_force ()
virtual	~Constraint ()=default

Detailed Description

Definition at line 30 of file core/constraints/HomogeneousMagneticField.hpp.

Constructor & Destructor Documentation

HomogeneousMagneticField()

Constraints::HomogeneousMagneticField::HomogeneousMagneticField ( )

inline

Definition at line 32 of file core/constraints/HomogeneousMagneticField.hpp.

Member Function Documentation

add_energy()

void Constraints::HomogeneousMagneticField::add_energy ( const Particle &  p, const Utils::Vector3d &  , double  , Observable_stat &  energy  ) const

overridevirtual

Implements Constraints::Constraint.

Definition at line 38 of file HomogeneousMagneticField.cpp.

References Particle::calc_dip(), and Observable_stat::dipolar.

fits_in_box()

bool Constraints::HomogeneousMagneticField::fits_in_box ( Utils::Vector3d const &  ) const

inlineoverridevirtual

Implements Constraints::Constraint.

Definition at line 44 of file core/constraints/HomogeneousMagneticField.hpp.

force()

ParticleForce Constraints::HomogeneousMagneticField::force ( const Particle &  p, const Utils::Vector3d &  , double    )

overridevirtual

Implements Constraints::Constraint.

Definition at line 29 of file HomogeneousMagneticField.cpp.

References Particle::calc_dip(), and vector_product().

H()

Utils::Vector3d const & Constraints::HomogeneousMagneticField::H ( ) const

inline

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

Referenced by set_H().

set_H()

void Constraints::HomogeneousMagneticField::set_H ( Utils::Vector3d const &  H )

inline

Definition at line 34 of file core/constraints/HomogeneousMagneticField.hpp.

References H().

---

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

• core/constraints/HomogeneousMagneticField.hpp
• HomogeneousMagneticField.cpp