Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
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// ************************************************************************
38// @HEADER
39
40#ifndef TPETRA_CORE_HPP
41#define TPETRA_CORE_HPP
42
51
52#include <Tpetra_ConfigDefs.hpp>
53#include <Teuchos_Comm.hpp>
54#ifdef HAVE_TPETRACORE_MPI
55# include "mpi.h"
56#endif // HAVE_TPETRACORE_MPI
57
58namespace Tpetra {
59
69 Teuchos::RCP<const Teuchos::Comm<int> > getDefaultComm ();
70
77 bool isInitialized ();
78
104 void initialize (int* argc, char*** argv);
105
106#ifdef HAVE_TPETRA_MPI
132 void initialize (int* argc, char*** argv, MPI_Comm comm);
133#endif // HAVE_TPETRA_MPI
134
164 void
165 initialize (int* argc, char*** argv,
166 const Teuchos::RCP<const Teuchos::Comm<int> >& comm);
167
178 void finalize ();
179
220 public:
228 ScopeGuard (int* argc, char*** argv);
229
230#ifdef HAVE_TPETRA_MPI
242 ScopeGuard (int* argc, char*** argv, MPI_Comm comm);
243#endif // HAVE_TPETRA_MPI
244
249 ScopeGuard () = delete;
250
256 ~ScopeGuard ();
257 };
258
259} // namespace Tpetra
260
261#endif // TPETRA_CORE_HPP
Scope guard whose destructor automatically calls Tpetra::finalize for you.
ScopeGuard()=delete
Default constructor (FORBIDDEN)
~ScopeGuard()
Finalize Tpetra.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
void initialize(int *argc, char ***argv)
Initialize Tpetra.
bool isInitialized()
Whether Tpetra is in an initialized state.
void finalize()
Finalize Tpetra.
Teuchos::RCP< const Teuchos::Comm< int > > getDefaultComm()
Get Tpetra's default communicator.