libMesh
parsed_fem_function_parameter.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2019 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 #include "libmesh/auto_ptr.h" // libmesh_make_unique
28 
29 namespace libMesh
30 {
31 
32 // Forward declarations
33 template <typename T> class ParsedFEMFunction;
34 
47 template <typename T=Number>
49 {
50 public:
63  const std::string & param_name) :
64  _func(func_ref), _name(param_name) {}
65 
69  virtual ParameterAccessor<T> &
70  operator= (T * /* new_ptr */) { libmesh_error(); return *this; }
71 
75  virtual void set (const T & new_value) {
76  _func.set_inline_value(_name, new_value);
77  }
78 
82  virtual const T & get () const {
84  return _current_val;
85  }
86 
90  virtual std::unique_ptr<ParameterAccessor<T>> clone() const {
91  return libmesh_make_unique<ParsedFEMFunctionParameter<T>>(_func, _name);
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
libMesh::Number
Real Number
Definition: libmesh_common.h:195
libMesh::ParameterAccessor
Accessor object allowing reading and modification of the independent variables in a parameter sensiti...
Definition: parameter_accessor.h:55
libMesh::ParsedFEMFunction::get_inline_value
Output get_inline_value(const std::string &inline_var_name) const
Definition: parsed_fem_function.h:445
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
libMesh::ParsedFEMFunctionParameter::set
virtual void set(const T &new_value)
Setter: change the value of the parameter we access.
Definition: parsed_fem_function_parameter.h:75
libMesh::ParsedFEMFunctionParameter::_func
ParsedFEMFunction< T > & _func
Definition: parsed_fem_function_parameter.h:95
libMesh::ParsedFEMFunction::set_inline_value
void set_inline_value(const std::string &inline_var_name, Output newval)
Changes the value of an inline variable.
Definition: parsed_fem_function.h:518
libMesh::ParsedFEMFunctionParameter::get
virtual const T & get() const
Definition: parsed_fem_function_parameter.h:82
libMesh::ParsedFEMFunction< T >
libMesh::ParsedFEMFunctionParameter
Accessor object allowing reading and modification of the independent variables in a parameter sensiti...
Definition: parsed_fem_function_parameter.h:48
libMesh::ParsedFEMFunctionParameter::clone
virtual std::unique_ptr< ParameterAccessor< T > > clone() const
Definition: parsed_fem_function_parameter.h:90
libMesh::ParsedFEMFunctionParameter::_name
std::string _name
Definition: parsed_fem_function_parameter.h:96
libMesh::ParsedFEMFunctionParameter::ParsedFEMFunctionParameter
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...
Definition: parsed_fem_function_parameter.h:62
libMesh::ParsedFEMFunctionParameter::_current_val
libMesh::Number _current_val
Definition: parsed_fem_function_parameter.h:101
libMesh::ParsedFEMFunctionParameter::operator=
virtual ParameterAccessor< T > & operator=(T *)
A simple reseater won't work with a parsed function.
Definition: parsed_fem_function_parameter.h:70