Converger.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (C) 2017-2024 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 CONVERGER_H
#define CONVERGER_H
 
#include <Domain/Tag.h>
 
class DomainBase;
 
class Converger : public Tag {
    weak_ptr<DomainBase> database; 
    double tolerance; 
    unsigned max_iteration; 
    const bool print_flag; 
    double error = 0.; 
    bool conv_flag = false; 
protected:
    [[nodiscard]] vec get_residual() const;
 
    [[nodiscard]] bool is_print() const;
 
public:
    explicit Converger(unsigned = 0, double = 1E-8, unsigned = 10, bool = false);
    Converger(const Converger&) = default;
    Converger(Converger&&) = default;
    Converger& operator=(const Converger&) = delete;
    Converger& operator=(Converger&&) = delete;
    ~Converger() override = default;
 
    virtual int initialize();
 
    virtual unique_ptr<Converger> get_copy() = 0;
 
    void set_tolerance(double);
    [[nodiscard]] double get_tolerance() const;
 
    void set_max_iteration(unsigned);
    [[nodiscard]] unsigned get_max_iteration() const;
 
    void set_domain(const weak_ptr<DomainBase>&);
    [[nodiscard]] const weak_ptr<DomainBase>& get_domain() const;
 
    virtual void set_error(double);
    [[nodiscard]] double get_error() const;
 
    virtual void set_conv_flag(bool);
    [[nodiscard]] bool get_conv_flag() const;
 
    virtual bool is_converged(unsigned) = 0;
};
 
#endif