-
Notifications
You must be signed in to change notification settings - Fork 4
/
EndCriteria.py
executable file
·80 lines (69 loc) · 1.59 KB
/
EndCriteria.py
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
#! /usr/bin/env python3
'''
Niema Moshiri 2016
"EndCriteria" module
'''
import abc
class EndCriteria(metaclass=abc.ABCMeta):
'''
Abstract class defining the ``EndCriteria`` module
Methods
-------
cite()
Return citation string (or None)
done()
Returns True if this simulation is done, or False otherwise
finalize_time()
Finalize the global time
init()
Initialize the module (if need be)
not_done()
Returns True if this simulation is not done, or False otherwise
'''
@staticmethod
@abc.abstractmethod
def init():
'''
Initialize the module (if need be)
'''
pass
@staticmethod
@abc.abstractmethod
def cite():
'''
Return citation string (or None)
Returns
-------
citation : str
The citation string (or None)
'''
pass
@staticmethod
@abc.abstractmethod
def done():
'''
Returns True if this simulation is done, or False otherwise
Returns
-------
done : bool
True if this simulation is done, or False otherwise
'''
pass
@staticmethod
@abc.abstractmethod
def finalize_time():
'''
Finalize the global time
'''
pass
@staticmethod
@abc.abstractmethod
def not_done():
'''
Returns True if this simulation is not done, or False otherwise
Returns
-------
done : bool
True if this simulation is not done, or False otherwise
'''
pass