t8_scheme_builder.hxx

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.

  Copyright (C) 2024 the developers

  t8code 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 of the License, or
  (at your option) any later version.

  t8code 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 t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

/** \file t8_scheme_builder.hxx
 * This file defines a scheme builder, which buildy schemes by adding 
 * element class schemes to a scheme.
 */

#ifndef T8_SCHEME_BUILDER_HXX
#define T8_SCHEME_BUILDER_HXX

#include <t8_schemes/t8_scheme.hxx>

/** The scheme builder adds eclass schemes to a scheme container and returns it.
 * TODO: Make return value a reference.
 */
struct t8_scheme_builder
{
 public:
  t8_scheme_builder (): scheme (new t8_scheme) {};
  ~t8_scheme_builder () {};

  /** Datatype for scheme variable, storing a variant of 
   * all scheme types. \see t8_scheme::scheme_var
  */
  using scheme_var = t8_scheme::scheme_var;

  /** Add a new element class scheme to the scheme.
   * \tparam TEclassScheme       The type of the element class scheme.
   * \tparam Args                 The types of the arguments to pass to the constructor of the element class scheme.
   * \param  [in] args            The arguments to pass to the constructor of the element class scheme.
   * \return                      The position of the added element class scheme in the scheme.
   */
  template <typename TEclassScheme, typename... _Args>
  size_t
  add_eclass_scheme (_Args &&...args)
  {
#if T8_ENABLE_DEBUG
    t8_debugf ("Registering scheme of type %s with position %li.\n", t8_debug_print_type<TEclassScheme> ().c_str (),
               scheme->eclass_schemes.size ());
#endif  // T8_ENABLE_DEBUG
    scheme->eclass_schemes.emplace_back (std::in_place_type<TEclassScheme>, std::forward<_Args> (args)...);
    return scheme->eclass_schemes.size ();
  }

  /** Build the scheme.
   * \return The built scheme.
   */
  const t8_scheme *
  build_scheme () const
  {
    return scheme;
  }

 private:
  t8_scheme *scheme;
};

#endif /* !T8_SCHEME_BUILDER_HXX */