libMesh
parsed_fem_function_parameter.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2014 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_PARSED_FEM_FUNCTION_PARAMETER_H
21 #define LIBMESH_PARSED_FEM_FUNCTION_PARAMETER_H
22 
23 
24 // Local Includes
25 #include "libmesh/libmesh_common.h"
26 #include "libmesh/parameter_accessor.h"
27 
28 namespace libMesh
29 {
30 
31 // Forward declarations
32 template <typename T> class ParsedFEMFunction;
33 
46 template <typename T=Number>
48 {
49 public:
62  const std::string & param_name) :
63  _func(func_ref), _name(param_name) {}
64 
68  virtual ParameterAccessor<T> &
69  operator= (T * /* new_ptr */) { libmesh_error(); return *this; }
70 
74  virtual void set (const T & new_value) {
75  _func.set_inline_value(_name, new_value);
76  }
77 
81  virtual const T & get () const {
83  return _current_val;
84  }
85 
92  }
93 
94 private:
96  std::string _name;
97 
98  // We need to return a reference from get(). That's a pointless
99  // pessimization for libMesh::Number but it might become worthwhile
100  // later when we handle field parameters.
102 };
103 
104 } // namespace libMesh
105 
106 #endif // LIBMESH_PARSED_FEM_FUNCTION_PARAMETER_H
void set_inline_value(const std::string &inline_var_name, Output newval)
Changes the value of an inline variable.
virtual ParameterAccessor< T > & operator=(T *)
A simple reseater won&#39;t work with a parsed function.
ParsedFEMFunctionParameter(ParsedFEMFunction< T > &func_ref, const std::string &param_name)
Constructor: take the function to be modified and the name of the inline variable within it which rep...
The libMesh namespace provides an interface to certain functionality in the library.
std::unique_ptr< T > UniquePtr
Definition: auto_ptr.h:46
Output get_inline_value(const std::string &inline_var_name) const
virtual UniquePtr< ParameterAccessor< T > > clone() const
Accessor object allowing reading and modification of the independent variables in a parameter sensiti...
Accessor object allowing reading and modification of the independent variables in a parameter sensiti...