Sacado_ScalarParameterFamily.hpp

Go to the documentation of this file.

// $Id: Sacado_ScalarParameterFamily.hpp,v 1.2 2007/06/23 00:46:31 etphipp Exp $ 
// $Source: /space/CVS/Trilinos/packages/sacado/src/parameter/Sacado_ScalarParameterFamily.hpp,v $ 
// @HEADER
// ***********************************************************************
// 
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef SACADO_SCALARPARAMETERFAMILY_HPP
#define SACADO_SCALARPARAMETERFAMILY_HPP

#include "Sacado_ParameterFamilyBase.hpp"
#include "Sacado_ScalarParameterEntry.hpp"

namespace Sacado {
  
  class ScalarParameterFamily : 
    public Sacado::ParameterFamilyBase<Sacado::AbstractScalarParameterEntry,
                                       Sacado::ScalarParameterEntry> 
  {

    typedef Sacado::ParameterFamilyBase<Sacado::AbstractScalarParameterEntry,
          Sacado::ScalarParameterEntry>  BaseT;

  public:
  
    ScalarParameterFamily(const std::string& name, 
        bool supports_ad, 
        bool supports_analytic) : 
      BaseT(name, supports_ad, supports_analytic) {}
      

    virtual ~ScalarParameterFamily() {}

    void setRealValueForAllTypes(double value) {
      for (iterator it = family.begin(); it != family.end(); ++it)
  (*it).second->setRealValue(value);
    }

    template <class ValueType>
    void setValueAsConstant(const ValueType& value) {
      getEntry<ValueType>()->setValueAsConstant(value);
    }

    template <class ValueType>
    void setValueAsIndependent(const ValueType& value) {
      getEntry<ValueType>()->setValueAsIndependent(value);
    }

    template <class ValueType>
    const ValueType& getValue() const {
      return getEntry<ValueType>()->getValue();
    }

  private:

    ScalarParameterFamily(const ScalarParameterFamily&);
    
    ScalarParameterFamily& operator = (const ScalarParameterFamily&);

  };

  template <class ValueType>
  ValueType getValue(const ScalarParameterFamily& spf)
  {
    return spf.template getValue<ValueType>();
  }

} // namespace Sacado

#endif

---