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 >:

[legend]

Public Member Functions
	ParameterMultiPointer ()
	Constructor: no parameters attached yet. More...

	ParameterMultiPointer (T *param_ptr)
	Constructor: take the first raw pointer to the parameter. More...

virtual ParameterAccessor< T > &	operator= (T *) override
	A simple reseater won't work with a multipointer. 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

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. More...

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 ( )

Constructor: no parameters attached yet.

Definition at line 53 of file parameter_multipointer.h.

53 {}

◆ ParameterMultiPointer() [2/2]

template<typename T = Number>

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

Constructor: take the first raw pointer to the parameter.

Definition at line 58 of file parameter_multipointer.h.

58 : _ptrs(1, param_ptr) {}

libMesh::ParameterMultiPointer::_ptrs

std::vector< T * > _ptrs

Definition: parameter_multipointer.h:127

Member Function Documentation

◆ clone()

template<typename T = Number>

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

overridevirtual

Returns: A new copy of the accessor.

Implements libMesh::ParameterAccessor< T >.

Definition at line 110 of file parameter_multipointer.h.

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

   {
     ParameterMultiPointer * pmp = new ParameterMultiPointer<T>();
     pmp->_ptrs = _ptrs;
 
     return std::unique_ptr<ParameterAccessor<T>>(pmp);
   }

◆ get()

template<typename T = Number>

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

overridevirtual

Getter: get the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 94 of file parameter_multipointer.h.

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

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

◆ operator*() [1/2]

template<typename T = Number>

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

inherited

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 91 of file parameter_accessor.h.

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

◆ operator*() [2/2]

template<typename T = Number>

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

inherited

Definition at line 93 of file parameter_accessor.h.

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

◆ operator=()

template<typename T = Number>

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

overridevirtual

A simple reseater won't work with a multipointer.

Reimplemented from libMesh::ParameterAccessor< T >.

Definition at line 65 of file parameter_multipointer.h.

   {
     libmesh_error();
     return *this;
   }

◆ push_back()

template<typename T = Number>

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

Definition at line 118 of file parameter_multipointer.h.

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

118 { _ptrs.push_back(new_ptr); }

libMesh::ParameterMultiPointer::_ptrs

std::vector< T * > _ptrs

Definition: parameter_multipointer.h:127

◆ set()

template<typename T = Number>

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

overridevirtual

Setter: change the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 75 of file parameter_multipointer.h.

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

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