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