SourceAmplitude.h

Go to the documentation of this file.

/* Copyright 2018 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_SOURCE_AMPLITUDE
#define COM_DAFER45_TBTK_SOURCE_AMPLITUDE

#include "TBTK/Index.h"
#include "TBTK/Serializable.h"

#include <complex>
#include <initializer_list>
#include <vector>

namespace TBTK{

class SourceAmplitude : public Serializable{
public:
    class AmplitudeCallback{
    public:
        virtual std::complex<double> getSourceAmplitude(
            const Index &index
        ) const = 0;
    };

    SourceAmplitude();

    SourceAmplitude(std::complex<double> amplitude, Index index);

    SourceAmplitude(
        const AmplitudeCallback &amplitudeCallback,
        Index index
    );

    SourceAmplitude(
        const std::string &serializeation,
        Serializable::Mode mode
    );

    std::complex<double> getAmplitude() const;

    const Index& getIndex() const;

    std::string toString() const;

    std::string serialize(Serializable::Mode mode) const;

    unsigned int getSizeInBytes() const;
private:
    std::complex<double> amplitude;

    const AmplitudeCallback *amplitudeCallback;

    Index index;

};

inline SourceAmplitude::SourceAmplitude() : amplitudeCallback(nullptr){
}

inline std::complex<double> SourceAmplitude::getAmplitude() const{
    if(amplitudeCallback)
        return amplitudeCallback->getSourceAmplitude(index);
    else
        return amplitude;
}

inline const Index& SourceAmplitude::getIndex() const{
    return index;
}

inline std::string SourceAmplitude::toString() const{
    std::string str;
    str += "("
            + std::to_string(real(amplitude))
            + ", " + std::to_string(imag(amplitude))
        + ")"
        + ", " + index.toString();

    return str;
}

inline unsigned int SourceAmplitude::getSizeInBytes() const{
    return sizeof(SourceAmplitude)
        - sizeof(index)
        + index.getSizeInBytes();
}

};  //End of namespace TBTK

#endif