memory_info.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license:
// kratos/license.txt
//
//  Main authors:    Pooyan Dadvand
//
 
#if !defined(KRATOS_MEMORY_INFO_H_INCLUDED)
#define KRATOS_MEMORY_INFO_H_INCLUDED
 
// System includes
 
// External includes
 
// Project includes
#include "includes/define.h"
 
namespace Kratos {
 
 
 
class KRATOS_API(KRATOS_CORE) MemoryInfo {
public:
 
    KRATOS_CLASS_POINTER_DEFINITION(MemoryInfo);
 
 
    MemoryInfo() = default;
 
    virtual ~MemoryInfo() = default;
 
 
    static std::size_t GetPeakMemoryUsage();
 
    static std::size_t GetCurrentMemoryUsage();
 
    static std::string HumanReadableSize(std::size_t InBytes);
 
 
    virtual std::string Info() const { return "MemoryInfo"; }
 
    virtual void PrintInfo(std::ostream &rOStream) const { rOStream << Info(); }
 
    virtual void PrintData(std::ostream &rOStream) const
    {
        rOStream << "Current Memory Usage : "
                 << HumanReadableSize(GetCurrentMemoryUsage()) << std::endl;
        rOStream << "Peak Memory Usage    : "
                 << HumanReadableSize(GetPeakMemoryUsage()) << std::endl;
    }
 
 
private:
 
    MemoryInfo &operator=(MemoryInfo const &rOther);
 
    MemoryInfo(MemoryInfo const &rOther);
 
 
}; // Class MemoryInfo
 
 
 
 
inline std::istream &operator>>(std::istream &rIStream, MemoryInfo &rThis);
 
inline std::ostream &operator<<(std::ostream &rOStream,
                                const MemoryInfo &rThis) {
    rThis.PrintInfo(rOStream);
    rOStream << std::endl;
    rThis.PrintData(rOStream);
 
    return rOStream;
}
 
 
} // namespace Kratos.
 
#endif // KRATOS_MEMORY_INFO_H_INCLUDED  defined