EpetraExt_XMLReader.h

Go to the documentation of this file.

/*
//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - Linear Algebra Services Package
//                 Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef EPETRAEXT_XMLREADER_H
#define EPETRAEXT_XMLREADER_H

#if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The EpetraExt package is deprecated"
#endif
#endif

#include "EpetraExt_ConfigDefs.h"
#include "Epetra_ConfigDefs.h"
#include "Teuchos_RCP.hpp"
#include <fstream>
#include <vector>

class Epetra_Map;
class Epetra_Comm;
class Epetra_MultiVector;
class Epetra_CrsGraph;
class Epetra_CrsMatrix;
namespace Teuchos {
  class FileXML;
  class XMLObject;
  class ParameterList;
}

namespace EpetraExt
{
class XMLReader
{
  public:
    // @{ \name Constructor and destructor.
    XMLReader(const Epetra_Comm& Comm, const std::string& FileName);

    ~XMLReader() {}

    // @}
    // @{ \name Read operations

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    void Read(const std::string& Label, Epetra_Map*& Map);
#endif

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
    void Read64(const std::string& Label, Epetra_Map*& Map);
#endif

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    void Read(const std::string& Label, Epetra_CrsGraph*& Graph);
#endif

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
    void Read64(const std::string& Label, Epetra_CrsGraph*& Graph);
#endif

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    void Read(const std::string& Label, Epetra_CrsMatrix*& Matrix);
#endif

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
    void Read64(const std::string& Label, Epetra_CrsMatrix*& Matrix);
#endif

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    void Read(const std::string& Label, Epetra_MultiVector*& MultiVector);
#endif

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
    void Read64(const std::string& Label, Epetra_MultiVector*& MultiVector);
#endif

    void Read(const std::string& Label, std::vector<std::string>& Content);

    void Read(const std::string& Label, Teuchos::ParameterList& List);

    // @}
  private:
    bool IsOpen_;
    const Epetra_Comm& Comm_;
    Teuchos::RCP<Teuchos::XMLObject> fileXML_;
};

} // namespace EpetraExt

#endif