Control object that reads a Real value computed by the control logic system and sets it into a specified MOOSE object parameter(s) More...

#include <SetRealValueControl.h>

Inheritance diagram for SetRealValueControl:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SetRealValueControl (const InputParameters &parameters)

virtual void	execute ()

virtual void	init ()

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	initialSetup ()

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

Protected Attributes
const Real &	_value
	The value that is written into the MOOSE object's input parameter. 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

Detailed Description

Control object that reads a Real value computed by the control logic system and sets it into a specified MOOSE object parameter(s)

Definition at line 18 of file SetRealValueControl.h.

Constructor & Destructor Documentation

◆ SetRealValueControl()

SetRealValueControl::SetRealValueControl ( const InputParameters & parameters )

Definition at line 26 of file SetRealValueControl.C.

   : THMControl(parameters), _value(getControlData<Real>("value"))
 {
 }

Member Function Documentation

◆ 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 SetRealValueControl::execute ( )

virtual

Implements Control.

Definition at line 32 of file SetRealValueControl.C.

 {
   setControllableValue<Real>("parameter", _value);
 }

◆ 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()

virtual void THMControl::init ( )

inlinevirtualinherited

Reimplemented in ParsedFunctionControl, and UnitTripControl.

Definition at line 21 of file THMControl.h.

Referenced by Simulation::controlDataIntegrityCheck().

21 {}

◆ validParams()

InputParameters SetRealValueControl::validParams ( )

static

Definition at line 15 of file SetRealValueControl.C.

 {
   InputParameters params = THMControl::validParams();
   params.addRequiredParam<std::string>("parameter", "The input parameter(s) to control");
   params.addRequiredParam<std::string>(
       "value", "The name of control data to be set into the input parameter.");
   params.addClassDescription("Control object that reads a Real value computed by the control logic "
                              "system and sets it into a specified MOOSE object parameter(s)");
   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().

◆ _sim

THMProblem* THMControl::_sim

protectedinherited

Definition at line 90 of file THMControl.h.

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

◆ _value

const Real& SetRealValueControl::_value

protected

The value that is written into the MOOSE object's input parameter.

Definition at line 27 of file SetRealValueControl.h.

Referenced by execute().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SetRealValueControl()

Member Function Documentation

◆ declareComponentControlData()

◆ declareControlData()

◆ execute()

◆ getComponentControlDataOld()

◆ getControlData()

◆ getControlDataByName()

◆ getControlDataDependencies()

◆ getControlDataOld()

◆ getControlDataOldByName()

◆ init()

◆ validParams()

Member Data Documentation

◆ _control_data_depends_on

◆ _sim

◆ _value