libMesh::ParameterMultiPointer< T > Class Template Reference

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

#include <parameter_multipointer.h>

Inheritance diagram for libMesh::ParameterMultiPointer< T >:

Public Member Functions
	ParameterMultiPointer ()
	Constructor: no parameters attached yet.
	ParameterMultiPointer (T *param_ptr)
	Constructor: take the first raw pointer to the parameter.
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
void	push_back (T *new_ptr)
std::size_t	size () const
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
std::vector< T * >	_ptrs

Detailed Description

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

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

This is a slightly flexible ParameterAccessor subclass: it stores all user-provided pointers to copies of the parameter, and modifies the value at each location in memory.

Author

Roy Stogner

Date

2015

Stores multiple user-provided pointers.

Definition at line 47 of file parameter_multipointer.h.

Constructor & Destructor Documentation

ParameterMultiPointer() [1/2]

template<typename T = Number>

libMesh::ParameterMultiPointer< T >::ParameterMultiPointer ( )

inline

Constructor: no parameters attached yet.

Definition at line 53 of file parameter_multipointer.h.

{}

ParameterMultiPointer() [2/2]

template<typename T = Number>

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

inline

Constructor: take the first raw pointer to the parameter.

Definition at line 58 of file parameter_multipointer.h.

: _ptrs(1, param_ptr) {}

Member Function Documentation

clone()

template<typename T = Number>

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

inlineoverridevirtual

Returns

A new copy of the accessor.

Implements libMesh::ParameterAccessor< T >.

Definition at line 98 of file parameter_multipointer.h.

  {
    auto pmp = std::make_unique<ParameterMultiPointer<T>>();
    pmp->_ptrs = _ptrs;
    return pmp;
  }

References libMesh::ParameterMultiPointer< T >::_ptrs.

get()

template<typename T = Number>

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

inlineoverridevirtual

Getter: get the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 82 of file parameter_multipointer.h.

  {
    libmesh_assert(!_ptrs.empty());
    T & val = *_ptrs[0];
#ifndef NDEBUG
    // If you're already using inconsistent parameters we can't help
    // you.
    for (auto ptr : _ptrs)
      libmesh_assert_equal_to(*ptr, val);
#endif
    return val;
  }

References libMesh::ParameterMultiPointer< T >::_ptrs, and libMesh::libmesh_assert().

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

push_back()

template<typename T = Number>

void libMesh::ParameterMultiPointer< T >::push_back ( T *  new_ptr )

inline

Definition at line 105 of file parameter_multipointer.h.

{ _ptrs.push_back(new_ptr); }

References libMesh::ParameterMultiPointer< T >::_ptrs.

set()

template<typename T = Number>

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

inlineoverridevirtual

Setter: change the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 63 of file parameter_multipointer.h.

  {
    libmesh_assert(!_ptrs.empty());
#ifndef NDEBUG
    // Compare other values to the last one we'll change
    const T & val = *_ptrs.back();
#endif
    for (auto & ptr : _ptrs)
      {
        // If you're already using inconsistent parameters we can't
        // help you.
        libmesh_assert_equal_to(*ptr, val);
        *ptr = new_value;
      }
  }

References libMesh::ParameterMultiPointer< T >::_ptrs, and libMesh::libmesh_assert().

size()

template<typename T = Number>

std::size_t libMesh::ParameterMultiPointer< T >::size ( ) const

inline

Returns

The number of data associated with this parameter. Useful for testing if the multipointer is empty/invalid.

Definition at line 111 of file parameter_multipointer.h.

{ return _ptrs.size(); }

References libMesh::ParameterMultiPointer< T >::_ptrs.

Member Data Documentation

_ptrs

template<typename T = Number>

std::vector<T *> libMesh::ParameterMultiPointer< T >::_ptrs

private

Definition at line 114 of file parameter_multipointer.h.

Referenced by libMesh::ParameterMultiPointer< T >::clone(), libMesh::ParameterMultiPointer< T >::get(), libMesh::ParameterMultiPointer< T >::push_back(), libMesh::ParameterMultiPointer< T >::set(), and libMesh::ParameterMultiPointer< T >::size().

---

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

• include/systems/parameter_multipointer.h