symengine_utilities.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2019 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_differentiation_sd_symengine_utilities_h
#define dealii_differentiation_sd_symengine_utilities_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_SYMENGINE
 
#  include <deal.II/differentiation/sd/symengine_number_types.h>
#  include <deal.II/differentiation/sd/symengine_types.h>
 
#  include <symengine/basic.h>
#  include <symengine/dict.h>
 
DEAL_II_NAMESPACE_OPEN
 
namespace Differentiation
{
  namespace SD
  {
    namespace Utilities
    {
      SymEngine::map_basic_basic
      convert_expression_map_to_basic_map(
        const SD::types::substitution_map &substitution_map);
 
      SD::types::substitution_map
      convert_basic_map_to_expression_map(
        const SymEngine::map_basic_basic &substitution_map);
 
      SymEngine::vec_basic
      convert_expression_vector_to_basic_vector(
        const SD::types::symbol_vector &symbol_vector);
 
      SD::types::symbol_vector
      convert_basic_vector_to_expression_vector(
        const SymEngine::vec_basic &symbol_vector);
 
      std::vector<std::pair<Expression, Expression>>
      convert_basic_pair_vector_to_expression_pair_vector(
        const SymEngine::vec_pair &symbol_value_vector);
 
      SD::types::symbol_vector
      extract_symbols(const SD::types::substitution_map &substitution_values);
 
      template <typename NumberType, typename ExpressionType = SD::Expression>
      std::vector<NumberType>
      extract_values(const SD::types::substitution_map &substitution_values);
 
      template <typename StreamType>
      StreamType &
      print_substitution_map(
        StreamType                        &stream,
        const SD::types::substitution_map &symbol_value_map);
 
    } // namespace Utilities
 
  } // namespace SD
} // namespace Differentiation
 
 
/* -------------------- inline and template functions ------------------ */
 
 
#  ifndef DOXYGEN
 
 
namespace Differentiation
{
  namespace SD
  {
    namespace Utilities
    {
      template <typename NumberType, typename ExpressionType>
      std::vector<NumberType>
      extract_values(const SD::types::substitution_map &substitution_values)
      {
        std::vector<NumberType> values;
        values.reserve(substitution_values.size());
 
        for (const auto &entry : substitution_values)
          values.push_back(
            static_cast<NumberType>(ExpressionType(entry.second)));
 
        return values;
      }
 
 
      template <typename StreamType>
      StreamType &
      print_substitution_map(
        StreamType                        &stream,
        const SD::types::substitution_map &symbol_value_map)
      {
        for (const auto &entry : symbol_value_map)
          stream << entry.first << " = " << entry.second << '\n';
 
        stream << std::flush;
        return stream;
      }
 
    } // namespace Utilities
 
  } // namespace SD
} // namespace Differentiation
 
 
#  endif // DOXYGEN
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif // DEAL_II_WITH_SYMENGINE
 
#endif // dealii_differentiation_sd_symengine_utilities_h