Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Core.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef TPETRA_CORE_HPP
43 #define TPETRA_CORE_HPP
44 
53 
54 #include <Tpetra_ConfigDefs.hpp>
55 #include <Teuchos_Comm.hpp>
56 #ifdef HAVE_TPETRACORE_MPI
57 # include "mpi.h"
58 #endif // HAVE_TPETRACORE_MPI
59 
60 namespace Tpetra {
61 
71  Teuchos::RCP<const Teuchos::Comm<int> > getDefaultComm ();
72 
79  bool isInitialized ();
80 
106  void initialize (int* argc, char*** argv);
107 
108 #ifdef HAVE_TPETRA_MPI
109  void initialize (int* argc, char*** argv, MPI_Comm comm);
135 #endif // HAVE_TPETRA_MPI
136 
166  void
167  initialize (int* argc, char*** argv,
168  const Teuchos::RCP<const Teuchos::Comm<int> >& comm);
169 
180  void finalize ();
181 
221  class ScopeGuard {
222  public:
230  ScopeGuard (int* argc, char*** argv);
231 
232 #ifdef HAVE_TPETRA_MPI
233  ScopeGuard (int* argc, char*** argv, MPI_Comm comm);
245 #endif // HAVE_TPETRA_MPI
246 
251  ScopeGuard () = delete;
252 
258  ~ScopeGuard ();
259  };
260 
261 } // namespace Tpetra
262 
263 #endif // TPETRA_CORE_HPP
~ScopeGuard()
Finalize Tpetra.
bool isInitialized()
Whether Tpetra is in an initialized state.
void initialize(int *argc, char ***argv)
Initialize Tpetra.
Scope guard whose destructor automatically calls Tpetra::finalize for you.
void finalize()
Finalize Tpetra.
Teuchos::RCP< const Teuchos::Comm< int > > getDefaultComm()
Get Tpetra&#39;s default communicator.
ScopeGuard()=delete
Default constructor (FORBIDDEN)