File: Failure.h

package info (click to toggle)
ergo 3.5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 17,044 kB
  • ctags: 6,813
  • sloc: cpp: 91,488; ansic: 15,728; sh: 6,416; makefile: 1,287; yacc: 123; lex: 108
file content (88 lines) | stat: -rw-r--r-- 3,182 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/* Ergo, version 3.5, a program for linear scaling electronic structure
 * calculations.
 * Copyright (C) 2016 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
 * and Anastasia Kruchinina.
 * 
 * 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/>.
 * 
 * Primary academic reference:
 * Kohn−Sham Density Functional Theory Electronic Structure Calculations 
 * with Linearly Scaling Computational Time and Memory Usage,
 * Elias Rudberg, Emanuel H. Rubensson, and Pawel Salek,
 * J. Chem. Theory Comput. 7, 340 (2011),
 * <http://dx.doi.org/10.1021/ct100611z>
 * 
 * For further information about Ergo, see <http://www.ergoscf.org>.
 */

/* The Failure class is used for exception handling.                *
 * It inherits std::exception which means that an instance of this  *
 * class can be caught by catching std::exception&                  *
 * The "&" must be there, otherwise the failure message             *
 * will be "cut out".                                               *
 * Retrieve the message with a call to the member function "what()" *  
 *                                                                  *
 *                                                                  *
 *     \\\|||///  \    (C) Emanuel Rubensson, August, 2005          *
 *     \ ~   ~ /   \                                                *
 *     | @   @ |    \  mail:  emanuel@theochem.kth.se               *
 * oOo---(_)---oOo---\----------------------------------------------*
 *                                                                  */

#ifndef FAILURE
#define FAILURE
#include <exception>
namespace mat
{
  class Failure : public std::exception {
      const char* message;
    public:
      Failure()
	:message("Failure: No failure information available")
	{}
      explicit Failure (const char* msg)
	:message(msg)
	{}
      virtual ~Failure() throw() {}
      virtual const char* what() const throw()
	{return message;}
  };

  class Acceptable : public Failure {
  public:
    Acceptable()
      :Failure("Acceptable: No acceptable failure information available")
      {}
    explicit Acceptable (const char* msg)
      :Failure(msg)
      {}
  };
  
  class AcceptableMaxIter : public Acceptable {
    int maxiter;
  public:
    AcceptableMaxIter()
      :Acceptable("AcceptableMaxIter: No acceptable failure information available"),
      maxiter(0)
      {}
    explicit AcceptableMaxIter (const char* msg, int maxi = 0)
      :Acceptable(msg), maxiter(maxi)
      {}
    int get_maxiter() const {
      return maxiter;
    }
  };
  
} /* end namespace */
#endif