libMesh::ParameterMultiAccessor< T > Class Template Reference

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

#include <parameter_multiaccessor.h>

Inheritance diagram for libMesh::ParameterMultiAccessor< T >:

Public Member Functions
	ParameterMultiAccessor ()=default
	Constructor: no parameters attached yet.
	ParameterMultiAccessor (const ParameterAccessor< T > &param_accessor)
	Constructor: take the first sub-accessor for the parameter.
	~ParameterMultiAccessor ()=default
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 (const ParameterAccessor< T > &new_accessor)
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< std::unique_ptr< ParameterAccessor< T > > >	_accessors

Detailed Description

template<typename T = Number>
class libMesh::ParameterMultiAccessor< 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 a user-provided pointer to a parameter.

Definition at line 47 of file parameter_multiaccessor.h.

Constructor & Destructor Documentation

ParameterMultiAccessor() [1/2]

template<typename T = Number>

libMesh::ParameterMultiAccessor< T >::ParameterMultiAccessor ( )

default

Constructor: no parameters attached yet.

ParameterMultiAccessor() [2/2]

template<typename T = Number>

libMesh::ParameterMultiAccessor< T >::ParameterMultiAccessor ( const ParameterAccessor< T > &  param_accessor )

inline

Constructor: take the first sub-accessor for the parameter.

Definition at line 58 of file parameter_multiaccessor.h.

                                                                      :
    _accessors(1, param_accessor.clone()) {}

~ParameterMultiAccessor()

template<typename T = Number>

libMesh::ParameterMultiAccessor< T >::~ParameterMultiAccessor ( )

default

Member Function Documentation

clone()

template<typename T = Number>

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

inlineoverridevirtual

Returns

A new copy of the accessor.

Implements libMesh::ParameterAccessor< T >.

Definition at line 104 of file parameter_multiaccessor.h.

  {
    auto pmp = std::make_unique<ParameterMultiAccessor<T>>();
    for (auto & accessor : _accessors)
      pmp->_accessors.push_back(accessor->clone());
 
    return pmp;
  }

References libMesh::ParameterMultiAccessor< T >::_accessors.

get()

template<typename T = Number>

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

inlineoverridevirtual

Getter: get the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 88 of file parameter_multiaccessor.h.

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

References libMesh::ParameterMultiAccessor< T >::_accessors, 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::ParameterMultiAccessor< T >::push_back ( const ParameterAccessor< T > &  new_accessor )

inline

Definition at line 114 of file parameter_multiaccessor.h.

  {
    _accessors.push_back(new_accessor.clone());
  }

References libMesh::ParameterMultiAccessor< T >::_accessors, and libMesh::ParameterAccessor< T >::clone().

set()

template<typename T = Number>

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

inlineoverridevirtual

Setter: change the value of the parameter we access.

Implements libMesh::ParameterAccessor< T >.

Definition at line 69 of file parameter_multiaccessor.h.

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

References libMesh::ParameterMultiAccessor< T >::_accessors, and libMesh::libmesh_assert().

size()

template<typename T = Number>

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

inline

Returns

The number of sub-accessors associated with this parameter. Useful for testing if the multi-accessor is empty/invalid.

Definition at line 124 of file parameter_multiaccessor.h.

{ return _accessors.size(); }

References libMesh::ParameterMultiAccessor< T >::_accessors.

Member Data Documentation

_accessors

template<typename T = Number>

std::vector<std::unique_ptr<ParameterAccessor<T> > > libMesh::ParameterMultiAccessor< T >::_accessors

private

Definition at line 127 of file parameter_multiaccessor.h.

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

---

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

• include/systems/parameter_multiaccessor.h