FunctionParserUtils Class Reference

#include <FunctionParserUtils.h>

Inheritance diagram for FunctionParserUtils:

Public Types
typedef FunctionParserADBase< Real >	ADFunction
	Shorthand for an autodiff function parser object. More...
typedef std::shared_ptr< ADFunction >	ADFunctionPtr
	Shorthand for an smart pointer to an autodiff function parser object. More...

Public Member Functions
	FunctionParserUtils (const InputParameters &parameters)
void	setParserFeatureFlags (ADFunctionPtr &)
	apply input paramters to internal feature flags of the parser object More...

Protected Member Functions
Real	evaluate (ADFunctionPtr &)
	Evaluate FParser object and check EvalError. More...
void	addFParserConstants (ADFunctionPtr &parser, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions)
	add constants (which can be complex expressions) to the parser object More...

Protected Attributes
const Real	_nan
	appropriate not a number value to return More...
std::vector< Real >	_func_params
	Array to stage the parameters passed to the functions when calling Eval. More...
bool	_enable_jit
bool	_enable_ad_cache
bool	_disable_fpoptimizer
bool	_enable_auto_optimize
bool	_fail_on_evalerror

Static Protected Attributes
static const char *	_eval_error_msg []
	table of FParser eval error codes More...

Detailed Description

Definition at line 30 of file FunctionParserUtils.h.

Member Typedef Documentation

ADFunction

typedef FunctionParserADBase<Real> FunctionParserUtils::ADFunction

Shorthand for an autodiff function parser object.

Definition at line 36 of file FunctionParserUtils.h.

ADFunctionPtr

typedef std::shared_ptr<ADFunction> FunctionParserUtils::ADFunctionPtr

Shorthand for an smart pointer to an autodiff function parser object.

Definition at line 39 of file FunctionParserUtils.h.

Constructor & Destructor Documentation

FunctionParserUtils()

FunctionParserUtils::FunctionParserUtils

(

const InputParameters &

parameters

)

Definition at line 56 of file FunctionParserUtils.C.

  : _enable_jit(parameters.isParamValid("enable_jit") && parameters.get<bool>("enable_jit")),
    _enable_ad_cache(parameters.get<bool>("enable_ad_cache")),
    _disable_fpoptimizer(parameters.get<bool>("disable_fpoptimizer")),
    _enable_auto_optimize(parameters.get<bool>("enable_auto_optimize") && !_disable_fpoptimizer),
    _fail_on_evalerror(parameters.get<bool>("fail_on_evalerror")),
    _nan(std::numeric_limits<Real>::quiet_NaN())
{
#ifndef LIBMESH_HAVE_FPARSER_JIT
  if (_enable_jit)
  {
    mooseWarning("Tried to enable FParser JIT but libmesh does not have it compiled in.");
    _enable_jit = false;
  }
#endif
}

Member Function Documentation

addFParserConstants()

void FunctionParserUtils::addFParserConstants ( ADFunctionPtr &  parser, const std::vector< std::string > &  constant_names, const std::vector< std::string > &  constant_expressions  )

protected

add constants (which can be complex expressions) to the parser object

Definition at line 106 of file FunctionParserUtils.C.

Referenced by ParsedMaterialHelper::functionParse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), and ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier().

{
  // check constant vectors
  unsigned int nconst = constant_expressions.size();
  if (nconst != constant_expressions.size())
    mooseError("The parameter vectors constant_names and constant_values must have equal length.");

  // previously evaluated constant_expressions may be used in following constant_expressions
  std::vector<Real> constant_values(nconst);

  for (unsigned int i = 0; i < nconst; ++i)
  {
    ADFunctionPtr expression = ADFunctionPtr(new ADFunction());

    // set FParser internal feature flags
    setParserFeatureFlags(expression);

    // add previously evaluated constants
    for (unsigned int j = 0; j < i; ++j)
      if (!expression->AddConstant(constant_names[j], constant_values[j]))
        mooseError("Invalid constant name in ParsedMaterialHelper");

    // build the temporary comnstant expression function
    if (expression->Parse(constant_expressions[i], "") >= 0)
      mooseError("Invalid constant expression\n",
                 constant_expressions[i],
                 "\n in parsed function object.\n",
                 expression->ErrorMsg());

    constant_values[i] = expression->Eval(NULL);

    if (!parser->AddConstant(constant_names[i], constant_values[i]))
      mooseError("Invalid constant name in parsed function object");
  }
}

evaluate()

Real FunctionParserUtils::evaluate ( ADFunctionPtr &  parser )

protected

Evaluate FParser object and check EvalError.

Definition at line 81 of file FunctionParserUtils.C.

Referenced by DerivativeParsedMaterialHelper::computeProperties(), ParsedMaterialHelper::computeProperties(), ParsedODEKernel::computeQpJacobian(), ParsedODEKernel::computeQpOffDiagJacobian(), ParsedODEKernel::computeQpResidual(), ParsedAux::computeValue(), ParsedSubdomainMeshGenerator::generate(), ParsedGenerateSideset::generate(), ParsedAddSideset::modify(), and ParsedSubdomainMeshModifier::modify().

{
  // null pointer is a shortcut for vanishing derivatives, see functionsOptimize()
  if (parser == NULL)
    return 0.0;

  // evaluate expression
  Real result = parser->Eval(_func_params.data());

  // fetch fparser evaluation error
  int error_code = parser->EvalError();

  // no error
  if (error_code == 0)
    return result;

  // hard fail or return not a number
  if (_fail_on_evalerror)
    mooseError("DerivativeParsedMaterial function evaluation encountered an error: ",
               _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code]);

  return _nan;
}

setParserFeatureFlags()

void FunctionParserUtils::setParserFeatureFlags

(

ADFunctionPtr &

parser

)

apply input paramters to internal feature flags of the parser object

Definition at line 74 of file FunctionParserUtils.C.

Referenced by addFParserConstants(), ParsedMaterialHelper::functionParse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), and ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier().

{
  parser->SetADFlags(ADFunction::ADCacheDerivatives, _enable_ad_cache);
  parser->SetADFlags(ADFunction::ADAutoOptimize, _enable_auto_optimize);
}

Member Data Documentation

_disable_fpoptimizer

bool FunctionParserUtils::_disable_fpoptimizer

protected

Definition at line 56 of file FunctionParserUtils.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), ParsedMaterialHelper::functionsOptimize(), ParsedAux::ParsedAux(), and ParsedODEKernel::ParsedODEKernel().

_enable_ad_cache

bool FunctionParserUtils::_enable_ad_cache

protected

Definition at line 55 of file FunctionParserUtils.h.

Referenced by setParserFeatureFlags().

_enable_auto_optimize

bool FunctionParserUtils::_enable_auto_optimize

protected

Definition at line 57 of file FunctionParserUtils.h.

Referenced by setParserFeatureFlags().

_enable_jit

bool FunctionParserUtils::_enable_jit

protected

Definition at line 54 of file FunctionParserUtils.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), FunctionParserUtils(), ParsedMaterialHelper::functionsOptimize(), ParsedAux::ParsedAux(), and ParsedODEKernel::ParsedODEKernel().

_eval_error_msg

const char * FunctionParserUtils::_eval_error_msg

staticprotected

Initial value:

= {
    "Unknown",
    "Division by zero",
    "Square root of a negative value",
    "Logarithm of negative value",
    "Trigonometric error (asin or acos of illegal value)",
    "Maximum recursion level reached"}

table of FParser eval error codes

Definition at line 65 of file FunctionParserUtils.h.

Referenced by evaluate().

_fail_on_evalerror

bool FunctionParserUtils::_fail_on_evalerror

protected

Definition at line 58 of file FunctionParserUtils.h.

Referenced by evaluate().

_func_params

std::vector<Real> FunctionParserUtils::_func_params

protected

Array to stage the parameters passed to the functions when calling Eval.

Definition at line 68 of file FunctionParserUtils.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), DerivativeParsedMaterialHelper::computeProperties(), ParsedMaterialHelper::computeProperties(), ParsedAux::computeValue(), evaluate(), ParsedMaterialHelper::functionParse(), ParsedSubdomainMeshGenerator::generate(), ParsedGenerateSideset::generate(), ParsedAddSideset::modify(), ParsedSubdomainMeshModifier::modify(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), and ParsedODEKernel::updateParams().

_nan

const Real FunctionParserUtils::_nan

protected

appropriate not a number value to return

Definition at line 62 of file FunctionParserUtils.h.

Referenced by evaluate().

---

The documentation for this class was generated from the following files:

• include/utils/FunctionParserUtils.h
• src/utils/FunctionParserUtils.C