citation_info.h

Go to the documentation of this file.

/*
  Copyright (C) 2017 - 2022 by the authors of the ASPECT code.

  This file is part of ASPECT.

  ASPECT is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2, or (at your option)
  any later version.

  ASPECT is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ASPECT; see the file doc/COPYING.  If not see
  <http://www.gnu.org/licenses/>.
*/

#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