Sacado Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Sacado_ParameterAccessor.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Sacado Package
5 // Copyright (2006) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // This library is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as
12 // published by the Free Software Foundation; either version 2.1 of the
13 // License, or (at your option) any later version.
14 //
15 // This library is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23 // USA
24 // Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
25 // (etphipp@sandia.gov).
26 //
27 // ***********************************************************************
28 // @HEADER
29 
30 #ifndef SACADO_PARAMETERACCESSOR_HPP
31 #define SACADO_PARAMETERACCESSOR_HPP
32 
33 #include <vector>
34 #include "Teuchos_RCP.hpp"
37 
38 namespace Sacado {
39 
40  template <typename EvalType, typename EvalTypeTraits>
42 
48  template<typename EvalType,
49  typename EvalTypeTraits = DefaultEvalTypeTraits>
51  private:
52  typedef typename EvalTypeTraits::template apply<EvalType>::type ScalarT;
53 
54  public:
55 
57 
58  virtual ~ParameterAccessor() {};
59 
62  virtual ScalarT& getValue(const std::string &n) = 0;
63 
66  virtual void setValue(const std::string &n, const ScalarT& v) {
67  getValue(n) = v;
68  }
69 
70  void registerSacadoParameter(const std::string& name,
71  ParamLib& paramLib);
72 
73  void registerSacadoParameter(const std::string& name,
74  const Teuchos::RCP<ParamLib>& paramLib);
75 
76  private:
77  std::vector< Teuchos::RCP< ParameterRegistration<EvalType, EvalTypeTraits> > > pr_;
78  };
79 }
80 
81 // Include implementation
83 
84 #endif
EvalTypeTraits::template apply< EvalType >::type ScalarT
virtual ScalarT & getValue(const std::string &n)=0
Parameter class for simple registration of a parameter with a Parameter Library. Requires a parameter...
virtual void setValue(const std::string &n, const ScalarT &v)
std::vector< Teuchos::RCP< ParameterRegistration< EvalType, EvalTypeTraits > > > pr_
ScalarParameterLibrary< EvalTypeTraits > ParamLib
void registerSacadoParameter(const std::string &name, ParamLib &paramLib)
Specialization of Sacado::ParameterLibraryBase for scalar parameters.
Base traits definition mapping evaluation types to value types.
Abstract class that provides access to a parameter value in a code for the parameter library...