HomogeneousMagneticField.hpp

Go to the documentation of this file.

// This file is part of GQCG-GQCP.
//
// Copyright (C) 2017-2020  the GQCG developers
//
// GQCG-GQCP is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GQCG-GQCP is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with GQCG-GQCP.  If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
 
#include "Mathematical/Representation/Matrix.hpp"
 
 
namespace GQCP {
 
 
class HomogeneousMagneticField {
private:
    // The field strength.
    Vector<double, 3> B;
 
    // The gauge origin.
    Vector<double, 3> G;
 
 
public:
    /*
     *  MARK: Constructors
     */
 
    HomogeneousMagneticField(const Vector<double, 3>& B, const Vector<double, 3>& G = Vector<double, 3>::Zero());
 
 
    /*
     *  MARK: Physics
     */
 
    const Vector<double, 3>& strength() const { return this->B; }
 
    const Vector<double, 3>& gaugeOrigin() const { return this->G; }
 
    Vector<double, 3> vectorPotentialAt(const Vector<double, 3>& r) const;
};
 
 
}  // namespace GQCP