libMesh::ParameterPointer< T > Class Template Reference

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

#include <parameter_pointer.h>

Inheritance diagram for libMesh::ParameterPointer< T >:

Public Member Functions
	ParameterPointer (T *param_ptr)
	Constructor: take the raw pointer to the parameter. More...
virtual void	set (const T &new_value) override
	Setter: change the value of the parameter we access. More...
virtual const T &	get () const override
	Getter: get the value of the parameter we access. More...
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. More...
ConstParameterProxy< T >	operator* () const

Private Attributes
T *	_ptr

Detailed Description

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

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

This is the "default" ParameterAccessor subclass: it simply stores a user-provided pointer to the parameter, and modifies the value at that location in memory.

Author

Roy Stogner

Date

2015 Stores/modifies a user-provided pointer to a parameter.

Definition at line 47 of file parameter_pointer.h.

Constructor & Destructor Documentation

ParameterPointer()

template<typename T = Number>

libMesh::ParameterPointer< T >::ParameterPointer ( T *  param_ptr )

inline

Constructor: take the raw pointer to the parameter.

Definition at line 53 of file parameter_pointer.h.

: _ptr(param_ptr) {}

Member Function Documentation

clone()

template<typename T = Number>

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

inlineoverridevirtual

Returns

A new copy of the accessor.

Implements libMesh::ParameterAccessor< T >.

Definition at line 69 of file parameter_pointer.h.

References libMesh::ParameterPointer< T >::_ptr.

  {
    return std::make_unique<ParameterPointer<T>>(_ptr);
  }

get()

template<typename T = Number>

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

inlineoverridevirtual

Getter: get the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 63 of file parameter_pointer.h.

References libMesh::ParameterPointer< T >::_ptr, and libMesh::libmesh_assert().

  { libmesh_assert(_ptr); return *_ptr; }

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); }

set()

template<typename T = Number>

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

inlineoverridevirtual

Setter: change the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 57 of file parameter_pointer.h.

References libMesh::ParameterPointer< T >::_ptr, and libMesh::libmesh_assert().

  { libmesh_assert(_ptr); *_ptr = new_value; }

Member Data Documentation

_ptr

template<typename T = Number>

T* libMesh::ParameterPointer< T >::_ptr

private

Definition at line 75 of file parameter_pointer.h.

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

---

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

• include/systems/parameter_pointer.h