Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
Sacado::ParameterAccessor< EvalType, EvalTypeTraits > Class Template Referenceabstract

Abstract class that provides access to a parameter value in a code for the parameter library. An object of this type is required to construct a ParameterRegistration object. More...

#include <Sacado_ParameterAccessor.hpp>

Inheritance diagram for Sacado::ParameterAccessor< EvalType, EvalTypeTraits >:
Inheritance graph
[legend]

Public Types

typedef ScalarParameterLibrary< EvalTypeTraits > ParamLib
 

Public Member Functions

virtual ~ParameterAccessor ()
 
virtual ScalarTgetValue (const std::string &n)=0
 
virtual void setValue (const std::string &n, const ScalarT &v)
 
void registerSacadoParameter (const std::string &name, ParamLib &paramLib)
 
void registerSacadoParameter (const std::string &name, const Teuchos::RCP< ParamLib > &paramLib)
 

Private Types

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

Private Attributes

std::vector< Teuchos::RCP< ParameterRegistration< EvalType, EvalTypeTraits > > > pr_
 

Detailed Description

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>
class Sacado::ParameterAccessor< EvalType, EvalTypeTraits >

Abstract class that provides access to a parameter value in a code for the parameter library. An object of this type is required to construct a ParameterRegistration object.

Definition at line 50 of file Sacado_ParameterAccessor.hpp.

Member Typedef Documentation

◆ ScalarT

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
typedef EvalTypeTraits::template apply<EvalType>::type Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::ScalarT
private

Definition at line 52 of file Sacado_ParameterAccessor.hpp.

◆ ParamLib

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
typedef ScalarParameterLibrary<EvalTypeTraits> Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::ParamLib

Definition at line 56 of file Sacado_ParameterAccessor.hpp.

Constructor & Destructor Documentation

◆ ~ParameterAccessor()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::~ParameterAccessor ( )
inlinevirtual

Definition at line 58 of file Sacado_ParameterAccessor.hpp.

Member Function Documentation

◆ getValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual ScalarT & Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::getValue ( const std::string &  n)
pure virtual

Method that returns a reference to the parameter value given the name The ParameterLibrary call this method when a parameter value changes

◆ setValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual void Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::setValue ( const std::string &  n,
const ScalarT v 
)
inlinevirtual

Method that returns a reference to the parameter value given the name The ParameterLibrary call this method when a parameter value changes

Definition at line 66 of file Sacado_ParameterAccessor.hpp.

◆ registerSacadoParameter() [1/2]

template<typename EvalType , typename EvalTypeTraits >
void Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::registerSacadoParameter ( const std::string &  name,
ParamLib paramLib 
)

Definition at line 33 of file Sacado_ParameterAccessorImp.hpp.

◆ registerSacadoParameter() [2/2]

template<typename EvalType , typename EvalTypeTraits >
void Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::registerSacadoParameter ( const std::string &  name,
const Teuchos::RCP< ParamLib > &  paramLib 
)

Definition at line 43 of file Sacado_ParameterAccessorImp.hpp.

Member Data Documentation

◆ pr_

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
std::vector< Teuchos::RCP< ParameterRegistration<EvalType, EvalTypeTraits> > > Sacado::ParameterAccessor< EvalType, EvalTypeTraits >::pr_
private

Definition at line 77 of file Sacado_ParameterAccessor.hpp.


The documentation for this class was generated from the following files: