Sacado_ParameterRegistration.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_PARAMETERREGISTRATION_HPP
#define SACADO_PARAMETERREGISTRATION_HPP

#include <sstream>
#include "Sacado_ParameterAccessor.hpp"
#include "Sacado_Traits.hpp"
#include "Sacado_ScalarParameterLibrary.hpp"

namespace Sacado {

  template <typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>
  class ParameterRegistration :
    public Sacado::ScalarParameterEntry<EvalType, EvalTypeTraits > {

    typedef typename EvalTypeTraits::template apply<EvalType>::type ScalarT;


  public:

    typedef ScalarParameterLibrary<EvalTypeTraits> ParamLib;

    ParameterRegistration(const std::string &name_,
                          ParameterAccessor<EvalType, EvalTypeTraits>* access_,
                          ParamLib& paramLib)
      : access(access_), name(name_) {

      if (!paramLib.isParameter(name))
        paramLib.addParameterFamily(name, true, false);
      if (!paramLib.template isParameterForType<EvalType>(name))
        paramLib.template addEntry<EvalType>(name, Teuchos::rcp(this,false));
    }

    ParameterRegistration(const std::string &name_,
                          ParameterAccessor<EvalType, EvalTypeTraits>* access_,
                          const Teuchos::RCP<ParamLib>& paramLib)
      : access(access_), name(name_) {

      if (paramLib != Teuchos::null) {
        if (!paramLib->isParameter(name))
          paramLib->addParameterFamily(name, true, false);
        if (!paramLib->template isParameterForType<EvalType>(name)) {
          paramLib->template addEntry<EvalType>(name, Teuchos::rcp(this,false));
        }
      }
    }

    virtual ~ParameterRegistration() {}

    virtual void setRealValue(double value) {
      setValue(ScalarT(value)); }

    virtual void setValue(const ScalarT& value) {
      access->setValue(name, value);
    }

    virtual const ScalarT& getValue() const {
      return access->getValue(name);
    }

  protected:

    ParameterAccessor<EvalType, EvalTypeTraits>* access;
    const std::string name;

  };

}

#endif // SACADO_PARAMETERREGISTRATION_HPP