Sacado_ScalarParameterLibrary.hpp

Go to the documentation of this file.

// $Id: Sacado_ScalarParameterLibrary.hpp,v 1.2 2007/06/23 00:46:31 etphipp Exp $ 
// $Source: /space/CVS/Trilinos/packages/sacado/src/parameter/Sacado_ScalarParameterLibrary.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_SCALARPARAMETERLIBRARY_HPP
#define SACADO_SCALARPARAMETERLIBRARY_HPP

#include "Sacado_ParameterLibraryBase.hpp"
#include "Sacado_ScalarParameterFamily.hpp"
#include "Sacado_ScalarParameterVector.hpp"

#include "Teuchos_TestForException.hpp"

namespace Sacado {

  class ScalarParameterLibrary : 
    public ParameterLibraryBase<ScalarParameterFamily, ScalarParameterEntry> {

  public:
  
    ScalarParameterLibrary() {}

    virtual ~ScalarParameterLibrary() {}

    void setRealValueForAllTypes(const std::string& name, double value);


    template <class ValueType>
    void setValueAsConstant(const std::string& name, 
          const ValueType& value);


    template <class ValueType>
    void setValueAsIndependent(const std::string& name, 
             const ValueType& value);

    template <class ValueType>
    const ValueType& getValue(const std::string& name) const;

    static ScalarParameterLibrary& getInstance() {
      static ScalarParameterLibrary instance;
      return instance;
    }


    void
    fillVector(const Teuchos::Array<std::string>& names,
         ScalarParameterVector& pv);

  private:

    ScalarParameterLibrary(const ScalarParameterLibrary&);

    ScalarParameterLibrary& operator = (const ScalarParameterLibrary&);

  };
  
}

template <class ValueType>
void
Sacado::ScalarParameterLibrary::
setValueAsConstant(const std::string& name, const ValueType& value)
{
  FamilyMap::iterator it = library.find(name);
  TEST_FOR_EXCEPTION(
   it == library.end(), 
   std::logic_error,
   std::string("Sacado::ScalarParameterLibrary::setValueAsConstant():  ")
   + "Invalid parameter family " + name);
  (*it).second->setValueAsConstant(value);
}

template <class ValueType>
void
Sacado::ScalarParameterLibrary::
setValueAsIndependent(const std::string& name, const ValueType& value)
{
  FamilyMap::iterator it = library.find(name);
  TEST_FOR_EXCEPTION(
      it == library.end(), 
      std::logic_error,
      std::string("Sacado::ScalarParameterLibrary::setValueAsIndependent():  ")
      + "Invalid parameter family " + name);
  (*it).second->setValueAsIndependent(value);
}

template <class ValueType>
const ValueType&
Sacado::ScalarParameterLibrary::
getValue(const std::string& name) const
{
  FamilyMap::const_iterator it = library.find(name);
  TEST_FOR_EXCEPTION(
     it == library.end(), 
     std::logic_error,
     std::string("Sacado::ScalarParameterLibrary::getValue():  ")
     + "Invalid parameter family " + name);
  return (*it).second->getValue<ValueType>();
}

#endif

---