Util.H

Go to the documentation of this file.

#ifndef UTIL_UTIL_H
#define UTIL_UTIL_H
 
#include <iostream>
#include <iomanip>
#include <sys/ioctl.h>
#include <unistd.h>
#include <iterator>
#include <algorithm>
#include <complex>
#include <stdlib.h>
#include <string_view>
 
#include <string>
#include "Util/String.H"
 
#include "AMReX.H"
#include <AMReX_ParallelDescriptor.H>
#include <AMReX_PlotFileUtil.H>
#include <AMReX_iMultiFab.H>
#include <AMReX_Reduce.H>
 
#include "Color.H"
#define INFO __FILE__, __func__, __LINE__
#define TEST(x) #x, x
 
 
#ifndef ALAMO_SINGLE_DEFINITION
#define ALAMO_SINGLE_DEFINITION AMREX_ATTRIBUTE_WEAK
#endif
 
namespace Util
{
 
extern std::string globalprefix;
extern bool initialized;
extern bool finalized;
 
 
std::string GetFileName();
void CopyFileToOutputDir(std::string a_path, bool fullpath = true, std::string prefix = "");
 
std::pair<std::string,std::string> GetOverwrittenFile();
 
void SignalHandler(int s);
 
void Initialize (int argc, char* argv[]);
void Initialize ();
 
void Finalize ();
 
void Terminate(const char * msg, int signal, bool backtrace);
 
AMREX_GPU_HOST_DEVICE
void Abort (const char * msg);
 
template<typename... Args>
AMREX_FORCE_INLINE
AMREX_GPU_HOST_DEVICE
void Assert (const char *file, const char *func, int line, const char *smt, bool pass, Args const &... args)
{
#ifndef __CUDA_ARCH__
    if (pass) return;
 
    std::ostringstream infostream;
    infostream << globalprefix;
    infostream << Color::Bold << Color::FG::Red << "ABORT("<< amrex::ParallelDescriptor::MyProc()<<")" << Color::Reset << ":   ";
    infostream << Color::FG::Red << file << Color::Reset << ":" << line << " ";
    infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
    infostream << "Assertion failed: " << Color::BG::DarkGray << Color::Underlined << Color::Bold <<  Color::FG::LightGreen << smt << Color::Reset;
    std::string info = infostream.str();
 
 
    std::ostringstream messagestream;
    using List= int[];
    (void)List{0, ( (void)(messagestream << args), 0 ) ... };
    std::string message = messagestream.str();
    Util::String::ReplaceAll(message,'\n',"\n"+info);
 
    std::cout << info << message << std::endl;
 
    Abort("Fatal Error");
#else
    if (!pass) amrex::Abort();
#endif
}
 
 
template<typename... Args>
AMREX_GPU_HOST_DEVICE
void Abort (const char *file, const char *func, int line, Args const &... args)
{
#ifndef __CUDA_ARCH__
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Red << "ABORT" << Color::Reset << ":   ";
        infostream << Color::FG::Red << file << Color::Reset << ":" << line << " ";
        infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
        std::string info = infostream.str();
 
        std::ostringstream messagestream;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        std::string message = messagestream.str();//String::Wrap(messagestream.str(),150);
        //std::string messageorg = message;
        Util::String::ReplaceAll(message,'\n',"\n"+info);
        std::cout << info << message << std::endl;
    }
    Abort("Fatal Error");
#else
    amrex::Abort();
#endif
}
 
template<typename... Args>
void ParallelAbort (std::string file, std::string func, int line, Args const &... args)
{
 
    std::ostringstream infostream;
    infostream << globalprefix;
    infostream << Color::Bold << Color::FG::Red << "ABORT("<< amrex::ParallelDescriptor::MyProc()<<")" << Color::Reset << ":   ";
    infostream << Color::FG::Red << file << Color::Reset << ":" << line << " ";
    infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
    std::string info = infostream.str();
 
    std::ostringstream messagestream;
    using List= int[];
    (void)List{0, ( (void)(messagestream << args), 0 ) ... };
    std::string message = messagestream.str();//String::Wrap(messagestream.str(),150);
    //std::string messageorg = message;
    Util::String::ReplaceAll(message,'\n',"\n"+info);
    std::cout << info << message << std::endl;
 
    Abort("Fatal Error");
}
 
template<typename... Args>
void Message (std::string file, std::string func, int line, Args const &... args)
{
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Blue << "MESSAGE" << Color::Reset << ": ";
        infostream << Color::FG::LightBlue << file << Color::Reset << ":" << line << " ";
        infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
        std::string info = infostream.str();
 
        std::ostringstream messagestream;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        std::string message = messagestream.str();//String::Wrap(messagestream.str(),150);
 
        Util::String::ReplaceAll(message,'\n',"\n"+info);
 
        std::cout << info << message << std::endl;
    }
}
 
#ifdef AMREX_DEBUG
template<typename... Args>
void DebugMessage (std::string file, std::string func, int line, Args const &... args)
{
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Blue << "MESSAGE" << Color::Reset << ": ";
        infostream << Color::FG::LightBlue << file << Color::Reset << ":" << line << " ";
        infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
        std::string info = infostream.str();
 
        std::ostringstream messagestream;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        std::string message = messagestream.str();//String::Wrap(messagestream.str(),150);
 
        Util::String::ReplaceAll(message,'\n',"\n"+info);
 
        std::cout << info << message << std::endl;
    }
}
#else
template<typename... Args>
void DebugMessage (std::string, std::string, int, Args const &... )
{
}
#endif
 
 
 
 
template<typename... Args>
void ParallelMessage (std::string file, std::string func, int line, Args const &... args)
{
    std::ostringstream infostream;
    infostream << globalprefix;
    infostream << Color::Bold << Color::FG::Blue << "MESSAGE("<< amrex::ParallelDescriptor::MyProc()<<")" << Color::Reset << ": ";
    infostream << Color::FG::LightBlue << file << Color::Reset << ":" << line << " ";
    infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
    std::string info = infostream.str();
    std::ostringstream messagestream;
    using List= int[];
    (void)List{0, ( (void)(messagestream << args), 0 ) ... };
    std::string message = messagestream.str();//String::Wrap(messagestream.str(),150);
    Util::String::ReplaceAll(message,'\n',"\n"+info);
    std::cout << info << message << std::endl;
}
 
template<typename... Args>
void Warning (std::string file, std::string func, int line, Args const &... args)
{
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Yellow << "WARNING" << Color::Reset << ": ";
        infostream << Color::FG::Yellow << file << Color::Reset << ":" << line << " ";
        infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
        std::string info = infostream.str();
 
        std::ostringstream messagestream;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        std::string message = messagestream.str();///String::Wrap(messagestream.str(),150);
 
        Util::String::ReplaceAll(message,'\n',"\n"+info);
 
        std::cout << info << message << std::endl;
    }
}
 
 
template<typename... Args>
void Exception (std::string file, std::string func, int line, Args const &... args)
{
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Red << "EXCEPTION" << Color::Reset << ": ";
        infostream << Color::FG::LightGray << file << ":" << line << " (" << func << Color::Reset << ") ";
        std::string info = infostream.str();
 
        std::ostringstream messagestream;
        messagestream << Color::FG::Red;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        messagestream << Color::Reset;
 
        std::string message = messagestream.str();
 
        Util::String::ReplaceAll(message,'\n',"\n"+info);
 
        std::cout << info << message << std::endl;
 
        std::throw_with_nested(std::runtime_error("IO::Exception"));
    }
}
 
template<typename... Args>
AMREX_FORCE_INLINE
void AssertException (std::string file, std::string func, int line, std::string smt, bool pass, Args const &... args)
{
    if (pass) return;
 
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Red << "ABORT("<< amrex::ParallelDescriptor::MyProc()<<")" << Color::Reset << ":   ";
        infostream << Color::FG::Red << file << Color::Reset << ":" << line << " ";
        infostream << "(" << Color::FG::LightGreen << func << Color::Reset << ") ";
        infostream << "Assertion failed: " << Color::BG::DarkGray << Color::Underlined << Color::Bold <<  Color::FG::LightGreen << smt << Color::Reset;
        std::string info = infostream.str();
 
 
        std::ostringstream messagestream;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        std::string message = messagestream.str();
        Util::String::ReplaceAll(message,'\n',"\n"+info);
 
        std::cout << info << message << std::endl;
 
        Exception(file,func,line,"Fatal Error");
    }
}
 
 
 
template<typename... Args>
void ParmParseException (   std::string file, std::string func, int line,
                            std::string fullname,
                            Args const &... args)
{
    if (amrex::ParallelDescriptor::IOProcessor())
    {
        std::ostringstream infostream;
        infostream << globalprefix;
        infostream << Color::Bold << Color::FG::Red << "EXCEPTION" << Color::Reset << ": ";
        infostream << Color::FG::LightGray << file << ":" << line << " (" << func << Color::Reset << ") ";
        std::string info = infostream.str();
 
        std::ostringstream messagestream;
        messagestream << Color::FG::Red;
        using List= int[];
        (void)List{0, ( (void)(messagestream << args), 0 ) ... };
        messagestream << Color::Reset;
 
        const std::size_t nargs = sizeof...(Args);
 
        if (nargs) messagestream << "\n";
        if (fullname != "")
            messagestream << "while reading " << Color::FG::Yellow << fullname << Color::Reset;
 
        std::string message = messagestream.str();
 
        Util::String::ReplaceAll(message,'\n',"\n"+info);
 
        std::cout << info << message << std::endl;
 
        std::throw_with_nested(std::runtime_error("IO::ParmParse Exception"));
    }
}
 
 
std::pair<std::string,std::string>
CreateCleanDirectory (const std::string &path, bool callbarrier = true);
 
 
/// \brief A collection of I/O routines for Unit Tests
namespace Test
{
int Message(std::string testname);
int Message(std::string testname, int passed);
int SubMessage(std::string testname, int passed);
void SubWarning(std::string testname);
int SubFinalMessage(int failed);
}
 
//
// These two functions are not really necessary anymore.
// TODO: remove RealFillBoundary and all references to them.
//
template<class T>
AMREX_FORCE_INLINE
void RealFillBoundary(amrex::FabArray<amrex::BaseFab<T>> &a_mf,const amrex::Geometry &/*a_geom*/, const int nghost=2)
{
    // We want the default to setMultiGhost(true) if nghost isn't explicitly passed, so nghost should default to a number greater than 1
    BL_PROFILE("Util::RealFillBoundary");
    if (nghost <= 1) {}
    else a_mf.setMultiGhost(true);
    a_mf.FillBoundary();
}
AMREX_FORCE_INLINE
void RealFillBoundary(amrex::MultiFab &a_mf, const amrex::Geometry &/*a_geom*/, const int nghost=2)
{
    // We want the default to setMultiGhost(true) if nghost isn't explicitly passed, so nghost should default to a number greater than 1
    BL_PROFILE("Util::RealFillBoundary");
    if (nghost <= 1) {}
    else a_mf.setMultiGhost(true);
    a_mf.FillBoundary();
}
 
void AverageCellcenterToNode(amrex::MultiFab& node_mf, const int &dcomp, const amrex::MultiFab &cell_mf, const int &scomp, const int &ncomp/*, const int ngrow=0*/);
 
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T Abs(T a)
{
    return a < T(0) ? -a : a;
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T Min(T a, T b)
{
    return a < b ? a : b;
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T Max(T a, T b)
{
    return a > b ? a : b;
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T Clamp(T value, T lo, T hi)
{
    return Min(Max(value, Min(lo, hi)), Max(lo, hi));
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
bool IsFinite(T value)
{
    return value == value && value < T(1.0e300) && value > T(-1.0e300);
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T FiniteOr(T value, T fallback)
{
    return IsFinite(value) ? value : fallback;
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T MinMod(T a, T b)
{
    if (a * b <= T(0)) return T(0);
    T mag = Min(Abs(a), Abs(b));
    return a < T(0) ? -mag : mag;
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T MCSlope(T lo, T center, T hi)
{
    T dl = center - lo;
    T dr = hi - center;
    return MinMod(T(0.5) * (dl + dr), MinMod(T(2.0) * dl, T(2.0) * dr));
}
 
template <class T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
T SmootherStep(T value)
{
    T x = Clamp(value, T(0), T(1));
    return x * x * x * (x * (x * T(6.0) - T(15.0)) + T(10.0));
}
 
// Prevent compiler from complaining about unused variables
template <class... Ts>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
void IgnoreUnused (const Ts&...) {}
 
}
 
#endif