parsed_function_parameter.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_PARSED_FUNCTION_PARAMETER_H
#define LIBMESH_PARSED_FUNCTION_PARAMETER_H


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

// C++ Includes
#include <memory>

namespace libMesh
{

template <typename T=Number>
class ParsedFunctionParameter : public ParameterAccessor<T>
{
public:
  ParsedFunctionParameter(ParsedFunction<T> & func_ref,
                          std::string param_name) :
    _func(func_ref), _name(std::move(param_name)) {}

  virtual ParameterAccessor<T> &
  operator= (T * /* new_ptr */) { libmesh_error(); return *this; }

  virtual void set (const T & new_value) override {
    _func.set_inline_value(_name, new_value);
  }

  virtual const T & get () const override {
    _current_val = _func.get_inline_value(_name);
    return _current_val;
  }

  virtual std::unique_ptr<ParameterAccessor<T>> clone() const override {
    return std::make_unique<ParsedFunctionParameter<T>>(_func, _name);
  }

private:
  ParsedFunction<T> & _func;
  std::string _name;

  // We need to return a reference from get().  That's a pointless
  // pessimization for libMesh::Number but it might become worthwhile
  // later when we handle field parameters.
  mutable libMesh::Number _current_val;
};

} // namespace libMesh

#endif // LIBMESH_PARSED_FUNCTION_PARAMETER_H