banner.hpp

Go to the documentation of this file.

/*
 * BELFEM -- The Berkeley Lab Finite Element Framework
 * Copyright (c) 2026, The Regents of the University of California,
 * through Lawrence Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Developers: Christian Messe, Gregory Giard
 *
 * See the top-level LICENSE file for the complete license and disclaimer.
 */
 
#ifndef BELFEM_BANNER_HPP
#define BELFEM_BANNER_HPP
 
#include <string>
 
namespace belfem
{
    const std::string gLongName = "BELFEM -- The Berkeley Lab Finite Element Framework";
    const std::string gURL      = "http://belfem.lbl.gov";
 
//------------------------------------------------------------------------------
 
    std::string
    exec( const std::string & aCommand );
 
//------------------------------------------------------------------------------

    std::string
    uname();
 
//------------------------------------------------------------------------------

    std::string
    cpu_info();
 
//------------------------------------------------------------------------------

    std::string
    version();
 
//------------------------------------------------------------------------------

    bool
    is_built_from_git();
 
//------------------------------------------------------------------------------

    std::string
    git_commit_hash();
 
//------------------------------------------------------------------------------

    std::string
    git_commit_hash_short();
 
//------------------------------------------------------------------------------

    std::string
    git_branch();
 
//------------------------------------------------------------------------------

    bool
    git_is_dirty();
 
//------------------------------------------------------------------------------

    void
    print_banner( const std::string aExecName = "" );
 
//------------------------------------------------------------------------------
 
    namespace banners
    {
        bool
        print_default();
 
        bool
        print_easter();
 
        bool
        print_stpatrick();
 
        bool
        print_usa();
 
        bool
        print_canada();
 
        bool
        print_thanksgiving();
 
        bool
        print_christmas();
    }
 
//------------------------------------------------------------------------------
}
#endif //BELFEM_BANNER_HPP