Sacado_ParameterFamilyBase.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Sacado Package
//
// Copyright 2006 NTESS and the Sacado contributors.
// SPDX-License-Identifier: LGPL-2.1-or-later
// *****************************************************************************
// @HEADER

#ifndef SACADO_PARAMETERFAMILYBASE_HPP
#define SACADO_PARAMETERFAMILYBASE_HPP

#include <map>
#include <string>
#include <iostream>

#include "Teuchos_RCP.hpp"
#include "Sacado_mpl_apply.hpp"

namespace Sacado {

  template <typename EntryBase, typename EntryType>
  class ParameterFamilyBase  {

  public:

    ParameterFamilyBase(const std::string& name,
                        bool supports_ad,
                        bool supports_analytic);

    virtual ~ParameterFamilyBase();

    std::string getName() const;

    bool supportsAD() const;

    bool supportsAnalytic() const;

    template <typename EvalType>
    bool hasType() const;


    template <typename EvalType>
    bool
    addEntry(const Teuchos::RCP< typename Sacado::mpl::apply<EntryType,EvalType>::type >& entry,
             const bool allow_overwrite = false);

    template <typename EvalType>
    Teuchos::RCP< typename Sacado::mpl::apply<EntryType,EvalType>::type >
    getEntry();

    template <typename EvalType>
    Teuchos::RCP< const typename Sacado::mpl::apply<EntryType,EvalType>::type >
    getEntry() const;


    void print(std::ostream& os, bool print_values = false) const;

  protected:

    typedef std::map<std::string, Teuchos::RCP<EntryBase> > EvalMap;

    typedef typename EvalMap::const_iterator const_iterator;

    typedef typename EvalMap::iterator iterator;

    template <class EvalType> std::string getTypeName() const;

  private:

    ParameterFamilyBase(const ParameterFamilyBase&);

    ParameterFamilyBase& operator = (const ParameterFamilyBase&);

  protected:

    EvalMap family;

    const std::string name;

    bool supports_ad;

    bool supports_analytic;

  };
}

// Include template definitions
#include "Sacado_ParameterFamilyBaseImp.hpp"

#endif