MemoizedFunctionInterface.h File Reference

Go to the source code of this file.

Classes
class	MemoizedFunctionInterface
	Implementation of Function that memoizes (caches) former evaluations in an unordered map using a hash of the evaluation locations as the key. More...

Functions
template<>
InputParameters	validParams< MemoizedFunctionInterface > ()

Function Documentation

validParams< MemoizedFunctionInterface >()

template<>

InputParameters validParams< MemoizedFunctionInterface >

(

)

Definition at line 14 of file MemoizedFunctionInterface.C.

{
  InputParameters params = validParams<Function>();
 
  params.addClassDescription("The function uses a cache to potentially reduce the computational "
                             "burden of reusing a complex or costly function");
 
  params.addParam<bool>("enable_cache",
                        false,
                        "Enables cached function evaluations. Recommended only if this function is "
                        "used directly in a BC or Kernel. This will be enabled automatically if "
                        "any of the FX-based BCs are used.");
 
  params.addParam<bool>("respect_time", false, "Enable to clear the cache at each new time step.");
 
  return params;
}

Referenced by validParams< MutableCoefficientsFunctionInterface >().