Sacado::ScalarParameterLibrary Class Reference

Specialization of Sacado::ParameterLibraryBase for scalar parameters. More...

#include <Sacado_ScalarParameterLibrary.hpp>

Inheritance diagram for Sacado::ScalarParameterLibrary:

[legend]List of all members.

Public Member Functions
	ScalarParameterLibrary ()
	Default constructor.
virtual	~ScalarParameterLibrary ()
	Destructor.
void	setRealValueForAllTypes (const std::string &name, double value)
	Set paramter value using a real number.
template<class ValueType>
void	setValueAsConstant (const std::string &name, const ValueType &value)
	Set parameter to value value.
template<class ValueType>
void	setValueAsIndependent (const std::string &name, const ValueType &value)
	Set parameter to value value.
template<class ValueType>
const ValueType &	getValue (const std::string &name) const
	Get parameter value.
void	fillVector (const Teuchos::Array< std::string > &names, ScalarParameterVector &pv)
	Fill a vector with the supplied parameter names.
Static Public Member Functions
static ScalarParameterLibrary &	getInstance ()
	Returns a parameter library (singleton object).
Private Member Functions
	ScalarParameterLibrary (const ScalarParameterLibrary &)
	Private to prohibit copying.
ScalarParameterLibrary &	operator= (const ScalarParameterLibrary &)
	Private to prohibit copying.

---

Detailed Description

Specialization of Sacado::ParameterLibraryBase for scalar parameters.

Definition at line 47 of file Sacado_ScalarParameterLibrary.hpp.

---

Constructor & Destructor Documentation

Sacado::ScalarParameterLibrary::ScalarParameterLibrary

(

)

[inline]

Default constructor.

Definition at line 53 of file Sacado_ScalarParameterLibrary.hpp.

virtual Sacado::ScalarParameterLibrary::~ScalarParameterLibrary

(

)

[inline, virtual]

Destructor.

Definition at line 56 of file Sacado_ScalarParameterLibrary.hpp.

Sacado::ScalarParameterLibrary::ScalarParameterLibrary

(

const ScalarParameterLibrary &

)

[private]

Private to prohibit copying.

---

Member Function Documentation

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

Set paramter value using a real number.

Definition at line 36 of file Sacado_ScalarParameterLibrary.cpp.

template<class ValueType>

void Sacado::ScalarParameterLibrary::setValueAsConstant	(	const std::string &	name,
		const ValueType &	value
	)

Set parameter to value value.

Treat the set parameter as a constant for derivative computations.

Definition at line 110 of file Sacado_ScalarParameterLibrary.hpp.

template<class ValueType>

void Sacado::ScalarParameterLibrary::setValueAsIndependent	(	const std::string &	name,
		const ValueType &	value
	)

Set parameter to value value.

Treat the set parameter as an independent for derivative computations.

Definition at line 124 of file Sacado_ScalarParameterLibrary.hpp.

template<class ValueType>

const ValueType & Sacado::ScalarParameterLibrary::getValue

(

const std::string &

name

)

const

Get parameter value.

Definition at line 138 of file Sacado_ScalarParameterLibrary.hpp.

static ScalarParameterLibrary& Sacado::ScalarParameterLibrary::getInstance

(

)

[inline, static]

Returns a parameter library (singleton object).

Definition at line 82 of file Sacado_ScalarParameterLibrary.hpp.

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

Fill a vector with the supplied parameter names.

baseValue will be computed from each individual parameter

Definition at line 49 of file Sacado_ScalarParameterLibrary.cpp.

ScalarParameterLibrary& Sacado::ScalarParameterLibrary::operator=

(

const ScalarParameterLibrary &

)

[private]

Private to prohibit copying.

---

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

• Sacado_ScalarParameterLibrary.hpp
• Sacado_ScalarParameterLibrary.cpp

---