sapphirepp-logstream.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2023 by the Sapphire++ authors
//
// This file is part of Sapphire++.
//
// Sapphire++ is free software: you can 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 3 of the License, or (at your option) any
// later version.
//
// Sapphire++ is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Sapphire++. If not, see <https://www.gnu.org/licenses/>.
//
// -----------------------------------------------------------------------------

 
#ifndef UTILS_SAPPHIREPPLOGSTREAM_H
#define UTILS_SAPPHIREPPLOGSTREAM_H
 
#include <deal.II/base/conditional_ostream.h>
#include <deal.II/base/exceptions.h>
#include <deal.II/base/logstream.h>
 
#include <exception>
#include <fstream>
#include <string>

namespace sapphirepp
{

  namespace Utils
  {

    class SapphireppLogStream : public dealii::LogStream
    {
    public:
      SapphireppLogStream();
 

      ~SapphireppLogStream();
 

      void
      init(const unsigned int depth_console     = 2,
           const bool         enable_mpi_output = false);
 

      void
      init(const int argc, const char *const argv[]);
 
 

      void
      init_parse(const int         argc,
                 const char *const argv[],
                 std::string      &parameter_filename,
                 bool             &resume);
 
 

      void
      attach_file(const std::string &filepath,
                  const unsigned int depth_file,
                  const bool         enable_mpi_output = false);
 

      void
      print_error(const std::exception &exc);
 

      void
      print_warning(const std::string &warning);
 

      unsigned int
      get_verbosity_console();

      unsigned int
      get_verbosity_file();
 

      std::ostream &
      to_ostream(const unsigned int verbosity = 3);

      dealii::ConditionalOStream
      to_condition_ostream(const unsigned int verbosity = 3);

      operator std::ostream &();

      operator dealii::ConditionalOStream();
 
 
 
    private:
      std::ofstream log_file;
    };
 
  } // namespace Utils

  extern sapphirepp::Utils::SapphireppLogStream saplog;
} // namespace sapphirepp
#endif