EpetraExt Development
Loading...
Searching...
No Matches
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
48#include "Teuchos_RCP.hpp"
49#include <fstream>
50#include <vector>
51
52class Epetra_Map;
53class Epetra_Comm;
54class Epetra_Map;
56class Epetra_CrsGraph;
58namespace Teuchos {
59 class FileXML;
60 class XMLObject;
61 class ParameterList;
62}
63
64namespace EpetraExt
65{
169{
170 public:
171 // @{ \name Constructor and destructor.
173 XMLWriter(const Epetra_Comm& Comm, const std::string& FileName);
174
177
179 void Create(const std::string& Label);
180
182 void Close();
183
184 // @}
185 // @{ \name Read operations
186
188 void Write(const std::string& Label, const Epetra_Map& Map);
189
191 void Write(const std::string& Label, const Epetra_RowMatrix& Matrix);
192
194 void Write(const std::string& Label, const Epetra_MultiVector& MultiVector);
195
197 void Write(const std::string& Label, const std::vector<std::string>& Content);
198
200 void Write(const std::string& Label, const std::string& Text)
201 {
202 std::vector<std::string> Content;
203 Content.push_back(Text);
204 Write(Label, Content);
205 }
206
208 void Write(const std::string& Label, Teuchos::ParameterList& List);
209
210 // @}
211 private:
213 const Epetra_Comm& Comm_;
215 std::string FileName_;
217 bool IsOpen_;
218};
219
220} // namespace EpetraExt
221
222#endif
class XMLWriter: A class for writing Trilinos objects to XML files.
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.
void Create(const std::string &Label)
Creates the file, giving Label to the whole object.
XMLWriter(const Epetra_Comm &Comm, const std::string &FileName)
ctor
void Write(const std::string &Label, const std::string &Text)
Writes input std::string using label Label.
EpetraExt::BlockCrsMatrix: A class for constructing a distributed block matrix.