logging.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
//
//    FCST: Fuel Cell Simulation Toolbox
//
//    Copyright (C) 2013 by Energy Systems Design Laboratory, University of Alberta
//
//    This software is distributed under the MIT License.
//    For more information, see the README file in /doc/LICENSE
//
//    - Description: Logging objects to be used throughout fcst
//    - Developers: Philip Wardlaw
//    - $Id: fcst_utilities.h 2605 2014-08-15 03:36:44Z secanell $
//
//---------------------------------------------------------------------------

#include <base/logstream.h>
#include <base/utilities.h>

using namespace dealii;

#ifndef _FCST_LOGGING
#define _FCST_LOGGING

namespace FcstUtilities
{
    // Needed to declare extern file below
    class FCSTLogStream;    
    extern FCSTLogStream log;
    
    class FCSTLogStream
    {
    public:
        FCSTLogStream (std::ostream &stream);
        
        ~FCSTLogStream();
        
        void attach (std::ostream &o,
                     const bool    print_job_id = true);
        
        
        void detach ();        
        
        /*void test_mode (bool on=true)
        {
          //  internal_log.test_mode(on);
        }
        */
        
        /*
        std::ostream &get_console ()
        {
           // return internal_log.get_console();
        }
        */
        
        
        std::ostream &get_file_stream ()
        {
           // return internal_log.get_file_stream();
        }
        
        
        bool has_file () const
        {
          return (file != 0);
        }
        
        void push (const std::string &text)
        {
            
        }
        
        
        void pop ()
        {
            
        }
        
        
        unsigned int depth_console (const unsigned int n)
        {
            //return internal_log.depth_console(n);
        }
        
        
        unsigned int depth_file (const unsigned int n)
        {}
          
        template <typename T>
        const FCSTLogStream &
        operator << (const T &t) const;
        
        const FCSTLogStream &
        operator<< (std::ostream& (*p) (std::ostream &)) const;
        
        //std::size_t memory_consumption () const;
        
    private:
        std::ostream&  output_stream;
        
        std::ostream  *file;
    };
    
    
    // --------------------------- inline and template functions -----------    
    template <class T>
    inline const FCSTLogStream &
    FCSTLogStream::operator<< (const T &t) const
    {
      //  #ifdef OPENFCST_WITH_PETSC
        if (Utilities::MPI::this_mpi_process(MPI_COMM_WORLD) == 0)
     //   #endif
        {
            // Print to screen
            output_stream<<t;
            
            // and to file
            if (has_file() )
                *file<<t;
        }
        
        return *this;
    }
    
    //----
    inline const FCSTLogStream & 
    FCSTLogStream::operator<< (std::ostream& (*p) (std::ostream &)) const
    {
      //  #ifdef OPENFCST_WITH_PETSC
        if (Utilities::MPI::this_mpi_process(MPI_COMM_WORLD) == 0)
     //   #endif
        {
            output_stream<<p;
            
            // and to file
            if (has_file() )
                *file<<p;
        }
        
        return *this;
    }    

}
    
#endif //_FCST_LOGGING