parameter_multipointer.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_PARAMETER_MULTIPOINTER_H
#define LIBMESH_PARAMETER_MULTIPOINTER_H


// Local Includes
#include "libmesh/libmesh_common.h"
#include "libmesh/parameter_accessor.h"

// C++ Includes
#include <vector>

namespace libMesh
{

template <typename T=Number>
class ParameterMultiPointer : public ParameterAccessor<T>
{
public:
  ParameterMultiPointer() {}

  ParameterMultiPointer(T * param_ptr) : _ptrs(1, param_ptr) {}

  virtual void set (const T & new_value) override
  {
    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;
      }
  }

  virtual const T & get () const override
  {
    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;
  }

  virtual std::unique_ptr<ParameterAccessor<T>> clone() const override
  {
    auto pmp = std::make_unique<ParameterMultiPointer<T>>();
    pmp->_ptrs = _ptrs;
    return pmp;
  }

  void push_back (T * new_ptr) { _ptrs.push_back(new_ptr); }

  std::size_t size() const { return _ptrs.size(); }

private:
  std::vector<T *> _ptrs;
};

} // namespace libMesh

#endif // LIBMESH_PARAMETER_MULTIPOINTER_H