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

#include <THMParsedFunctionWrapper.h>

Public Member Functions
	THMParsedFunctionWrapper (Simulation &sim, 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...

Real	evaluate (Real t, const Point &p)
	Perform the evaluation of the libMesh::ParsedFunction. More...

const std::vector< ControlData< Real > * >	getRealControlData ()
	Get list of Real-valued control data objects. More...

const std::vector< ControlData< bool > * >	getBoolControlData ()
	Get list of boolean-valued control data objects. More...

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 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...

void	updateControlDataValues ()
	Updates control data values for use in the libMesh::ParsedFunction. More...

Private Attributes
Simulation &	_sim
	Reference to the Simulation object. More...

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< libMesh::ParsedFunction< Real > >	_function_ptr
	Pointer to the libMesh::ParsedFunction object. More...

std::vector< unsigned int >	_cd_real_index
	Stores _addr variable indices for each ControlData<Real> value. More...

std::vector< ControlData< Real > * >	_cd_real_vals
	Vector of pointers to Real control data values this parsed function is using. More...

std::vector< unsigned int >	_cd_bool_index
	Stores _addr variable indices for each ControlData<bool> value. More...

std::vector< ControlData< bool > * >	_cd_bool_vals
	Vector of pointers to bool control data values this parsed function is using. More...

std::vector< unsigned int >	_scalar_index
	Stores _addr variable indices for each scalar variable value. More...

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

std::vector< unsigned int >	_function_index
	Stores _addr variable indices for each Function. 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 object. More...

Detailed Description

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

It has the same capability as MooseParsedFunctionWrapper but adds ability to use control data values

Definition at line 28 of file THMParsedFunctionWrapper.h.

Constructor & Destructor Documentation

◆ THMParsedFunctionWrapper()

THMParsedFunctionWrapper::THMParsedFunctionWrapper	(	Simulation &	sim,
		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

sim	Reference to the Simulation object (provides access to ControlData)
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 initial values, matching the variables defined in `vars`

Definition at line 17 of file THMParsedFunctionWrapper.C.

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

Member Function Documentation

◆ evaluate()

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

Perform the evaluation of the libMesh::ParsedFunction.

Definition at line 40 of file THMParsedFunctionWrapper.C.

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

◆ getBoolControlData()

const std::vector<ControlData<bool> *> THMParsedFunctionWrapper::getBoolControlData ( )

inline

Get list of boolean-valued control data objects.

Definition at line 59 of file THMParsedFunctionWrapper.h.

59 { return _cd_bool_vals; }

THMParsedFunctionWrapper::_cd_bool_vals

std::vector< ControlData< bool > * > _cd_bool_vals

Vector of pointers to bool control data values this parsed function is using.

Definition: THMParsedFunctionWrapper.h:93

◆ getRealControlData()

const std::vector<ControlData<Real> *> THMParsedFunctionWrapper::getRealControlData ( )

inline

Get list of Real-valued control data objects.

Definition at line 54 of file THMParsedFunctionWrapper.h.

54 { return _cd_real_vals; }

THMParsedFunctionWrapper::_cd_real_vals

std::vector< ControlData< Real > * > _cd_real_vals

Vector of pointers to Real control data values this parsed function is using.

Definition: THMParsedFunctionWrapper.h:87

◆ initialize()

void THMParsedFunctionWrapper::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 49 of file THMParsedFunctionWrapper.C.

Referenced by THMParsedFunctionWrapper().

 {
   for (unsigned int i = 0; i < _vals_input.size(); ++i)
   {
     if (_sim.hasControlData<Real>(_vals_input[i]))
     {
       ControlData<Real> * cd_val = _sim.getControlData<Real>(_vals_input[i]);
       _initial_vals.push_back(cd_val->get());
       _cd_real_vals.push_back(cd_val);
       _cd_real_index.push_back(i);
     }
     else if (_sim.hasControlData<bool>(_vals_input[i]))
     {
       ControlData<bool> * cd_val = _sim.getControlData<bool>(_vals_input[i]);
       _initial_vals.push_back(cd_val->get());
       _cd_bool_vals.push_back(cd_val);
       _cd_bool_index.push_back(i);
     }
     else if (_feproblem.hasScalarVariable(_vals_input[i]))
     {
       const VariableValue & scalar_val = _feproblem.getScalarVariable(_tid, _vals_input[i]).sln();
       _initial_vals.push_back(0);
       _scalar_vals.push_back(&scalar_val);
       _scalar_index.push_back(i);
     }
     else if (_feproblem.hasFunction(_vals_input[i]))
     {
       const Function & fn = _feproblem.getFunction(_vals_input[i], _tid);
       _initial_vals.push_back(0);
       _functions.push_back(&fn);
       _function_index.push_back(i);
     }
     else
     {
       Real val = MooseUtils::convert<Real>(_vals_input[i], true);
       _initial_vals.push_back(val);
     }
   }
 }

◆ update()

void THMParsedFunctionWrapper::update ( )

private

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

Definition at line 90 of file THMParsedFunctionWrapper.C.

Referenced by evaluate().

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

◆ updateControlDataValues()

void THMParsedFunctionWrapper::updateControlDataValues ( )

private

Updates control data values for use in the libMesh::ParsedFunction.

Definition at line 104 of file THMParsedFunctionWrapper.C.

Referenced by evaluate().

 {
   for (unsigned int i = 0; i < _cd_real_index.size(); ++i)
     (*_addr[_cd_real_index[i]]) = _cd_real_vals[i]->get();
 
   for (unsigned int i = 0; i < _cd_bool_index.size(); ++i)
     (*_addr[_cd_bool_index[i]]) = static_cast<Real>(_cd_bool_vals[i]->get());
 }

◆ updateFunctionValues()

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

private

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

Definition at line 97 of file THMParsedFunctionWrapper.C.

Referenced by evaluate().

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

Member Data Documentation

◆ _addr

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

private

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

Definition at line 108 of file THMParsedFunctionWrapper.h.

Referenced by THMParsedFunctionWrapper(), update(), updateControlDataValues(), and updateFunctionValues().

◆ _cd_bool_index

std::vector<unsigned int> THMParsedFunctionWrapper::_cd_bool_index

private

Stores _addr variable indices for each ControlData<bool> value.

Definition at line 90 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and updateControlDataValues().

◆ _cd_bool_vals

std::vector<ControlData<bool> *> THMParsedFunctionWrapper::_cd_bool_vals

private

Vector of pointers to bool control data values this parsed function is using.

Definition at line 93 of file THMParsedFunctionWrapper.h.

Referenced by getBoolControlData(), initialize(), and updateControlDataValues().

◆ _cd_real_index

std::vector<unsigned int> THMParsedFunctionWrapper::_cd_real_index

private

Stores _addr variable indices for each ControlData<Real> value.

Definition at line 84 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and updateControlDataValues().

◆ _cd_real_vals

std::vector<ControlData<Real> *> THMParsedFunctionWrapper::_cd_real_vals

private

Vector of pointers to Real control data values this parsed function is using.

Definition at line 87 of file THMParsedFunctionWrapper.h.

Referenced by getRealControlData(), initialize(), and updateControlDataValues().

◆ _feproblem

FEProblemBase& THMParsedFunctionWrapper::_feproblem

private

Reference to the FEProblemBase object.

Definition at line 66 of file THMParsedFunctionWrapper.h.

Referenced by initialize().

◆ _function_index

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

private

Stores _addr variable indices for each Function.

Definition at line 102 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and updateFunctionValues().

◆ _function_ptr

std::unique_ptr<libMesh::ParsedFunction<Real> > THMParsedFunctionWrapper::_function_ptr

private

Pointer to the libMesh::ParsedFunction object.

Definition at line 81 of file THMParsedFunctionWrapper.h.

Referenced by evaluate(), and THMParsedFunctionWrapper().

◆ _function_str

const std::string& THMParsedFunctionWrapper::_function_str

private

Reference to the string containing the function to evaluate.

Definition at line 69 of file THMParsedFunctionWrapper.h.

Referenced by THMParsedFunctionWrapper().

◆ _functions

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

private

Vector of Functions this parsed function is using.

Definition at line 105 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and updateFunctionValues().

◆ _initial_vals

std::vector<Real> THMParsedFunctionWrapper::_initial_vals

private

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

Definition at line 78 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and THMParsedFunctionWrapper().

◆ _scalar_index

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

private

Stores _addr variable indices for each scalar variable value.

Definition at line 96 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and update().

◆ _scalar_vals

std::vector<const VariableValue *> THMParsedFunctionWrapper::_scalar_vals

private

Vector of pointers to scalar variables values.

Definition at line 99 of file THMParsedFunctionWrapper.h.

Referenced by initialize(), and update().

◆ _sim

Simulation& THMParsedFunctionWrapper::_sim

private

Reference to the Simulation object.

Definition at line 63 of file THMParsedFunctionWrapper.h.

Referenced by initialize().

◆ _tid

const THREAD_ID THMParsedFunctionWrapper::_tid

private

The thread id passed from owning object.

Definition at line 111 of file THMParsedFunctionWrapper.h.

Referenced by initialize().

◆ _vals_input

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

private

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

Definition at line 75 of file THMParsedFunctionWrapper.h.

Referenced by initialize().

◆ _vars

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

private

List of variables supplied from the user.

Definition at line 72 of file THMParsedFunctionWrapper.h.

Referenced by THMParsedFunctionWrapper().

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

thermal_hydraulics/include/functions/THMParsedFunctionWrapper.h
thermal_hydraulics/src/functions/THMParsedFunctionWrapper.C

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ THMParsedFunctionWrapper()

Member Function Documentation

◆ evaluate()

◆ getBoolControlData()

◆ getRealControlData()

◆ initialize()

◆ update()

◆ updateControlDataValues()

◆ updateFunctionValues()

Member Data Documentation

◆ _addr

◆ _cd_bool_index

◆ _cd_bool_vals

◆ _cd_real_index

◆ _cd_real_vals

◆ _feproblem

◆ _function_index

◆ _function_ptr

◆ _function_str

◆ _functions

◆ _initial_vals

◆ _scalar_index

◆ _scalar_vals

◆ _sim

◆ _tid

◆ _vals_input

◆ _vars