parameter_vector.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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_pointer.h"

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

namespace libMesh
{


class ParameterVector
{
public:
  ParameterVector() : _is_shallow_copy(false) {}

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

  ~ParameterVector();

  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(unsigned int s);

  void deep_resize(unsigned int s);

  const ParameterAccessor<Number>& operator[](unsigned int i) const;

  ParameterAccessor<Number>& operator[](unsigned int i);

  ParameterVector& operator *= (const Number a);

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

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

  std::vector<Number> _my_data;

  bool _is_shallow_copy;
};



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

inline
ParameterVector::ParameterVector(const std::vector<Number *> &params)
  : _is_shallow_copy(false)
{
  _params.reserve(params.size());

  for (unsigned int i=0; i != params.size(); ++i)
    _params.push_back(new ParameterPointer<Number>(params[i]));
}


inline
ParameterVector::~ParameterVector()
{
  this->clear();
}


inline
void
ParameterVector::clear()
{
  if (_is_shallow_copy)
    for (unsigned int i=0; i != _params.size(); ++i)
      delete _params[i];

  _params.clear();
  _my_data.clear();
}



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

  return *_params[i];
}



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

  return *_params[i];
}

} // namespace libMesh

#endif // LIBMESH_PARAMETER_VECTOR_H