libMesh::ParsedFunctionParameter< T > Class Template Reference

Accessor object allowing reading and modification of the independent variables in a parameter sensitivity calculation. More...

#include <parsed_function_parameter.h>

Inheritance diagram for libMesh::ParsedFunctionParameter< T >:

Public Member Functions
	ParsedFunctionParameter (ParsedFunction< T > &func_ref, std::string param_name)
	Constructor: take the function to be modified and the name of the inline variable within it which represents our parameter.
virtual ParameterAccessor< T > &	operator= (T *)
	A simple reseater won't work with a parsed function.
virtual void	set (const T &new_value) override
	Setter: change the value of the parameter we access.
virtual const T &	get () const override
	Getter: get the value of the parameter we access.
virtual std::unique_ptr< ParameterAccessor< T > >	clone () const override
ParameterProxy< T >	operator* ()
	Proxy: for backward compatibility, we allow codes to treat a ParameterAccessor as if it were a simple pointer-to-value.
ConstParameterProxy< T >	operator* () const

Private Attributes
ParsedFunction< T > &	_func
std::string	_name
libMesh::Number	_current_val

Detailed Description

template<typename T = Number>
class libMesh::ParsedFunctionParameter< T >

Accessor object allowing reading and modification of the independent variables in a parameter sensitivity calculation.

This ParameterAccessor subclass is specific to ParsedFunction objects: it stores a pointer to the ParsedFunction and a string describing the parameter (an inline variable) name to be accessed.

Author

Roy Stogner

Date

2015

Stores a pointer to a parsed function and a string for the parameter.

Definition at line 48 of file parsed_function_parameter.h.

Constructor & Destructor Documentation

ParsedFunctionParameter()

template<typename T = Number>

libMesh::ParsedFunctionParameter< T >::ParsedFunctionParameter ( ParsedFunction< T > &  func_ref, std::string  param_name  )

inline

Constructor: take the function to be modified and the name of the inline variable within it which represents our parameter.

The restrictions of get_inline_value() and set_inline_value() in ParsedFunction apply to this interface as well.

Note

Only the function referred to here is changed by set() - any clones of the function which precede the set() remain at their previous values.

Definition at line 62 of file parsed_function_parameter.h.

                                                :
    _func(func_ref), _name(std::move(param_name)) {}

Member Function Documentation

clone()

template<typename T = Number>

virtual std::unique_ptr< ParameterAccessor< T > > libMesh::ParsedFunctionParameter< T >::clone ( ) const

inlineoverridevirtual

Returns

A new copy of the accessor.

Implements libMesh::ParameterAccessor< T >.

Definition at line 90 of file parsed_function_parameter.h.

                                                                     {
    return std::make_unique<ParsedFunctionParameter<T>>(_func, _name);
  }

References libMesh::ParsedFunctionParameter< T >::_func, and libMesh::ParsedFunctionParameter< T >::_name.

get()

template<typename T = Number>

virtual const T & libMesh::ParsedFunctionParameter< T >::get ( ) const

inlineoverridevirtual

Getter: get the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 82 of file parsed_function_parameter.h.

                                          {
    _current_val = _func.get_inline_value(_name);
    return _current_val;
  }

References libMesh::ParsedFunctionParameter< T >::_current_val, libMesh::ParsedFunctionParameter< T >::_func, and libMesh::ParsedFunctionParameter< T >::_name.

operator*() [1/2]

template<typename T = Number>

ParameterProxy< T > libMesh::ParameterAccessor< T >::operator* ( )

inlineinherited

Proxy: for backward compatibility, we allow codes to treat a ParameterAccessor as if it were a simple pointer-to-value.

We can't safely allow "Number * n = parameter_vector[p]" to compile, but we can allow "*parameter_vector[p] += deltap" to work.

Definition at line 80 of file parameter_accessor.h.

{ return ParameterProxy<T>(*this); }

operator*() [2/2]

template<typename T = Number>

ConstParameterProxy< T > libMesh::ParameterAccessor< T >::operator* ( ) const

inlineinherited

Definition at line 82 of file parameter_accessor.h.

{ return ConstParameterProxy<T>(*this); }

operator=()

template<typename T = Number>

virtual ParameterAccessor< T > & libMesh::ParsedFunctionParameter< T >::operator= ( T *  )

inlinevirtual

A simple reseater won't work with a parsed function.

Definition at line 70 of file parsed_function_parameter.h.

{ libmesh_error(); return *this; }

set()

template<typename T = Number>

virtual void libMesh::ParsedFunctionParameter< T >::set ( const T &  new_value )

inlineoverridevirtual

Setter: change the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 75 of file parsed_function_parameter.h.

                                                  {
    _func.set_inline_value(_name, new_value);
  }

References libMesh::ParsedFunctionParameter< T >::_func, and libMesh::ParsedFunctionParameter< T >::_name.

Member Data Documentation

_current_val

template<typename T = Number>

libMesh::Number libMesh::ParsedFunctionParameter< T >::_current_val

mutableprivate

Definition at line 101 of file parsed_function_parameter.h.

Referenced by libMesh::ParsedFunctionParameter< T >::get().

_func

template<typename T = Number>

ParsedFunction<T>& libMesh::ParsedFunctionParameter< T >::_func

private

Definition at line 95 of file parsed_function_parameter.h.

Referenced by libMesh::ParsedFunctionParameter< T >::clone(), libMesh::ParsedFunctionParameter< T >::get(), and libMesh::ParsedFunctionParameter< T >::set().

_name

template<typename T = Number>

std::string libMesh::ParsedFunctionParameter< T >::_name

private

Definition at line 96 of file parsed_function_parameter.h.

Referenced by libMesh::ParsedFunctionParameter< T >::clone(), libMesh::ParsedFunctionParameter< T >::get(), and libMesh::ParsedFunctionParameter< T >::set().

---

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

• include/numerics/parsed_function_parameter.h