This action creates a control value named the same as the postprocessor being added. More...

#include <PostprocessorAsControlAction.h>

Inheritance diagram for PostprocessorAsControlAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PostprocessorAsControlAction (const InputParameters &params)

virtual void	act ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type) override

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

InputParameters &	getObjectParams ()

const InputParameters &	getObjectParams () const

const std::string &	getMooseObjectType () const

void	timedAct ()

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

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

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

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

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_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

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_type

InputParameters	_moose_object_pars

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

This action creates a control value named the same as the postprocessor being added.

This allows people to use the postprocessor values directly within the control system.

Definition at line 19 of file PostprocessorAsControlAction.h.

Constructor & Destructor Documentation

◆ PostprocessorAsControlAction()

PostprocessorAsControlAction::PostprocessorAsControlAction ( const InputParameters & params )

Definition at line 26 of file PostprocessorAsControlAction.C.

   : MooseObjectAction(params)
 {
 }

Member Function Documentation

◆ act()

void PostprocessorAsControlAction::act ( )

virtual

Implements MooseObjectAction.

Definition at line 32 of file PostprocessorAsControlAction.C.

 {
   THMProblem * thm_problem = dynamic_cast<THMProblem *>(_problem.get());
   if (thm_problem)
   {
     const std::string class_name = "THMAddControlAction";
     InputParameters params = _action_factory.getValidParams(class_name);
     params.set<std::string>("type") = "CopyPostprocessorValueControl";
 
     std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
         _action_factory.create(class_name, _name + "_copy_ctrl", params));
 
     action->getObjectParams().set<PostprocessorName>("postprocessor") = _name;
 
     _awh.addActionBlock(action);
   }
 }

◆ validParams()

InputParameters PostprocessorAsControlAction::validParams ( )

static

Definition at line 17 of file PostprocessorAsControlAction.C.

 {
   InputParameters params = MooseObjectAction::validParams();
   params.addClassDescription(
       "This action adds a control object that copies a postprocessor value into the control "
       "system so that users can work with the postprocessor name directly.");
   return params;
 }

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

thermal_hydraulics/include/actions/PostprocessorAsControlAction.h
thermal_hydraulics/src/actions/PostprocessorAsControlAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions