swappable_vector.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2000 - 2017 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------

#ifndef dealii__swappable_vector_h
#define dealii__swappable_vector_h


#include <deal.II/base/config.h>
#include <deal.II/base/thread_management.h>
#include <deal.II/lac/vector.h>
#include <string>

DEAL_II_NAMESPACE_OPEN

template <typename number>
class SwappableVector : public Vector<number>
{
public:
  SwappableVector ();

  SwappableVector (const SwappableVector &v);

  virtual ~SwappableVector ();

  SwappableVector &operator = (const SwappableVector &);

  void swap_out (const std::string &filename);

  void reload ();

  void alert ();


  void kill_file ();

  const std::string &get_filename () const;

  std::size_t memory_consumption () const;

  DeclException0 (ExcSizeZero);
  DeclException0 (ExcSizeNonzero);
  DeclException1 (ExcInvalidFilename,
                  std::string,
                  << "The filename <" << arg1
                  << "> is not a valid one here.");
  DeclException0 (ExcInvalidCopyOperation);
private:
  std::string filename;

  Threads::Mutex lock;

  bool data_is_preloaded;

  void reload_vector (const bool set_flag);
} DEAL_II_DEPRECATED;

/*----------------------------   swappable_vector.h     ---------------------------*/
/* end of #ifndef dealii__swappable_vector_h */
DEAL_II_NAMESPACE_CLOSE

#endif
/*----------------------------   swappable_vector.h     ---------------------------*/