GHFErrorCalculation.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/Algorithm/Step.hpp"
#include "QCMethod/HF/GHF/GHFSCFEnvironment.hpp"
#include "QCModel/HF/GHF.hpp"
 
 
namespace GQCP {
 
 
template <typename _Scalar>
class GHFErrorCalculation:
    public Step<GHFSCFEnvironment<_Scalar>> {
 
public:
    using Scalar = _Scalar;
    using Environment = GHFSCFEnvironment<Scalar>;
 
 
public:
    /*
     *  OVERRIDDEN PUBLIC METHODS
     */
 
    std::string description() const override {
        return "Calculate the current error vector and add it to the environment.";
    }
 
 
    void execute(Environment& environment) override {
 
        // Read F, D and S from the environment.
        const auto& D = environment.density_matrices.back();
        const auto& S = environment.S;
        const auto& F = environment.fock_matrices.back();
 
        // Calculate the error and write it to the environment (as a vector).
        const auto error_matrix = QCModel::GHF<Scalar>::calculateError(F, D, S);
        environment.error_vectors.push_back(error_matrix.pairWiseStrictReduced());
    }
};
 
 
}  // namespace GQCP