EpetraExt Package Browser (Single Doxygen Collection)  Development
EpetraExt_XMLWriter.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_XMLWRITER_H
45 #define EPETRAEXT_XMLWRITER_H
46 
47 #include "EpetraExt_ConfigDefs.h"
48 #include "Teuchos_RCP.hpp"
49 #include <fstream>
50 
51 class Epetra_Map;
52 class Epetra_Comm;
53 class Epetra_Map;
54 class Epetra_MultiVector;
55 class Epetra_CrsGraph;
56 class Epetra_RowMatrix;
57 namespace Teuchos {
58  class FileXML;
59  class XMLObject;
60  class ParameterList;
61 }
62 
63 namespace EpetraExt
64 {
168 {
169  public:
170  // @{ \name Constructor and destructor.
172  XMLWriter(const Epetra_Comm& Comm, const std::string& FileName);
173 
176 
178  void Create(const std::string& Label);
179 
181  void Close();
182 
183  // @}
184  // @{ \name Read operations
185 
187  void Write(const std::string& Label, const Epetra_Map& Map);
188 
190  void Write(const std::string& Label, const Epetra_RowMatrix& Matrix);
191 
193  void Write(const std::string& Label, const Epetra_MultiVector& MultiVector);
194 
196  void Write(const std::string& Label, const std::vector<std::string>& Content);
197 
199  void Write(const std::string& Label, const std::string& Text)
200  {
201  std::vector<std::string> Content;
202  Content.push_back(Text);
203  Write(Label, Content);
204  }
205 
207  void Write(const std::string& Label, Teuchos::ParameterList& List);
208 
209  // @}
210  private:
214  std::string FileName_;
216  bool IsOpen_;
217 };
218 
219 } // namespace EpetraExt
220 
221 #endif
std::string FileName_
Name of the file.
class XMLWriter: A class for writing Trilinos objects to XML files.
XMLWriter(const Epetra_Comm &Comm, const std::string &FileName)
ctor
EpetraExt::BlockCrsMatrix: A class for constructing a distributed block matrix.
void Write(const std::string &Label, const std::string &Text)
Writes input std::string using label Label.
void Create(const std::string &Label)
Creates the file, giving Label to the whole object.
bool IsOpen_
If true, the file has been successfully opened.
const Epetra_Comm & Comm_
Epetra communicator.
void Close()
Closes the file. No Write operations can follow.
void Write(const std::string &Label, const Epetra_Map &Map)
Writes an Epetra_Map using label Label.