Sacado::ScalarParameterEntry< ValueType > Class Template Reference

A base class for scalar parameter values. More...

#include <Sacado_ScalarParameterEntry.hpp>

Inheritance diagram for Sacado::ScalarParameterEntry< ValueType >:

[legend]List of all members.

Public Member Functions
	ScalarParameterEntry ()
	Default constructor.
virtual	~ScalarParameterEntry ()
	Destructor.
virtual void	setValueAsConstant (const ValueType &value)=0
	Set parameter this object represents to value.
virtual void	setValueAsIndependent (const ValueType &value)=0
	Set parameter this object represents to value.
virtual const ValueType &	getValue () const =0
	Get parameter value this object represents.

---

Detailed Description

template<typename ValueType>
class Sacado::ScalarParameterEntry< ValueType >

A base class for scalar parameter values.

Definition at line 55 of file Sacado_ScalarParameterEntry.hpp.

---

Constructor & Destructor Documentation

template<typename ValueType>

Sacado::ScalarParameterEntry< ValueType >::ScalarParameterEntry

(

)

[inline]

Default constructor.

Definition at line 60 of file Sacado_ScalarParameterEntry.hpp.

template<typename ValueType>

virtual Sacado::ScalarParameterEntry< ValueType >::~ScalarParameterEntry

(

)

[inline, virtual]

Destructor.

Definition at line 63 of file Sacado_ScalarParameterEntry.hpp.

---

Member Function Documentation

template<typename ValueType>

virtual void Sacado::ScalarParameterEntry< ValueType >::setValueAsConstant

(

const ValueType &

value

)

[pure virtual]

Set parameter this object represents to value.

Treat the set parameter as a constant for derivative computations.

Implemented in FEApp::BrusselatorAlphaParameter< ScalarT >, FEApp::BrusselatorBetaParameter< ScalarT >, FEApp::ConstantFunctionParameter< ScalarT >, FEApp::ConstantNodeBCParameter< ScalarT >, FEApp::CubicNonlinearFactorParameter< ScalarT >, FEApp::ExponentialNonlinearFactorParameter< ScalarT >, and FEApp::QuadraticNonlinearFactorParameter< ScalarT >.

template<typename ValueType>

virtual void Sacado::ScalarParameterEntry< ValueType >::setValueAsIndependent

(

const ValueType &

value

)

[pure virtual]

Set parameter this object represents to value.

Treat the set parameter as an independent for derivative computations.

Implemented in FEApp::BrusselatorAlphaParameter< ScalarT >, FEApp::BrusselatorBetaParameter< ScalarT >, FEApp::ConstantFunctionParameter< ScalarT >, FEApp::ConstantNodeBCParameter< ScalarT >, FEApp::CubicNonlinearFactorParameter< ScalarT >, FEApp::ExponentialNonlinearFactorParameter< ScalarT >, and FEApp::QuadraticNonlinearFactorParameter< ScalarT >.

template<typename ValueType>

virtual const ValueType& Sacado::ScalarParameterEntry< ValueType >::getValue

(

)

const [pure virtual]

Get parameter value this object represents.

Implemented in FEApp::BrusselatorAlphaParameter< ScalarT >, FEApp::BrusselatorBetaParameter< ScalarT >, FEApp::ConstantFunctionParameter< ScalarT >, FEApp::ConstantNodeBCParameter< ScalarT >, FEApp::CubicNonlinearFactorParameter< ScalarT >, FEApp::ExponentialNonlinearFactorParameter< ScalarT >, and FEApp::QuadraticNonlinearFactorParameter< ScalarT >.

---

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

• Sacado_ScalarParameterEntry.hpp

---