suanPan
RelError.h
Go to the documentation of this file.
1/*******************************************************************************
2 * Copyright (C) 2017-2024 Theodore Chang
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 ******************************************************************************/
29#ifndef RELERROR_H
30#define RELERROR_H
31
32#include "Converger.h"
33
34class RelError final : public Converger {
35public:
36 explicit RelError(unsigned = 0, double = 1E-8, unsigned = 7, bool = false);
37
38 unique_ptr<Converger> get_copy() override;
39
40 bool is_converged(unsigned) override;
41};
42
43#endif
44
The Converger class handles converger test to indicate if the iteration converges according to variou...
Definition: Converger.h:44
The RelError class that handles converger test to indicate if the iteration converges.
Definition: RelError.h:34
unique_ptr< Converger > get_copy() override
Definition: RelError.cpp:32
bool is_converged(unsigned) override
Method to return conv_flag.
Definition: RelError.cpp:38
RelError(unsigned=0, double=1E-8, unsigned=7, bool=false)
The default constructor.
Definition: RelError.cpp:29