Sacado Package Browser (Single Doxygen Collection) Version of the Day
|
Specialization of Sacado::ParameterFamilyBase for scalar parameters. More...
#include <Sacado_ScalarParameterFamily.hpp>
Public Member Functions | |
ScalarParameterFamily (const std::string &name_, bool supports_ad_, bool supports_analytic_) | |
Constructor. | |
virtual | ~ScalarParameterFamily () |
Destructor. | |
void | setRealValueForAllTypes (double value) |
Set paramter value using a real number. | |
template<class EvalType > | |
void | setRealValue (double value) |
Set real parameter value. | |
template<class EvalType > | |
void | setValue (const typename EvalTypeTraits::template apply< EvalType >::type &value) |
Set parameter to value value treating parameter as a constant. | |
template<class EvalType > | |
double | getRealValue () const |
Get real parameter value. | |
template<class EvalType > | |
const EvalTypeTraits::template apply< EvalType >::type & | getValue () const |
Get parameter value. | |
![]() | |
ParameterFamilyBase (const std::string &name, bool supports_ad, bool supports_analytic) | |
Constructor. | |
virtual | ~ParameterFamilyBase () |
Destructor. | |
std::string | getName () const |
Get the name of the family. | |
bool | supportsAD () const |
Indicates whether parameter supports AD derivatives. | |
bool | supportsAnalytic () const |
Indicates whether parameter supports analytic derivatives. | |
template<typename EvalType > | |
bool | hasType () const |
Determine if family has an entry for the given type EvalType . | |
template<typename EvalType > | |
bool | addEntry (const Teuchos::RCP< typename Sacado::mpl::apply< EntryType, EvalType >::type > &entry, const bool allow_overwrite=false) |
Add a new parameter using custom entry. | |
template<typename EvalType > | |
Teuchos::RCP< typename Sacado::mpl::apply< EntryType, EvalType >::type > | getEntry () |
Gets the entry corresponding to type EvalType. | |
template<typename EvalType > | |
Teuchos::RCP< const typename Sacado::mpl::apply< EntryType, EvalType >::type > | getEntry () const |
Gets the entry corresponding to type EvalType. | |
void | print (std::ostream &os, bool print_values=false) const |
Print the family. | |
Private Types | |
typedef Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, EvalTypeTraits > > | BaseT |
Typename synonym of base class. | |
Private Member Functions | |
ScalarParameterFamily (const ScalarParameterFamily &) | |
Add a new parameter using custom entry. | |
ScalarParameterFamily & | operator= (const ScalarParameterFamily &) |
Private to prohibit copying. | |
Related Symbols | |
(Note that these are not member symbols.) | |
template<typename EvalType , typename EvalTypeTraits > | |
Sacado::ScalarParameterEntry< EvalType >::ScalarT | getValue (const ScalarParameterFamily< EvalTypeTraits > &spf) |
Get the value. | |
Additional Inherited Members | |
![]() | |
typedef std::map< std::string, Teuchos::RCP< EntryBase > > | EvalMap |
Map of entries for a parameter name. | |
typedef EvalMap::const_iterator | const_iterator |
Const iterator for EvalMap. | |
typedef EvalMap::iterator | iterator |
Iterator for EvalMap. | |
![]() | |
template<class EvalType > | |
std::string | getTypeName () const |
Returns a string representation of type EntryType. | |
![]() | |
EvalMap | family |
Family of parameter entries. | |
const std::string | name |
Family name. | |
bool | supports_ad |
Family supports AD. | |
bool | supports_analytic |
Family supports analytic derivatives. | |
Specialization of Sacado::ParameterFamilyBase for scalar parameters.
Definition at line 42 of file Sacado_ScalarParameterFamily.hpp.
|
private |
Typename synonym of base class.
Definition at line 49 of file Sacado_ScalarParameterFamily.hpp.
|
inline |
Constructor.
Definition at line 54 of file Sacado_ScalarParameterFamily.hpp.
|
inlinevirtual |
Destructor.
Definition at line 61 of file Sacado_ScalarParameterFamily.hpp.
|
private |
Add a new parameter using custom entry.
Returns true if successful in adding entry to library, false otherwise. Private to prohibit copying
|
inline |
Set paramter value using a real number.
Definition at line 64 of file Sacado_ScalarParameterFamily.hpp.
|
inline |
Set real parameter value.
Definition at line 73 of file Sacado_ScalarParameterFamily.hpp.
|
inline |
Set parameter to value value treating parameter as a constant.
Definition at line 81 of file Sacado_ScalarParameterFamily.hpp.
|
inline |
Get real parameter value.
Definition at line 89 of file Sacado_ScalarParameterFamily.hpp.
|
inline |
Get parameter value.
Definition at line 97 of file Sacado_ScalarParameterFamily.hpp.
|
private |
Private to prohibit copying.
|
related |
Get the value.
Definition at line 124 of file Sacado_ScalarParameterFamily.hpp.