GQCP::HomogeneousMagneticField Class Reference

#include <HomogeneousMagneticField.hpp>

Collaboration diagram for GQCP::HomogeneousMagneticField:

Public Member Functions
	HomogeneousMagneticField (const Vector< double, 3 > &B, const Vector< double, 3 > &G=Vector< double, 3 >::Zero())
const Vector< double, 3 > &	strength () const
const Vector< double, 3 > &	gaugeOrigin () const
Vector< double, 3 >	vectorPotentialAt (const Vector< double, 3 > &r) const

Detailed Description

A type that represents a homogeneous magnetic field.

Constructor & Destructor Documentation

HomogeneousMagneticField()

GQCP::HomogeneousMagneticField::HomogeneousMagneticField	(	const Vector< double, 3 > &	B,
		const Vector< double, 3 > &	G = Vector<double, 3>::Zero()
	)

Initialize a HomogeneousMagneticField from a field strength and gauge origin.

Parameters

B	The field strength.
G	The gauge origin.

Member Function Documentation

gaugeOrigin()

const Vector< double, 3 > & GQCP::HomogeneousMagneticField::gaugeOrigin ( ) const

inline

Returns

The gauge origin of this homogeneous magnetic field.

strength()

const Vector< double, 3 > & GQCP::HomogeneousMagneticField::strength ( ) const

inline

Returns

The field strength of this homogeneous magnetic field.

vectorPotentialAt()

Vector< double, 3 > GQCP::HomogeneousMagneticField::vectorPotentialAt

(

const Vector< double, 3 > &

r

)

const

Calculate the vector potential at a point in space.

Parameters

r	A point in space.

Returns

The vector potential evaluated at the given point.

---

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

• /__w/GQCP/GQCP/gqcp/include/Physical/HomogeneousMagneticField.hpp
• /__w/GQCP/GQCP/gqcp/src/Physical/HomogeneousMagneticField.cpp