MooseParsedFunctionBase Class Reference

Adds user facing parameters for parsed function. More...

#include <MooseParsedFunctionBase.h>

Inheritance diagram for MooseParsedFunctionBase:

Public Member Functions
	MooseParsedFunctionBase (const InputParameters &parameters)
virtual	~MooseParsedFunctionBase ()
	Class destructor.

Static Public Member Functions
static InputParameters	validParams ()
	Class constructor for the interface.

Protected Member Functions
std::string	verifyFunction (const std::string &function_str)
	A helper method to check if the function value contains quotes.

Protected Attributes
FEProblemBase &	_pfb_feproblem
	Reference to the FEProblemBase class for this object.
const std::vector< std::string >	_vars
	Variables passed to libMesh::ParsedFunction.
const std::vector< std::string >	_vals
	Values passed by the user, they may be Reals for Postprocessors.
std::unique_ptr< MooseParsedFunctionWrapper >	_function_ptr
	Pointer to the Parsed function wrapper object for the scalar.

Detailed Description

Adds user facing parameters for parsed function.

See also

ParsedFunction ParsedVectorFunction ParsedGradFunction

Definition at line 37 of file MooseParsedFunctionBase.h.

Constructor & Destructor Documentation

MooseParsedFunctionBase()

MooseParsedFunctionBase::MooseParsedFunctionBase

(

const InputParameters &

parameters

)

Definition at line 32 of file MooseParsedFunctionBase.C.

  : _pfb_feproblem(*parameters.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
    _vars(parameters.get<std::vector<std::string>>("symbol_names")),
    _vals(parameters.get<std::vector<std::string>>("symbol_values"))
{
  if (_vars.size() != _vals.size())
    mooseError("Number of symbol_names must match the number of symbol_values!");
 
  // Loop through the variables assigned by the user and give an error if x,y,z,t are used
  for (const auto & var : _vars)
    if (var.find_first_of("xyzt") != std::string::npos && var.size() == 1)
      mooseError("The variables \"x, y, z, and t\" in the ParsedFunction are pre-declared for use "
                 "and must not be declared in \"symbol_names\"");
}

~MooseParsedFunctionBase()

MooseParsedFunctionBase::~MooseParsedFunctionBase ( )

virtual

Class destructor.

Definition at line 47 of file MooseParsedFunctionBase.C.

{}

Member Function Documentation

validParams()

InputParameters MooseParsedFunctionBase::validParams ( )

static

Class constructor for the interface.

The first parameter, 'name' is not currently used.

Parameters

parameters

Input parameters from the object, it must contain '_fe_problem'

Definition at line 18 of file MooseParsedFunctionBase.C.

{
  InputParameters params = emptyInputParameters();
  params.addParam<std::vector<std::string>>(
      "symbol_names",
      "Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding "
      "items in the symbol_values vector.");
  params.addParam<std::vector<std::string>>(
      "symbol_values",
      "Constant numeric values, postprocessor names, function names, and scalar variables "
      "corresponding to the symbols in symbol_names.");
  return params;
}

Referenced by ParsedChainControl::validParams(), MooseParsedFunction::validParams(), MooseParsedGradFunction::validParams(), and MooseParsedVectorFunction::validParams().

verifyFunction()

std::string MooseParsedFunctionBase::verifyFunction ( const std::string &  function_str )

protected

A helper method to check if the function value contains quotes.

This method should be called from within the initialization list of the object inheriting the MooseParsedFunctionInterface

Parameters

function_str

The name of the ParsedFunction

Returns

The vector of strings, if the input function is valid

See also

ParsedFunction

Definition at line 50 of file MooseParsedFunctionBase.C.

{
  // Throws an error if quotes are found
  if (function_str.find("\"") != std::string::npos)
    mooseError("The expression in ParsedFunction contains quotes which cannot be properly parsed");
 
  // Return the input equation (no error)
  return function_str;
}

Member Data Documentation

_function_ptr

std::unique_ptr<MooseParsedFunctionWrapper> MooseParsedFunctionBase::_function_ptr

protected

Pointer to the Parsed function wrapper object for the scalar.

Definition at line 74 of file MooseParsedFunctionBase.h.

Referenced by MooseParsedFunction::gradient(), MooseParsedFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedVectorFunction::initialSetup(), MooseParsedFunction::timeDerivative(), MooseParsedGradFunction::value(), MooseParsedFunction::value(), and MooseParsedVectorFunction::vectorValue().

_pfb_feproblem

FEProblemBase& MooseParsedFunctionBase::_pfb_feproblem

protected

Reference to the FEProblemBase class for this object.

Definition at line 65 of file MooseParsedFunctionBase.h.

Referenced by ParsedChainControl::buildFunction(), MooseParsedFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), and MooseParsedVectorFunction::initialSetup().

_vals

const std::vector<std::string> MooseParsedFunctionBase::_vals

protected

Values passed by the user, they may be Reals for Postprocessors.

Definition at line 71 of file MooseParsedFunctionBase.h.

Referenced by ParsedChainControl::buildFunction(), MooseParsedFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedVectorFunction::initialSetup(), MFEMParsedFunction::initialSetup(), and MooseParsedFunctionBase().

_vars

const std::vector<std::string> MooseParsedFunctionBase::_vars

protected

Variables passed to libMesh::ParsedFunction.

Definition at line 68 of file MooseParsedFunctionBase.h.

Referenced by ParsedChainControl::buildFunction(), MooseParsedFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedVectorFunction::initialSetup(), MFEMParsedFunction::initialSetup(), and MooseParsedFunctionBase().

---

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

• include/functions/MooseParsedFunctionBase.h
• src/functions/MooseParsedFunctionBase.C