suanPan
RelResidual.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 ******************************************************************************/
41#ifndef RELRESIDUAL_H
42#define RELRESIDUAL_H
43
44#include "Converger.h"
45
46class DomainBase;
47
48class RelResidual final : public Converger {
49 double ref_residual = 0.;
50
51public:
52 explicit RelResidual(unsigned = 0, double = 1E-8, unsigned = 7, bool = false);
53
54 unique_ptr<Converger> get_copy() override;
55
56 bool is_converged(unsigned) override;
57};
58
59#endif
60
The Converger class handles converger test to indicate if the iteration converges according to variou...
Definition: Converger.h:44
The DomainBase class is a template.
Definition: DomainBase.h:104
The Converger class handles converger test to indicate if the iteration converges according to variou...
Definition: RelResidual.h:48
unique_ptr< Converger > get_copy() override
Definition: RelResidual.cpp:23
RelResidual(unsigned=0, double=1E-8, unsigned=7, bool=false)
Definition: RelResidual.cpp:20
bool is_converged(unsigned) override
Definition: RelResidual.cpp:25