read_reaction_set_data.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// Antioch - A Gas Dynamics Thermochemistry Library
//
// Copyright (C) 2014-2016 Paul T. Bauman, Benjamin S. Kirk,
//                         Sylvain Plessis, Roy H. Stonger
//
// Copyright (C) 2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-


#ifndef ANTIOCH_READ_REACTION_SET_DATA_H
#define ANTIOCH_READ_REACTION_SET_DATA_H

// Antioch
#include "antioch/antioch_asserts.h"
#include "antioch/units.h"
#include "antioch/parsing_enum.h"

// C++
#include <string>
#include <vector>

namespace Antioch
{

  template <typename NumericType>
  class ASCIIParser;

  template <typename NumericType>
  class ChemKinParser;

  template <typename NumericType>
  class XMLParser;

  template <typename NumericType>
  class ReactionSet;

  template<class NumericType>
  void read_reaction_set_data_xml( const std::string& filename,
                                   const bool verbose,
                                   ReactionSet<NumericType>& reaction_set );

  template<class NumericType>
  void read_reaction_set_data_chemkin( const std::string& filename,
                                       const bool verbose,
                                       ReactionSet<NumericType>& reaction_set );


  template<typename NumericType>
  void read_reaction_set_data(const std::string &filename,
                              const bool verbose,
                              ReactionSet<NumericType>& reaction_set,
                              ParsingType type = ASCII );

  template <typename NumericType>
  void verify_unit_of_parameter(Units<NumericType> & default_unit, const std::string & provided_unit,
                                 const std::vector<std::string> & accepted_unit,
                                 const std::string & equation,     const std::string & parameter_name);


  /* ------------------------- Inline Functions -------------------------*/
  template<class NumericType>
  inline
  void read_reaction_set_data_xml( const std::string& filename,
                                   const bool verbose,
                                   ReactionSet<NumericType>& reaction_set )
  {
     read_reaction_set_data<NumericType >(filename,verbose,reaction_set,XML);
  }

  template<class NumericType>
  inline
  void read_reaction_set_data_chemkin( const std::string& filename,
                                       const bool verbose,
                                       ReactionSet<NumericType>& reaction_set )
  {
     read_reaction_set_data<NumericType>(filename,verbose,reaction_set,CHEMKIN);
  }

} // end namespace Antioch

#endif // ANTIOCH_READ_REACTION_SET_DATA_H