Epetra Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Epetra_Time.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Epetra: Linear Algebra Services Package
6 // Copyright 2011 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 */
43 
44 #ifndef EPETRA_TIME_H
45 #define EPETRA_TIME_H
46 
47 #if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
48 #ifdef __GNUC__
49 #warning "The Epetra package is deprecated"
50 #endif
51 #endif
52 
53 
54 
56 
66 #include "Epetra_ConfigDefs.h"
67 #include "Epetra_Object.h"
68 #include "Epetra_Comm.h"
69 
70 #ifdef EPETRA_MPI
71 #include <mpi.h>
72 #else
73 #if ICL || defined(_WIN32)
74 #include <time.h>
75 #else
76 #include <sys/time.h>
77 #ifndef MINGW
78 #include <sys/resource.h>
79 #endif
80 #endif
81 #endif
82 
83 class EPETRA_LIB_DLL_EXPORT Epetra_Time: public Epetra_Object {
84 
85  public:
87 
91  Epetra_Time(const Epetra_Comm & Comm);
92 
94 
96  Epetra_Time(const Epetra_Time& Time);
97 
99 
103  double WallTime(void) const;
104 
106 
110  void ResetStartTime(void);
111 
113 
119  double ElapsedTime(void) const;
120 
122 
124  virtual ~Epetra_Time(void);
125 
127  {
128  StartTime_ = src.StartTime_;
129  Comm_ = src.Comm_;
130  return( *this );
131  }
132 
133  private:
134 
135  double StartTime_;
137 
138 };
139 
140 #endif /* EPETRA_TIME_H */
const Epetra_Comm * Comm_
Definition: Epetra_Time.h:136
Epetra_Time: The Epetra Timing Class.
Definition: Epetra_Time.h:83
double StartTime_
Definition: Epetra_Time.h:135
Epetra_Comm: The Epetra Communication Abstract Base Class.
Definition: Epetra_Comm.h:81
Epetra_Object: The base Epetra class.
Definition: Epetra_Object.h:65
Epetra_Time & operator=(const Epetra_Time &src)
Definition: Epetra_Time.h:126