parameter_pointer.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2018 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_PARAMETER_POINTER_H
21 #define LIBMESH_PARAMETER_POINTER_H
22 
23 
24 // Local Includes
25 #include "libmesh/libmesh_common.h"
27 #include "libmesh/auto_ptr.h" // libmesh_make_unique
28 
29 namespace libMesh
30 {
31 
44 template <typename T=Number>
46 {
47 public:
51  ParameterPointer(T * param_ptr) : _ptr(param_ptr) {}
55  virtual void set (const T & new_value) override
56  { libmesh_assert(_ptr); *_ptr = new_value; }
57 
61  virtual const T & get () const override
62  { libmesh_assert(_ptr); return *_ptr; }
63 
70 #ifdef LIBMESH_ENABLE_DEPRECATED
71  virtual ParameterAccessor<T> &
72  operator= (T * new_ptr) override
73  {
74  libmesh_deprecated();
75  _ptr = new_ptr;
76  return *this;
77  }
78 #endif
79 
83  virtual std::unique_ptr<ParameterAccessor<T>> clone() const override
84  {
85  return libmesh_make_unique<ParameterPointer<T>>(_ptr);
86  }
87 
88 private:
89  T * _ptr;
90 };
91 
92 } // namespace libMesh
93 
94 #endif // LIBMESH_PARAMETER_POINTER_H
Stores/modifies a user-provided pointer to a parameter.
virtual ParameterAccessor< T > & operator=(T *new_ptr) override
virtual std::unique_ptr< ParameterAccessor< T > > clone() const override
Base class for reading/writing sensitivity parameters.