suanPan
AbsIncreEnergy.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright (C) 2017-2022 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  ******************************************************************************/
36 #ifndef ABSINCREENERGY_H
37 #define ABSINCREENERGY_H
38 
39 #include "Converger.h"
40 
41 class AbsIncreEnergy final : public Converger {
42 public:
43  explicit AbsIncreEnergy(unsigned = 0, double = 1E-8, unsigned = 7, bool = false);
44 
45  unique_ptr<Converger> get_copy() override;
46 
47  bool is_converged() override;
48 };
49 
50 #endif
51 
The AbsIncreEnergy class handles converger test to indicate if the iteration converges.
Definition: AbsIncreEnergy.h:41
AbsIncreEnergy(unsigned=0, double=1E-8, unsigned=7, bool=false)
The complete constructor.
Definition: AbsIncreEnergy.cpp:29
bool is_converged() override
Definition: AbsIncreEnergy.cpp:34
unique_ptr< Converger > get_copy() override
Definition: AbsIncreEnergy.cpp:32
The Converger class handles converger test to indicate if the iteration converges according to variou...
Definition: Converger.h:44