materials_parsing.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2017 Paul T. Bauman, Roy H. Stogner
// Copyright (C) 2010-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 GRINS_MATERIALS_PARSING_H
#define GRINS_MATERIALS_PARSING_H

// C++
#include <string>

// libMesh
#include "libmesh/getpot.h"

namespace GRINS
{
  // Forward declarations
  class ParameterUser;


  class MaterialsParsing
  {
  public:
    MaterialsParsing(){};
    ~MaterialsParsing(){};

    static bool have_material( const GetPot& input, const std::string& physics );

    static std::string material_name( const GetPot& input, const std::string& physics );

    static void viscosity_model( const GetPot& input, const std::string& physics,
                                 const std::string& material, std::string& model );

    static void thermal_conductivity_model( const GetPot& input, const std::string& physics,
                                            const std::string& material, std::string& model );

    static void specific_heat_model( const GetPot& input, const std::string& physics,
                                     const std::string& material, std::string& model );

    static void turb_viscosity_model( const GetPot& input,
                                      const std::string& physics,
                                      const std::string& material,
                                      std::string& model );

    static void stress_strain_model( const GetPot& input,
                                     const std::string& /*physics*/,
                                     const std::string& material,
                                     std::string& model,
                                     std::string& strain_energy );


    static void read_density( const std::string& core_physics_name,
                              const GetPot& input,
                              ParameterUser& params,
                              libMesh::Real& rho );


    static void read_specific_heat( const std::string& core_physics_name,
                                    const GetPot& input,
                                    ParameterUser& params,
                                    libMesh::Real& cp );


    static void read_property( const GetPot& input,
                               const std::string& old_option,
                               const std::string& property,
                               const std::string& core_physics,
                               ParameterUser& param_user,
                               libMesh::Real& value );

    static void dep_input_warning( const std::string& old_option,
                                   const std::string& property );

    static void duplicate_input_test( const GetPot& input,
                                      const std::string& option1,
                                      const std::string& option2 );

    static void check_for_input_option( const GetPot& input, const std::string& option );


    static void parse_chemical_species( const GetPot& input,
                                        const std::string& material,
                                        std::vector<std::string>& species_names );


    static void parse_species_varnames( const GetPot& input,
                                        const std::string& material,
                                        const std::string& prefix,
                                        std::vector<std::string>& species_names );

    static libMesh::Real parse_lewis_number( const GetPot& input,
                                             const std::string& material );

    static std::string parse_chemical_kinetics_datafile_name( const GetPot& input,
                                                              const std::string& material );

  };

  inline
  bool MaterialsParsing::have_material( const GetPot& input, const std::string& physics )
  {
    return input.have_variable("Physics/"+physics+"/material");
  }

  inline
  std::string MaterialsParsing::material_name( const GetPot& input, const std::string& physics )
  {
    return input("Physics/"+physics+"/material", "DIE!");
  }

  inline
  void MaterialsParsing::check_for_input_option( const GetPot& input, const std::string& option )
  {
    if( !input.have_variable(option) )
      libmesh_error_msg("ERROR: Could not find required input parameter "+option+"!");
  }

} // end namespace GRINS

#endif // GRINS_MATERIALS_PARSING_H