parameter_vector.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_VECTOR_H
#define LIBMESH_PARAMETER_VECTOR_H


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

// C++ Includes
#include <vector>
#include <memory>

namespace libMesh
{


class ParameterVector
{
public:
  ParameterVector() = default;

  explicit
  ParameterVector(const std::vector<Number *> & params);

  ~ParameterVector() = default;

  void deep_copy(ParameterVector & target) const;

  void shallow_copy(ParameterVector & target) const;

  void value_copy(ParameterVector & target) const;

  void clear();

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

  void resize(std::size_t s);

  void push_back(std::unique_ptr<ParameterAccessor<Number>> new_accessor);

  void deep_resize(std::size_t s);

  const ParameterAccessor<Number> & operator[](std::size_t i) const;

  ParameterAccessor<Number> & operator[](std::size_t i);

  ParameterVector & operator *= (const Number a);

  ParameterVector & operator += (const ParameterVector & a);

private:
  std::vector<std::unique_ptr<ParameterAccessor<Number>>> _params;

  std::vector<Number> _my_data;

#ifndef NDEBUG

  bool _is_shallow_copy = false;
#endif
};



// ------------------------------------------------------------
// ParameterVector inline methods


inline
void
ParameterVector::clear()
{
  _params.clear();
  _my_data.clear();
}



inline
void ParameterVector::push_back(std::unique_ptr<ParameterAccessor<Number>> new_accessor)
{
  // Can't append stuff we are responsible for if we're already a shallow copy.
  libmesh_assert(!_is_shallow_copy);
  libmesh_assert(new_accessor.get());
  _params.push_back(std::move(new_accessor));
}



inline
const ParameterAccessor<Number> & ParameterVector::operator[] (std::size_t i) const
{
  libmesh_assert_greater (_params.size(), i);

  return *_params[i];
}



inline
ParameterAccessor<Number> & ParameterVector::operator[] (std::size_t i)
{
  libmesh_assert_greater (_params.size(), i);

  return *_params[i];
}

} // namespace libMesh

#endif // LIBMESH_PARAMETER_VECTOR_H