SingleParticleContext.h

Go to the documentation of this file.

/* Copyright 2016 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef COM_DAFER45_TBTK_SINGLE_PARTICLE_CONTEXT
#define COM_DAFER45_TBTK_SINGLE_PARTICLE_CONTEXT
 
#include "TBTK/BasisStateSet.h"
#include "TBTK/Geometry.h"
#include "TBTK/HoppingAmplitudeSet.h"
#include "TBTK/OverlapAmplitudeSet.h"
#include "TBTK/Serializable.h"
#include "TBTK/SourceAmplitudeSet.h"
#include "TBTK/Statistics.h"
 
namespace TBTK{
 
class FileReader;
 
class SingleParticleContext : public Serializable{
public:
    SingleParticleContext();
 
    SingleParticleContext(const std::vector<unsigned int> &capacity);
 
    SingleParticleContext(const std::string &serialization, Mode mode);
 
    void setStatistics(Statistics statistics);
 
    Statistics getStatistics() const;
 
    void generateHoppingAmplitudeSet(
        const HoppingAmplitude::AmplitudeCallback
            &hoppingAmplitudeCallback
    );
 
    void generateOverlapAmplitudeSet(
        const OverlapAmplitude::AmplitudeCallback
            &overlapAmplitudeCallback
    );
 
    BasisStateSet& getBasisStateSet();
 
    const BasisStateSet& getBasisStateSet() const;
 
    HoppingAmplitudeSet& getHoppingAmplitudeSet();
 
    const HoppingAmplitudeSet& getHoppingAmplitudeSet() const;
 
    SourceAmplitudeSet& getSourceAmplitudeSet();
 
    const SourceAmplitudeSet& getSourceAmplitudeSet() const;
 
    OverlapAmplitudeSet& getOverlapAmplitudeSet();
 
    const OverlapAmplitudeSet& getOverlapAmplitudeSet() const;
 
    Geometry& getGeometry();
 
    const Geometry& getGeometry() const;
 
    std::string serialize(Mode mode) const;
private:
    BasisStateSet basisStateSet;
 
    HoppingAmplitudeSet hoppingAmplitudeSet;
 
    SourceAmplitudeSet sourceAmplitudeSet;
 
    OverlapAmplitudeSet overlapAmplitudeSet;
 
    Statistics statistics;
 
    Geometry geometry;
 
    friend class FileReader;
};
 
inline void SingleParticleContext::setStatistics(Statistics statistics){
    this->statistics = statistics;
}
 
inline Statistics SingleParticleContext::getStatistics() const{
    return statistics;
}
 
inline BasisStateSet& SingleParticleContext::getBasisStateSet(){
    return basisStateSet;
}
 
inline const BasisStateSet& SingleParticleContext::getBasisStateSet() const{
    return basisStateSet;
}
 
inline HoppingAmplitudeSet& SingleParticleContext::getHoppingAmplitudeSet(){
    return hoppingAmplitudeSet;
}
 
inline const HoppingAmplitudeSet&
SingleParticleContext::getHoppingAmplitudeSet() const{
    return hoppingAmplitudeSet;
}
 
inline SourceAmplitudeSet& SingleParticleContext::getSourceAmplitudeSet(){
    return sourceAmplitudeSet;
}
 
inline const SourceAmplitudeSet&
SingleParticleContext::getSourceAmplitudeSet() const{
    return sourceAmplitudeSet;
}
 
inline OverlapAmplitudeSet& SingleParticleContext::getOverlapAmplitudeSet(){
    return overlapAmplitudeSet;
}
 
inline const OverlapAmplitudeSet&
SingleParticleContext::getOverlapAmplitudeSet() const{
    return overlapAmplitudeSet;
}
 
inline Geometry& SingleParticleContext::getGeometry(){
    return geometry;
}
 
inline const Geometry& SingleParticleContext::getGeometry() const{
    return geometry;
}
 
};  //End of namespace TBTK
 
#endif