Sacado Package Browser (Single Doxygen Collection)  Version of the Day
Public Types | Public Member Functions | Protected Attributes | Private Types | List of all members
Sacado::ParameterRegistration< EvalType, EvalTypeTraits > Class Template Reference

Parameter class for simple registration of a parameter with a Parameter Library. Requires a parameter name a ParameterAccessor object. More...

#include <Sacado_ParameterRegistration.hpp>

Public Types

typedef ScalarParameterLibrary< EvalTypeTraits > ParamLib
 

Public Member Functions

 ParameterRegistration (const std::string &name_, ParameterAccessor< EvalType, EvalTypeTraits > *access_, ParamLib &paramLib)
 Constructor: Registers the parameter with the Parameter Library. More...
 
 ParameterRegistration (const std::string &name_, ParameterAccessor< EvalType, EvalTypeTraits > *access_, const Teuchos::RCP< ParamLib > &paramLib)
 Constructor: Registers the parameter with the Parameter Library. More...
 
virtual ~ParameterRegistration ()
 Destructor. More...
 
virtual void setRealValue (double value)
 Set real parameter value. More...
 
virtual void setValue (const ScalarT &value)
 Set parameter values using ParameterAccessor. More...
 
virtual const ScalarT & getValue () const
 Get parameter value using ParameterAccessor. More...
 

Protected Attributes

ParameterAccessor< EvalType, EvalTypeTraits > * access
 Pointer to source function. More...
 
const std::string name
 

Private Types

typedef EvalTypeTraits::template apply< EvalType >::type ScalarT
 Scalar type. More...
 

Detailed Description

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

Parameter class for simple registration of a parameter with a Parameter Library. Requires a parameter name a ParameterAccessor object.

Definition at line 46 of file Sacado_ParameterRegistration.hpp.

Member Typedef Documentation

◆ ScalarT

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

Scalar type.

Definition at line 50 of file Sacado_ParameterRegistration.hpp.

◆ ParamLib

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

Definition at line 55 of file Sacado_ParameterRegistration.hpp.

Constructor & Destructor Documentation

◆ ParameterRegistration() [1/2]

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::ParameterRegistration ( const std::string &  name_,
ParameterAccessor< EvalType, EvalTypeTraits > *  access_,
ParamLib &  paramLib 
)
inline

Constructor: Registers the parameter with the Parameter Library.

Definition at line 58 of file Sacado_ParameterRegistration.hpp.

◆ ParameterRegistration() [2/2]

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::ParameterRegistration ( const std::string &  name_,
ParameterAccessor< EvalType, EvalTypeTraits > *  access_,
const Teuchos::RCP< ParamLib > &  paramLib 
)
inline

Constructor: Registers the parameter with the Parameter Library.

Definition at line 70 of file Sacado_ParameterRegistration.hpp.

◆ ~ParameterRegistration()

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

Destructor.

Definition at line 85 of file Sacado_ParameterRegistration.hpp.

Member Function Documentation

◆ setRealValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual void Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setRealValue ( double  value)
inlinevirtual

Set real parameter value.

Definition at line 88 of file Sacado_ParameterRegistration.hpp.

◆ setValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual void Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setValue ( const ScalarT &  value)
inlinevirtual

Set parameter values using ParameterAccessor.

Definition at line 92 of file Sacado_ParameterRegistration.hpp.

◆ getValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual const ScalarT& Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::getValue ( ) const
inlinevirtual

Get parameter value using ParameterAccessor.

Definition at line 97 of file Sacado_ParameterRegistration.hpp.

Member Data Documentation

◆ access

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
ParameterAccessor<EvalType, EvalTypeTraits>* Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::access
protected

Pointer to source function.

Definition at line 104 of file Sacado_ParameterRegistration.hpp.

◆ name

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>
const std::string Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::name
protected

Definition at line 105 of file Sacado_ParameterRegistration.hpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.8.20