Amplitude.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (C) 2017-2022 Theodore Chang
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
#ifndef AMPLITUDE_H
#define AMPLITUDE_H

enum class AmplitudeType {
    RAMP,
    TABULAR,
    PERIODIC,
    MODULATED,
    DECAY
};

#include <Domain/Tag.h>

class DomainBase;

class Amplitude : public Tag {
protected:
    unsigned start_step;
    double start_time = 0.; // T0
public:
    explicit Amplitude(unsigned = 0, unsigned = 0);
    ~Amplitude() override = default;

    virtual void initialize(const shared_ptr<DomainBase>&);

    virtual double get_amplitude(double);

    void set_start_step(unsigned);
    [[nodiscard]] unsigned get_start_step() const;

    void set_start_time(double);
    [[nodiscard]] double set_start_time() const;
};

#endif