This control block takes a parsed function and evaluates it. More...

#include <ParsedFunctionControl.h>

Inheritance diagram for ParsedFunctionControl:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ParsedFunctionControl (const InputParameters &parameters)

virtual void	initialSetup () override

virtual void	init () override

virtual void	execute () override

const std::vector< std::string > &	getControlDataDependencies () const
	Return the Controls that must run before this Control. More...

std::vector< std::string > &	getDependencies ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

PerfGraph &	perfGraph ()

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static MultiMooseEnum	getExecuteOptions ()

Public Attributes
const ConsoleStream	_console

Protected Member Functions
void	buildFunction ()
	Build the function that will be evaluated by this control. More...

template<typename T >
T &	declareComponentControlData (const std::string &data_name)
	Declare control data with name 'component:data_name'. More...

template<typename T >
T &	declareControlData (const std::string &data_name)
	Declare control data with name 'data_name'. More...

template<typename T >
const T &	getControlData (const std::string &param_name)
	Get a reference to control data that are specified in the input parameter 'param_name'. More...

template<typename T >
const T &	getControlDataOld (const std::string &param_name)
	Get a reference to control data value from a previous time step that is specified in the input parameter 'param_name'. More...

template<typename T >
const T &	getControlDataByName (const std::string &data_name)
	Get a reference to control data that are specified by 'data_name' name. More...

template<typename T >
const T &	getControlDataOldByName (const std::string &data_name)
	Get a reference to control data value from previous time step that is specified by 'data_name' name. More...

template<typename T >
const T &	getComponentControlDataOld (const std::string &data_name)
	Get a reference to a component control data value from previous time step. More...

bool	hasControllableParameterByName (const std::string &name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

virtual void	addUserObjectDependencyHelper (const UserObject &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

ControllableParameter	getControllableParameter (const std::string &param_name)

ControllableParameter	getControllableParameter (const std::string &param_name)

ControllableParameter	getControllableParameterByName (const std::string &param_name)

ControllableParameter	getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectParameterName &param_name)

ControllableParameter	getControllableParameterByName (const std::string &param_name)

ControllableParameter	getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)

ControllableParameter	getControllableParameterByName (const MooseObjectParameterName &param_name)

T	getControllableValue (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValue (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)

T	getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)

void	setControllableValue (const std::string &name, const T &value)

void	setControllableValue (const std::string &name, const T &value)

void	setControllableValueByName (const std::string &name, const T &value)

void	setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectParameterName &name, const T &value)

void	setControllableValueByName (const std::string &name, const T &value)

void	setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)

void	setControllableValueByName (const MooseObjectParameterName &name, const T &value)

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

Protected Attributes
std::string	_function
	The user-defined function to be evaluated. More...

Real &	_value
	The function value. More...

std::unique_ptr< THMParsedFunctionWrapper >	_function_ptr
	Pointer to the Parsed function wrapper object. More...

THMProblem *	_sim

std::vector< std::string >	_control_data_depends_on
	A list of control data that are required to run before this control may run. More...

FEProblemBase &	_fe_problem

std::vector< std::string >	_depends_on

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

const Parallel::Communicator &	_communicator

FEProblemBase &	_pfb_feproblem

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

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

Detailed Description

This control block takes a parsed function and evaluates it.

Definition at line 20 of file ParsedFunctionControl.h.

Constructor & Destructor Documentation

◆ ParsedFunctionControl()

ParsedFunctionControl::ParsedFunctionControl ( const InputParameters & parameters )

Definition at line 26 of file ParsedFunctionControl.C.

   : THMControl(parameters),
     MooseParsedFunctionBase(parameters),
     _function(verifyFunction(getParam<std::string>("function"))),
     _value(declareComponentControlData<Real>("value"))
 {
 }

Member Function Documentation

◆ buildFunction()

void ParsedFunctionControl::buildFunction ( )

protected

Build the function that will be evaluated by this control.

Definition at line 35 of file ParsedFunctionControl.C.

Referenced by init(), and initialSetup().

 {
   if (!_function_ptr)
   {
     THREAD_ID tid = 0;
     if (isParamValid("_tid"))
       tid = getParam<THREAD_ID>("_tid");
 
     _function_ptr = std::make_unique<THMParsedFunctionWrapper>(
         *_sim, _pfb_feproblem, _function, _vars, _vals, tid);
   }
 }

◆ declareComponentControlData()

template<typename T >

T & THMControl::declareComponentControlData ( const std::string & data_name )

protectedinherited

Declare control data with name 'component:data_name'.

Parameters

data_name A unique name for the control data

Definition at line 101 of file THMControl.h.

 {
   std::string full_name = name() + ":" + data_name;
   ControlData<T> * data_ptr = _sim->declareControlData<T>(full_name, this);
   return data_ptr->set();
 }

◆ declareControlData()

template<typename T >

T & THMControl::declareControlData ( const std::string & data_name )

protectedinherited

Declare control data with name 'data_name'.

Parameters

data_name A unique name for the control data

Definition at line 110 of file THMControl.h.

 {
   ControlData<T> * data_ptr = _sim->declareControlData<T>(data_name, this);
   return data_ptr->set();
 }

◆ execute()

void ParsedFunctionControl::execute ( )

overridevirtual

Implements Control.

Definition at line 67 of file ParsedFunctionControl.C.

 {
   _value = _function_ptr->evaluate(_t, Point(0., 0., 0.));
 }

◆ getComponentControlDataOld()

template<typename T >

const T & THMControl::getComponentControlDataOld ( const std::string & data_name )

protectedinherited

Get a reference to a component control data value from previous time step.

Parameters

data_name The name of the control data

Definition at line 165 of file THMControl.h.

 {
   std::string full_name = name() + ":" + data_name;
   return getControlDataOldByName<T>(full_name);
 }

◆ getControlData()

template<typename T >

const T & THMControl::getControlData ( const std::string & param_name )

protectedinherited

Get a reference to control data that are specified in the input parameter 'param_name'.

Parameters

param_name The parameter name that contains the name of the control data

Definition at line 118 of file THMControl.h.

 {
   std::string data_name = getParam<std::string>(param_name);
   return getControlDataByName<T>(data_name);
 }

◆ getControlDataByName()

template<typename T >

const T & THMControl::getControlDataByName ( const std::string & data_name )

protectedinherited

Get a reference to control data that are specified by 'data_name' name.

Parameters

data_name The name of the control data

Definition at line 134 of file THMControl.h.

 {
   ControlData<T> * data_ptr = _sim->getControlData<T>(data_name);
   if (data_ptr == nullptr)
     mooseError("Trying to get control data '",
                data_name,
                "', but it does not exist in the system. Check your spelling.");
 
   // set up dependencies for this control object
   auto it = std::find(_control_data_depends_on.begin(), _control_data_depends_on.end(), data_name);
   if (it == _control_data_depends_on.end())
     _control_data_depends_on.push_back(data_name);
 
   return data_ptr->get();
 }

◆ getControlDataDependencies()

const std::vector<std::string>& THMControl::getControlDataDependencies ( ) const

inlineinherited

Return the Controls that must run before this Control.

Definition at line 26 of file THMControl.h.

Referenced by Simulation::controlDataIntegrityCheck().

   {
     return _control_data_depends_on;
   }

◆ getControlDataOld()

template<typename T >

const T & THMControl::getControlDataOld ( const std::string & param_name )

protectedinherited

Get a reference to control data value from a previous time step that is specified in the input parameter 'param_name'.

Parameters

param_name The parameter name that contains the name of the control data

Definition at line 126 of file THMControl.h.

 {
   std::string data_name = getParam<std::string>(param_name);
   return getControlDataOldByName<T>(data_name);
 }

◆ getControlDataOldByName()

template<typename T >

const T & THMControl::getControlDataOldByName ( const std::string & data_name )

protectedinherited

Get a reference to control data value from previous time step that is specified by 'data_name' name.

Parameters

data_name The name of the control data

Definition at line 152 of file THMControl.h.

 {
   ControlData<T> * data_ptr = _sim->getControlData<T>(data_name);
   if (data_ptr == nullptr)
     mooseError("Trying to get control data '",
                data_name,
                "', but it does not exist in the system. Check your spelling.");
 
   return data_ptr->getOld();
 }

◆ init()

void ParsedFunctionControl::init ( )

overridevirtual

Reimplemented from THMControl.

Definition at line 55 of file ParsedFunctionControl.C.

 {
   buildFunction();
 
   // establish dependency so that the control data graph is properly evaluated
   for (auto & ctrl_name : _function_ptr->getRealControlData())
     getControlDataByName<Real>(ctrl_name->name());
   for (auto & ctrl_name : _function_ptr->getBoolControlData())
     getControlDataByName<bool>(ctrl_name->name());
 }

◆ initialSetup()

void ParsedFunctionControl::initialSetup ( )

overridevirtual

Reimplemented from Control.

Definition at line 49 of file ParsedFunctionControl.C.

 {
   buildFunction();
 }

◆ validParams()

InputParameters ParsedFunctionControl::validParams ( )

static

Definition at line 16 of file ParsedFunctionControl.C.

 {
   InputParameters params = THMControl::validParams();
   params += MooseParsedFunctionBase::validParams();
   params.addRequiredCustomTypeParam<std::string>(
       "function", "FunctionExpression", "The function to be evaluated by this control.");
   params.addClassDescription("Control that evaluates a parsed function");
   return params;
 }

Member Data Documentation

◆ _control_data_depends_on

std::vector<std::string> THMControl::_control_data_depends_on

protectedinherited

A list of control data that are required to run before this control may run.

Definition at line 93 of file THMControl.h.

Referenced by THMControl::getControlDataByName(), and THMControl::getControlDataDependencies().

◆ _function

std::string ParsedFunctionControl::_function

protected

The user-defined function to be evaluated.

Definition at line 36 of file ParsedFunctionControl.h.

Referenced by buildFunction().

◆ _function_ptr

std::unique_ptr<THMParsedFunctionWrapper> ParsedFunctionControl::_function_ptr

protected

Pointer to the Parsed function wrapper object.

Definition at line 40 of file ParsedFunctionControl.h.

Referenced by buildFunction(), execute(), and init().

◆ _sim

THMProblem* THMControl::_sim

protectedinherited

Definition at line 90 of file THMControl.h.

Referenced by UnitTripControl::buildConditionFunction(), buildFunction(), THMControl::declareComponentControlData(), THMControl::declareControlData(), THMControl::getControlDataByName(), and THMControl::getControlDataOldByName().

◆ _value

Real& ParsedFunctionControl::_value

protected

The function value.

Definition at line 38 of file ParsedFunctionControl.h.

Referenced by execute().

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

thermal_hydraulics/include/controllogic/ParsedFunctionControl.h
thermal_hydraulics/src/controllogic/ParsedFunctionControl.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParsedFunctionControl()

Member Function Documentation

◆ buildFunction()

◆ declareComponentControlData()

◆ declareControlData()

◆ execute()

◆ getComponentControlDataOld()

◆ getControlData()

◆ getControlDataByName()

◆ getControlDataDependencies()

◆ getControlDataOld()

◆ getControlDataOldByName()

◆ init()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _control_data_depends_on

◆ _function

◆ _function_ptr

◆ _sim

◆ _value