MemoizedFunctionInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include <map>
 
#include "Function.h"
 
#include "Hashing.h"
 
class MemoizedFunctionInterface : public Function
{
public:
  static InputParameters validParams();
 
  MemoizedFunctionInterface(const InputParameters & parameters);
 
  // Override from MeshChangedInterface
  virtual void meshChanged() override;
 
  void useCache(bool use);
 
  using Function::value;
  // Make this implementation of Function::value() final so derived classes cannot bypass the
  // memoization functionality it implements. Instead, deriving classes should implement
  // evaluateValue().
  virtual Real value(Real time, const Point & point) const final;
  virtual ADReal value(const ADReal & time, const ADPoint & point) const final;
 
protected:
  virtual Real evaluateValue(Real time, const Point & point) = 0;
 
  void invalidateCache();
 
private:
  mutable std::unordered_map<hashing::HashValue, Real> _cache;
 
  mutable Real _current_time;
 
  bool _enable_cache;
 
  bool _respect_time;
};