citation_info.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2017-2025 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------

#ifndef _aspect_citation_info_h
#define _aspect_citation_info_h

#include <string>
#include <iostream>


namespace aspect
{
  namespace CitationInfo
  {
    const std::string get_url_part ();

    void add (const std::string &id);

    template <class Stream>
    void print_info_block (Stream &stream)
    {
      stream << "-----------------------------------------------------------------------------\n"
             << "-- For information on how to cite ASPECT, see:\n"
             << "--   https://aspect.geodynamics.org/" << get_url_part() << "\n"
             << "-----------------------------------------------------------------------------"
             << std::endl;
    }
  }

}


#endif