Wraps libMesh::ParsedFunction for use in ChainControls. More...

#include <ChainControlParsedFunctionWrapper.h>

Public Member Functions
	ChainControlParsedFunctionWrapper (MooseApp &moose_app, FEProblemBase &fe_problem, const std::string &function_str, const std::vector< std::string > &symbol_names, const std::vector< std::string > &symbol_values, const THREAD_ID tid=0)
	Constructor. More...

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

std::vector< ChainControlData< Real > * >	getRealChainControlData ()
	Get list of Real-valued control data objects. More...

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

Private Member Functions
void	initializeFunctionInputs ()
	Gets initial value, address, and input index for each function input. More...

void	updateScalarVariableValues ()
	Updates scalar values in wrapped function. More...

void	updateFunctionValues (Real t, const Point &pt)
	Updates function values in wrapped function. More...

void	updateChainControlDataValues ()
	Updates control data values in wrapped function. More...

Private Attributes
MooseApp &	_moose_app
	App. More...

FEProblemBase &	_fe_problem
	Problem. More...

const std::string &	_function_str
	Function expression. More...

const std::vector< std::string > &	_symbol_names
	Symbols used in the function expression string. More...

const std::vector< std::string > &	_symbol_values
	Values pairing with `symbol_names`. More...

std::vector< Real >	_initial_values
	Initial value for each function input. More...

std::unique_ptr< ParsedFunction< Real > >	_function_ptr
	Wrapped libMesh::ParsedFunction. More...

std::vector< unsigned int >	_real_control_data_indices
	_input_values index for each Real control data value More...

std::vector< ChainControlData< Real > * >	_real_control_data_values
	Real control data values. More...

std::vector< unsigned int >	_bool_control_data_indices
	_input_values index for each bool control data value More...

std::vector< ChainControlData< bool > * >	_bool_control_data_values
	bool control data values More...

std::vector< unsigned int >	_scalar_indices
	_input_values index for each scalar variable value More...

std::vector< const VariableValue * >	_scalar_values
	Scalar variable values. More...

std::vector< unsigned int >	_function_indices
	_input_values index for each function value More...

std::vector< const Function * >	_function_values
	Function values. More...

std::vector< Real * >	_input_values
	libMesh::ParsedFunction input values More...

const THREAD_ID	_tid
	Thread id passed from owning object. More...

ChainControlDataSystem &	_chain_control_data_system
	Chain control data system. More...

Detailed Description

Wraps libMesh::ParsedFunction for use in ChainControls.

Definition at line 27 of file ChainControlParsedFunctionWrapper.h.

Constructor & Destructor Documentation

◆ ChainControlParsedFunctionWrapper()

ChainControlParsedFunctionWrapper::ChainControlParsedFunctionWrapper	(	MooseApp &	moose_app,
		FEProblemBase &	fe_problem,
		const std::string &	function_str,
		const std::vector< std::string > &	symbol_names,
		const std::vector< std::string > &	symbol_values,
		const THREAD_ID	tid = `0`
	)

Constructor.

Parameters

moose_app	App
fe_problem	Problem
function_str	Function expression
symbol_names	Symbols used in the function expression string
symbol_values	Values pairing with `symbol_names`

Definition at line 18 of file ChainControlParsedFunctionWrapper.C.

   : _moose_app(moose_app),
     _fe_problem(fe_problem),
     _function_str(function_str),
     _symbol_names(symbol_names),
     _symbol_values(symbol_values),
     _tid(tid),
     _chain_control_data_system(_moose_app.getChainControlDataSystem())
 {
   initializeFunctionInputs();
 
   _function_ptr = std::make_unique<ParsedFunction<Real, RealGradient>>(
       _function_str, &_symbol_names, &_initial_values);
 
   for (const auto & symbol_name : _symbol_names)
     _input_values.push_back(&_function_ptr->getVarAddress(symbol_name));
 }

Member Function Documentation

◆ evaluate()

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

Evaluates the libMesh::ParsedFunction.

Parameters

t	Time
p	Spatial point

Definition at line 43 of file ChainControlParsedFunctionWrapper.C.

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

◆ getBoolChainControlData()

std::vector<ChainControlData<bool> *> ChainControlParsedFunctionWrapper::getBoolChainControlData ( )

inline

Get list of boolean-valued control data objects.

Definition at line 65 of file ChainControlParsedFunctionWrapper.h.

   {
     return _bool_control_data_values;
   }

◆ getRealChainControlData()

std::vector<ChainControlData<Real> *> ChainControlParsedFunctionWrapper::getRealChainControlData ( )

inline

Get list of Real-valued control data objects.

Definition at line 57 of file ChainControlParsedFunctionWrapper.h.

   {
     return _real_control_data_values;
   }

◆ initializeFunctionInputs()

void ChainControlParsedFunctionWrapper::initializeFunctionInputs ( )

private

Gets initial value, address, and input index for each function input.

Definition at line 52 of file ChainControlParsedFunctionWrapper.C.

Referenced by ChainControlParsedFunctionWrapper().

 {
   for (const auto i : index_range(_symbol_values))
   {
     if (_chain_control_data_system.hasChainControlDataOfType<Real>(_symbol_values[i]))
     {
       auto & data = _chain_control_data_system.getChainControlData<Real>(_symbol_values[i]);
       _initial_values.push_back(data.get());
       _real_control_data_values.push_back(&data);
       _real_control_data_indices.push_back(i);
     }
     else if (_chain_control_data_system.hasChainControlDataOfType<bool>(_symbol_values[i]))
     {
       auto & data = _chain_control_data_system.getChainControlData<bool>(_symbol_values[i]);
       _initial_values.push_back(data.get());
       _bool_control_data_values.push_back(&data);
       _bool_control_data_indices.push_back(i);
     }
     else if (_fe_problem.hasScalarVariable(_symbol_values[i]))
     {
       const VariableValue & scalar_val =
           _fe_problem.getScalarVariable(_tid, _symbol_values[i]).sln();
       _initial_values.push_back(0);
       _scalar_values.push_back(&scalar_val);
       _scalar_indices.push_back(i);
     }
     else if (_fe_problem.hasFunction(_symbol_values[i]))
     {
       const Function & function = _fe_problem.getFunction(_symbol_values[i], _tid);
       _initial_values.push_back(0);
       _function_values.push_back(&function);
       _function_indices.push_back(i);
     }
     else if (MooseUtils::isFloat(_symbol_values[i]))
     {
       _initial_values.push_back(MooseUtils::convert<Real>(_symbol_values[i], true));
     }
     else
       mooseError("Invalid 'symbol_values' entry '",
                  _symbol_values[i],
                  "'. Valid entries:\n"
                  "  - chain control data values (bool or Real)\n"
                  "  - function names\n"
                  "  - scalar variable names\n"
                  "  - constant values");
   }
 }

◆ updateChainControlDataValues()

void ChainControlParsedFunctionWrapper::updateChainControlDataValues ( )

private

Updates control data values in wrapped function.

Definition at line 115 of file ChainControlParsedFunctionWrapper.C.

Referenced by evaluate().

 {
   for (const auto i : index_range(_real_control_data_indices))
     (*_input_values[_real_control_data_indices[i]]) = _real_control_data_values[i]->get();
 
   for (const auto i : index_range(_bool_control_data_indices))
     (*_input_values[_bool_control_data_indices[i]]) =
         static_cast<Real>(_bool_control_data_values[i]->get());
 }

◆ updateFunctionValues()

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

private

Updates function values in wrapped function.

Parameters

t	Time
p	Spatial point

Definition at line 108 of file ChainControlParsedFunctionWrapper.C.

Referenced by evaluate().

 {
   for (const auto i : index_range(_function_indices))
     (*_input_values[_function_indices[i]]) = _function_values[i]->value(t, pt);
 }

◆ updateScalarVariableValues()

void ChainControlParsedFunctionWrapper::updateScalarVariableValues ( )

private

Updates scalar values in wrapped function.

Definition at line 101 of file ChainControlParsedFunctionWrapper.C.

Referenced by evaluate().

 {
   for (const auto i : index_range(_scalar_indices))
     (*_input_values[_scalar_indices[i]]) = (*_scalar_values[i])[0];
 }

Member Data Documentation

◆ _bool_control_data_indices

std::vector<unsigned int> ChainControlParsedFunctionWrapper::_bool_control_data_indices

private

_input_values index for each bool control data value

Definition at line 95 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs(), and updateChainControlDataValues().

◆ _bool_control_data_values

std::vector<ChainControlData<bool> *> ChainControlParsedFunctionWrapper::_bool_control_data_values

private

bool control data values

Definition at line 97 of file ChainControlParsedFunctionWrapper.h.

Referenced by getBoolChainControlData(), initializeFunctionInputs(), and updateChainControlDataValues().

◆ _chain_control_data_system

ChainControlDataSystem& ChainControlParsedFunctionWrapper::_chain_control_data_system

private

Chain control data system.

Definition at line 116 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs().

◆ _fe_problem

FEProblemBase& ChainControlParsedFunctionWrapper::_fe_problem

private

Problem.

Definition at line 74 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs().

◆ _function_indices

std::vector<unsigned int> ChainControlParsedFunctionWrapper::_function_indices

private

_input_values index for each function value

Definition at line 105 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs(), and updateFunctionValues().

◆ _function_ptr

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

private

Wrapped libMesh::ParsedFunction.

Definition at line 87 of file ChainControlParsedFunctionWrapper.h.

Referenced by ChainControlParsedFunctionWrapper(), and evaluate().

◆ _function_str

const std::string& ChainControlParsedFunctionWrapper::_function_str

private

Function expression.

Definition at line 77 of file ChainControlParsedFunctionWrapper.h.

Referenced by ChainControlParsedFunctionWrapper().

◆ _function_values

std::vector<const Function *> ChainControlParsedFunctionWrapper::_function_values

private

Function values.

Definition at line 107 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs(), and updateFunctionValues().

◆ _initial_values

std::vector<Real> ChainControlParsedFunctionWrapper::_initial_values

private

Initial value for each function input.

Definition at line 84 of file ChainControlParsedFunctionWrapper.h.

Referenced by ChainControlParsedFunctionWrapper(), and initializeFunctionInputs().

◆ _input_values

std::vector<Real *> ChainControlParsedFunctionWrapper::_input_values

private

libMesh::ParsedFunction input values

Definition at line 110 of file ChainControlParsedFunctionWrapper.h.

Referenced by ChainControlParsedFunctionWrapper(), updateChainControlDataValues(), updateFunctionValues(), and updateScalarVariableValues().

◆ _moose_app

MooseApp& ChainControlParsedFunctionWrapper::_moose_app

private

App.

Definition at line 72 of file ChainControlParsedFunctionWrapper.h.

◆ _real_control_data_indices

std::vector<unsigned int> ChainControlParsedFunctionWrapper::_real_control_data_indices

private

_input_values index for each Real control data value

Definition at line 90 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs(), and updateChainControlDataValues().

◆ _real_control_data_values

std::vector<ChainControlData<Real> *> ChainControlParsedFunctionWrapper::_real_control_data_values

private

Real control data values.

Definition at line 92 of file ChainControlParsedFunctionWrapper.h.

Referenced by getRealChainControlData(), initializeFunctionInputs(), and updateChainControlDataValues().

◆ _scalar_indices

std::vector<unsigned int> ChainControlParsedFunctionWrapper::_scalar_indices

private

_input_values index for each scalar variable value

Definition at line 100 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs(), and updateScalarVariableValues().

◆ _scalar_values

std::vector<const VariableValue *> ChainControlParsedFunctionWrapper::_scalar_values

private

Scalar variable values.

Definition at line 102 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs(), and updateScalarVariableValues().

◆ _symbol_names

const std::vector<std::string>& ChainControlParsedFunctionWrapper::_symbol_names

private

Symbols used in the function expression string.

Definition at line 79 of file ChainControlParsedFunctionWrapper.h.

Referenced by ChainControlParsedFunctionWrapper().

◆ _symbol_values

const std::vector<std::string>& ChainControlParsedFunctionWrapper::_symbol_values

private

Values pairing with symbol_names.

Definition at line 81 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs().

◆ _tid

const THREAD_ID ChainControlParsedFunctionWrapper::_tid

private

Thread id passed from owning object.

Definition at line 113 of file ChainControlParsedFunctionWrapper.h.

Referenced by initializeFunctionInputs().

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

include/functions/ChainControlParsedFunctionWrapper.h
src/functions/ChainControlParsedFunctionWrapper.C

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ChainControlParsedFunctionWrapper()

Member Function Documentation

◆ evaluate()

◆ getBoolChainControlData()

◆ getRealChainControlData()

◆ initializeFunctionInputs()

◆ updateChainControlDataValues()

◆ updateFunctionValues()

◆ updateScalarVariableValues()

Member Data Documentation

◆ _bool_control_data_indices

◆ _bool_control_data_values

◆ _chain_control_data_system

◆ _fe_problem

◆ _function_indices

◆ _function_ptr

◆ _function_str

◆ _function_values

◆ _initial_values

◆ _input_values

◆ _moose_app

◆ _real_control_data_indices

◆ _real_control_data_values

◆ _scalar_indices

◆ _scalar_values

◆ _symbol_names

◆ _symbol_values

◆ _tid