A wrapper class for creating and evaluating parsed functions via the libMesh::ParsedFunction interface for fparser. More...

#include <MooseParsedFunctionWrapper.h>

Public Member Functions
	MooseParsedFunctionWrapper (FEProblemBase &feproblem, const std::string &function_str, const std::vector< std::string > &vars, const std::vector< std::string > &vals, const THREAD_ID tid=0)
	Class constructor. More...

virtual	~MooseParsedFunctionWrapper ()
	Class destruction Deletes the pointer to the dynamically allocated instance of the underlying libMesh::ParsedFunction. More...

template<typename T >
T	evaluate (Real t, const Point &p)
	A template method for performing the evaluation of the libMesh::ParsedFunction Within the source two specializations exists for returning a scalar or vector; template specialization was utilized to allow for generic expansion. More...

RealGradient	evaluateGradient (Real t, const Point &p)
	Evaluate the gradient of the function which libMesh provides through automatic differentiation. More...

Real	evaluateDot (Real t, const Point &p)
	Evaluate the time derivative of the function which libMesh provides through automatic differentiation. More...

template<>
Real	evaluate (Real t, const Point &p)

template<>
DenseVector< Real >	evaluate (Real t, const Point &p)

template<>
RealVectorValue	evaluate (Real t, const Point &p)

Private Member Functions
void	initialize ()
	Initialization method that prepares the _vars and _initial_vals for use by the libMesh::ParsedFunction object allocated in the constructor. More...

void	update ()
	Updates postprocessor and scalar values for use in the libMesh::ParsedFunction. More...

void	updateFunctionValues (Real t, const Point &pt)
	Updates function values for use in the libMesh::ParsedFunction. More...

Private Attributes
FEProblemBase &	_feproblem
	Reference to the FEProblemBase object. More...

const std::string &	_function_str
	Reference to the string containing the function to evaluate. More...

const std::vector< std::string > &	_vars
	List of variables supplied from the user. More...

const std::vector< std::string > &	_vals_input
	List of the values for the variables supplied by the user. More...

std::vector< Real >	_initial_vals
	Storage for the initial values of _vars variables used by the libMesh::ParsedFunction object. More...

std::unique_ptr< ParsedFunction< Real > >	_function_ptr
	Pointer to the libMesh::ParsedFunction object. More...

std::vector< unsigned int >	_pp_index
	Stores indices into _addr variable that are connected to Postprocessors. More...

std::vector< const Real * >	_pp_vals
	Vector of pointers to postprocessor values this parsed function is using. More...

std::vector< unsigned int >	_scalar_index
	Stores indicies into _addr variable that are connected to Scalar Variables. More...

std::vector< const Real * >	_scalar_vals
	Vector of pointers to scalar variables values. More...

std::vector< unsigned int >	_function_index
	Stores indices into _addr that are connected to Functions this libMesh::ParsedFunction is using. More...

std::vector< const Function * >	_functions
	Vector of Functions this parsed function is using. More...

std::vector< Real * >	_addr
	Pointers to the variables that store the values of _vars inside the libMesh::ParsedFunction object. More...

const THREAD_ID	_tid
	The thread id passed from owning Function object. More...

Friends
class	ParsedFunctionTest

Detailed Description

A wrapper class for creating and evaluating parsed functions via the libMesh::ParsedFunction interface for fparser.

See also: MooseParsedFunction; MooseParsedGradFunction; MooseParsedVectorFunction

Definition at line 33 of file MooseParsedFunctionWrapper.h.

Constructor & Destructor Documentation

◆ MooseParsedFunctionWrapper()

MooseParsedFunctionWrapper::MooseParsedFunctionWrapper	(	FEProblemBase &	feproblem,
		const std::string &	function_str,
		const std::vector< std::string > &	vars,
		const std::vector< std::string > &	vals,
		const THREAD_ID	tid = `0`
	)

Class constructor.

Parameters

feproblem	Reference to the FEProblemBase object (provides access to Postprocessors)
function_str	A string that contains the function to evaluate
vars	A vector of variable names contained within the function
vals	A vector of variable values, matching the variables defined in vars

Definition at line 16 of file MooseParsedFunctionWrapper.C.

   : _feproblem(feproblem), _function_str(function_str), _vars(vars), _vals_input(vals), _tid(tid)
 {
   initialize();
 
   _function_ptr =
       std::make_unique<ParsedFunction<Real, RealGradient>>(_function_str, &_vars, &_initial_vals);
 
   for (auto & v : _vars)
     _addr.push_back(&_function_ptr->getVarAddress(v));
 }

◆ ~MooseParsedFunctionWrapper()

MooseParsedFunctionWrapper::~MooseParsedFunctionWrapper ( )

virtual

Class destruction Deletes the pointer to the dynamically allocated instance of the underlying libMesh::ParsedFunction.

Definition at line 32 of file MooseParsedFunctionWrapper.C.

32 {}

Member Function Documentation

◆ evaluate() [1/4]

template<typename T >

T MooseParsedFunctionWrapper::evaluate	(	Real	t,
		const Point &	p
	)

A template method for performing the evaluation of the libMesh::ParsedFunction Within the source two specializations exists for returning a scalar or vector; template specialization was utilized to allow for generic expansion.

◆ evaluate() [2/4]

Real MooseParsedFunctionWrapper::evaluate	(	Real	t,
		const Point &	p
	)

Definition at line 36 of file MooseParsedFunctionWrapper.C.

 {
   update();
   updateFunctionValues(t, p);
   return (*_function_ptr)(p, t);
 }

◆ evaluate() [3/4]

DenseVector< Real > MooseParsedFunctionWrapper::evaluate	(	Real	t,
		const Point &	p
	)

Definition at line 45 of file MooseParsedFunctionWrapper.C.

 {
   update();
   updateFunctionValues(t, p);
   DenseVector<Real> output(LIBMESH_DIM);
   (*_function_ptr)(p, t, output);
   return output;
 }

◆ evaluate() [4/4]

RealVectorValue MooseParsedFunctionWrapper::evaluate	(	Real	t,
		const Point &	p
	)

Definition at line 56 of file MooseParsedFunctionWrapper.C.

 {
   DenseVector<Real> output = evaluate<DenseVector<Real>>(t, p);
 
   return RealVectorValue(output(0)
 #if LIBMESH_DIM > 1
                              ,
                          output(1)
 #endif
 #if LIBMESH_DIM > 2
                              ,
                          output(2)
 #endif
   );
 }

◆ evaluateDot()

Real MooseParsedFunctionWrapper::evaluateDot	(	Real	t,
		const Point &	p
	)

Evaluate the time derivative of the function which libMesh provides through automatic differentiation.

Definition at line 81 of file MooseParsedFunctionWrapper.C.

 {
   update();
   updateFunctionValues(t, p);
   return _function_ptr->dot(p, t);
 }

◆ evaluateGradient()

RealGradient MooseParsedFunctionWrapper::evaluateGradient	(	Real	t,
		const Point &	p
	)

Evaluate the gradient of the function which libMesh provides through automatic differentiation.

Definition at line 73 of file MooseParsedFunctionWrapper.C.

 {
   update();
   updateFunctionValues(t, p);
   return _function_ptr->gradient(p, t);
 }

◆ initialize()

void MooseParsedFunctionWrapper::initialize ( )

private

Initialization method that prepares the _vars and _initial_vals for use by the libMesh::ParsedFunction object allocated in the constructor.

Definition at line 89 of file MooseParsedFunctionWrapper.C.

Referenced by MooseParsedFunctionWrapper().

 {
   // Loop through all the input values supplied by the users.
   for (unsigned int i = 0; i < _vals_input.size(); ++i)
   {
     // Case when a Postprocessor is found by the name given in the input values
     ReporterName r_name(_vals_input[i], "value");
     if (_feproblem.getReporterData().hasReporterValue<PostprocessorValue>(r_name))
     {
       const Real & pp_val = _feproblem.getPostprocessorValueByName(_vals_input[i]);
       _initial_vals.push_back(pp_val);
       _pp_vals.push_back(&pp_val);
       _pp_index.push_back(i);
     }
 
     // Case when a scalar variable is found by the name given in the input values
     else if (_feproblem.hasScalarVariable(_vals_input[i]))
     {
       auto & scalar_val = _feproblem.getScalarVariable(_tid, _vals_input[i]).sln()[0];
       _initial_vals.push_back(scalar_val);
       _scalar_vals.push_back(&scalar_val);
       _scalar_index.push_back(i);
     }
 
     // Case when a function is found by the name given in the input values
     else if (_feproblem.hasFunction(_vals_input[i]))
     {
       Function & fn = _feproblem.getFunction(_vals_input[i], _tid);
       _initial_vals.push_back(0);
       _functions.push_back(&fn);
       _function_index.push_back(i);
     }
 
     // Case when a Real is supplied
     else
     {
       Real val;
       try
       {
         val = MooseUtils::convert<Real>(_vals_input[i], true);
       }
       catch (const std::invalid_argument & e)
       {
         mooseError("'No postprocessor, scalar variable, or function with the name '",
                    _vals_input[i],
                    "' found. ",
                    e.what());
       }
       _initial_vals.push_back(val);
     }
   }
 }

◆ update()

void MooseParsedFunctionWrapper::update ( )

private

Updates postprocessor and scalar values for use in the libMesh::ParsedFunction.

Definition at line 143 of file MooseParsedFunctionWrapper.C.

Referenced by evaluate(), evaluateDot(), and evaluateGradient().

 {
   for (unsigned int i = 0; i < _pp_index.size(); ++i)
     (*_addr[_pp_index[i]]) = (*_pp_vals[i]);
 
   for (unsigned int i = 0; i < _scalar_index.size(); ++i)
     (*_addr[_scalar_index[i]]) = (*_scalar_vals[i]);
 }

◆ updateFunctionValues()

void MooseParsedFunctionWrapper::updateFunctionValues	(	Real	t,
		const Point &	pt
	)

private

Updates function values for use in the libMesh::ParsedFunction.

Definition at line 153 of file MooseParsedFunctionWrapper.C.

Referenced by evaluate(), evaluateDot(), and evaluateGradient().

 {
   for (unsigned int i = 0; i < _function_index.size(); ++i)
     (*_addr[_function_index[i]]) = _functions[i]->value(t, pt);
 }

Friends And Related Function Documentation

◆ ParsedFunctionTest

friend class ParsedFunctionTest

friend

Definition at line 136 of file MooseParsedFunctionWrapper.h.

Member Data Documentation

◆ _addr

std::vector<Real *> MooseParsedFunctionWrapper::_addr

private

Pointers to the variables that store the values of _vars inside the libMesh::ParsedFunction object.

Definition at line 114 of file MooseParsedFunctionWrapper.h.

Referenced by MooseParsedFunctionWrapper(), update(), and updateFunctionValues().

◆ _feproblem

FEProblemBase& MooseParsedFunctionWrapper::_feproblem

private

Reference to the FEProblemBase object.

Definition at line 78 of file MooseParsedFunctionWrapper.h.

Referenced by initialize().

◆ _function_index

std::vector<unsigned int> MooseParsedFunctionWrapper::_function_index

private

Stores indices into _addr that are connected to Functions this libMesh::ParsedFunction is using.

Definition at line 108 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and updateFunctionValues().

◆ _function_ptr

std::unique_ptr<ParsedFunction<Real> > MooseParsedFunctionWrapper::_function_ptr

private

Pointer to the libMesh::ParsedFunction object.

Definition at line 93 of file MooseParsedFunctionWrapper.h.

Referenced by evaluate(), evaluateDot(), evaluateGradient(), and MooseParsedFunctionWrapper().

◆ _function_str

const std::string& MooseParsedFunctionWrapper::_function_str

private

Reference to the string containing the function to evaluate.

Definition at line 81 of file MooseParsedFunctionWrapper.h.

Referenced by MooseParsedFunctionWrapper().

◆ _functions

std::vector<const Function *> MooseParsedFunctionWrapper::_functions

private

Vector of Functions this parsed function is using.

Definition at line 111 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and updateFunctionValues().

◆ _initial_vals

std::vector<Real> MooseParsedFunctionWrapper::_initial_vals

private

Storage for the initial values of _vars variables used by the libMesh::ParsedFunction object.

Definition at line 90 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and MooseParsedFunctionWrapper().

◆ _pp_index

std::vector<unsigned int> MooseParsedFunctionWrapper::_pp_index

private

Stores indices into _addr variable that are connected to Postprocessors.

Definition at line 96 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and update().

◆ _pp_vals

std::vector<const Real *> MooseParsedFunctionWrapper::_pp_vals

private

Vector of pointers to postprocessor values this parsed function is using.

Definition at line 99 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and update().

◆ _scalar_index

std::vector<unsigned int> MooseParsedFunctionWrapper::_scalar_index

private

Stores indicies into _addr variable that are connected to Scalar Variables.

Definition at line 102 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and update().

◆ _scalar_vals

std::vector<const Real *> MooseParsedFunctionWrapper::_scalar_vals

private

Vector of pointers to scalar variables values.

Definition at line 105 of file MooseParsedFunctionWrapper.h.

Referenced by initialize(), and update().

◆ _tid

const THREAD_ID MooseParsedFunctionWrapper::_tid

private

The thread id passed from owning Function object.

Definition at line 117 of file MooseParsedFunctionWrapper.h.

Referenced by initialize().

◆ _vals_input

const std::vector<std::string>& MooseParsedFunctionWrapper::_vals_input

private

List of the values for the variables supplied by the user.

Definition at line 87 of file MooseParsedFunctionWrapper.h.

Referenced by initialize().

◆ _vars

const std::vector<std::string>& MooseParsedFunctionWrapper::_vars

private

List of variables supplied from the user.

Definition at line 84 of file MooseParsedFunctionWrapper.h.

Referenced by MooseParsedFunctionWrapper().

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

include/functions/MooseParsedFunctionWrapper.h
src/functions/MooseParsedFunctionWrapper.C

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MooseParsedFunctionWrapper()

◆ ~MooseParsedFunctionWrapper()

Member Function Documentation

◆ evaluate() [1/4]

◆ evaluate() [2/4]

◆ evaluate() [3/4]

◆ evaluate() [4/4]

◆ evaluateDot()

◆ evaluateGradient()

◆ initialize()

◆ update()

◆ updateFunctionValues()

Friends And Related Function Documentation

◆ ParsedFunctionTest

Member Data Documentation

◆ _addr

◆ _feproblem

◆ _function_index

◆ _function_ptr

◆ _function_str

◆ _functions

◆ _initial_vals

◆ _pp_index

◆ _pp_vals

◆ _scalar_index

◆ _scalar_vals

◆ _tid

◆ _vals_input

◆ _vars