UTransformationComponent.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 "Basis/Transformations/SimpleTransformation.hpp"
#include "Basis/Transformations/UOrbitalRotationGeneratorsComponent.hpp"
 
 
namespace GQCP {
 
 
/*
 *  MARK: UTransformationComponent implementation
 */
 
template <typename _Scalar>
class UTransformationComponent:
    public SimpleTransformation<_Scalar, UTransformationComponent<_Scalar>> {
public:
    // The scalar type used for a transformation coefficient: real or complex.
    using Scalar = _Scalar;
 
 
public:
    /*
     *  MARK: Constructors
     */
 
    // Inherit SimpleTransformation' constructors.
    using SimpleTransformation<Scalar, UTransformationComponent<Scalar>>::SimpleTransformation;
};
 
 
/*
 *  MARK: BasisTransformableTraits
 */
 
template <typename Scalar>
struct BasisTransformableTraits<UTransformationComponent<Scalar>> {
 
    // The type of the transformation for which the basis transformation should be defined. A transformation matrix should naturally be transformable with itself.
    using Transformation = UTransformationComponent<Scalar>;
};
 
 
/*
 *  MARK: JacobiRotatableTraits
 */
 
template <typename Scalar>
struct JacobiRotatableTraits<UTransformationComponent<Scalar>> {
 
    // The type of Jacobi rotation for which the Jacobi rotation should be defined.
    using JacobiRotationType = JacobiRotation;
};
 
 
/*
 *  MARK: OrbitalRotationGeneratorTraits
 */
 
template <typename Scalar>
struct OrbitalRotationGeneratorTraits<UTransformationComponent<Scalar>> {
 
    // The type of orbital rotation generators associated with an `UTransformationComponent`.
    using OrbitalRotationGenerators = UOrbitalRotationGeneratorsComponent<Scalar>;
};
 
 
}  // namespace GQCP