Misc.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: Misc.h
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Miscellaneous solver routines.
//
///////////////////////////////////////////////////////////////////////////////
 
#ifndef NEKTAR_SOLVERUTILS_CORE_MISC_H
#define NEKTAR_SOLVERUTILS_CORE_MISC_H
 
#include <string>
 
#include <LibUtilities/BasicConst/NektarUnivTypeDefs.hpp>
#include <SolverUtils/SolverUtilsDeclspec.h>
 
namespace Nektar::SolverUtils
{
 
typedef std::vector<std::pair<std::string, std::string>> SummaryList;
 
/// Adds a summary item to the summary info list
SOLVER_UTILS_EXPORT void AddSummaryItem(SummaryList &l, const std::string &name,
                                        const std::string &value);
 
/// Adds a summary item to the summary info list
SOLVER_UTILS_EXPORT void AddSummaryItem(SummaryList &l, const std::string &name,
                                        const int &value);
 
/// Adds a summary item to the summary info list
SOLVER_UTILS_EXPORT void AddSummaryItem(SummaryList &l, const std::string &name,
                                        const NekDouble &value);
 
} // namespace Nektar::SolverUtils
 
#endif