EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_XMLReader.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ***********************************************************************
4 //
5 // EpetraExt: Epetra Extended - 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 EPETRAEXT_XMLREADER_H
45 #define EPETRAEXT_XMLREADER_H
46 
47 #if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
48 #ifdef __GNUC__
49 #warning "The EpetraExt package is deprecated"
50 #endif
51 #endif
52 
53 #include "EpetraExt_ConfigDefs.h"
54 #include "Epetra_ConfigDefs.h"
55 #include "Teuchos_RCP.hpp"
56 #include <fstream>
57 #include <vector>
58 
59 class Epetra_Map;
60 class Epetra_Comm;
61 class Epetra_MultiVector;
62 class Epetra_CrsGraph;
63 class Epetra_CrsMatrix;
64 namespace Teuchos {
65  class FileXML;
66  class XMLObject;
67  class ParameterList;
68 }
69 
70 namespace EpetraExt
71 {
120 {
121  public:
122  // @{ \name Constructor and destructor.
124  XMLReader(const Epetra_Comm& Comm, const std::string& FileName);
125 
128 
129  // @}
130  // @{ \name Read operations
131 
132 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
133  void Read(const std::string& Label, Epetra_Map*& Map);
135 #endif
136 
137 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
138  void Read64(const std::string& Label, Epetra_Map*& Map);
140 #endif
141 
142 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
143  void Read(const std::string& Label, Epetra_CrsGraph*& Graph);
145 #endif
146 
147 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
148  void Read64(const std::string& Label, Epetra_CrsGraph*& Graph);
150 #endif
151 
152 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
153  void Read(const std::string& Label, Epetra_CrsMatrix*& Matrix);
155 #endif
156 
157 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
158  void Read64(const std::string& Label, Epetra_CrsMatrix*& Matrix);
160 #endif
161 
162 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
163  void Read(const std::string& Label, Epetra_MultiVector*& MultiVector);
165 #endif
166 
167 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
168  void Read64(const std::string& Label, Epetra_MultiVector*& MultiVector);
170 #endif
171 
173  void Read(const std::string& Label, std::vector<std::string>& Content);
174 
176  void Read(const std::string& Label, Teuchos::ParameterList& List);
177 
178  // @}
179  private:
181  bool IsOpen_;
186 };
187 
188 } // namespace EpetraExt
189 
190 #endif
void Read(const std::string &Label, Epetra_Map *&Map)
Reads the Epetra_Map stored with label Label.
Teuchos::RCP< Teuchos::XMLObject > fileXML_
parsed XML object.
const Epetra_Comm & Comm_
Communicator object.
XMLReader(const Epetra_Comm &Comm, const std::string &FileName)
ctor
class XMLReader: A class for reading Epetra objects stored in XML files.
void Read64(const std::string &Label, Epetra_Map *&Map)
Reads the Epetra_Map stored with label Label. Long Long version.
bool IsOpen_
If true, then the file has been successfully opened.