Panzer Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
panzer::ScalarParameterEntry< EvalType > Class Template Reference

#include <Panzer_ScalarParameterEntry.hpp>

Inherits Sacado::ScalarParameterEntry< EvalType, panzer::EvaluationTraits >.

Public Types

typedef Sacado::ScalarParameterEntry< EvalType, panzer::EvaluationTraits >::ScalarT ScalarT
 

Public Member Functions

void setRealValue (double value)
 Sets the parameter's value from a plain double, converting to the evaluation type's scalar type.
 
void setValue (const ScalarT &value)
 Sets the parameter's value directly, in the evaluation type's scalar type.
 
const ScalarTgetValue () const
 Returns the parameter's current value.
 

Private Attributes

ScalarT m_parameter
 

Detailed Description

template<typename EvalType>
class panzer::ScalarParameterEntry< EvalType >

Holds a single scalar parameter's value for a given evaluation type, as tracked by the Sacado parameter library. Used to expose a named, possibly AD-differentiable, scalar (e.g. a physical constant) that can be looked up and updated through Panzer's scalar parameter registry.

Template Parameters
EvalTypethe evaluation type (e.g. Residual, Jacobian) whose scalar type this entry stores.

Definition at line 29 of file Panzer_ScalarParameterEntry.hpp.

Member Typedef Documentation

◆ ScalarT

template<typename EvalType >
typedef Sacado::ScalarParameterEntry<EvalType,panzer::EvaluationTraits>::ScalarT panzer::ScalarParameterEntry< EvalType >::ScalarT

Definition at line 33 of file Panzer_ScalarParameterEntry.hpp.

Member Function Documentation

◆ setRealValue()

template<typename EvalType >
void panzer::ScalarParameterEntry< EvalType >::setRealValue ( double  value)
inline

Sets the parameter's value from a plain double, converting to the evaluation type's scalar type.

Definition at line 36 of file Panzer_ScalarParameterEntry.hpp.

◆ setValue()

template<typename EvalType >
void panzer::ScalarParameterEntry< EvalType >::setValue ( const ScalarT value)
inline

Sets the parameter's value directly, in the evaluation type's scalar type.

Definition at line 42 of file Panzer_ScalarParameterEntry.hpp.

◆ getValue()

template<typename EvalType >
const ScalarT & panzer::ScalarParameterEntry< EvalType >::getValue ( ) const
inline

Returns the parameter's current value.

Definition at line 48 of file Panzer_ScalarParameterEntry.hpp.

Member Data Documentation

◆ m_parameter

template<typename EvalType >
ScalarT panzer::ScalarParameterEntry< EvalType >::m_parameter
private

Definition at line 55 of file Panzer_ScalarParameterEntry.hpp.


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