#include <THMSetupOutputAction.h>

Inheritance diagram for THMSetupOutputAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	THMSetupOutputAction (const InputParameters &params)

virtual void	act ()

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

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	_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	_type

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

Definition at line 14 of file THMSetupOutputAction.h.

Constructor & Destructor Documentation

◆ THMSetupOutputAction()

THMSetupOutputAction::THMSetupOutputAction ( const InputParameters & params )

Definition at line 40 of file THMSetupOutputAction.C.

40 : Action(params) {}

Action::Action

Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void THMSetupOutputAction::act ( )

virtual

Implements Action.

Definition at line 43 of file THMSetupOutputAction.C.

 {
   THMProblem * thm_problem = dynamic_cast<THMProblem *>(_problem.get());
   if (thm_problem)
   {
     for (auto && o : _app.getOutputWarehouse().getOutputs<Output>())
     {
       // Get a reference to the Output's InputParameters.  We have to
       // get it from the InputParameter Warehouse since we are going to
       // modify it.  Note that o->name() != "name" stored in the
       // object's InputParameters.  We need the latter to get the
       // InputParameters out of the Warehouse.
       // InputParameters & params =
       //   _app.getInputParameterWarehouse().getInputParameters(o->name(), /*tid=*/0);
       //
       // // If "hide" is available (AdvancedOutput) then add the hide_vars to it
       // if (params.have_parameter<std::vector<VariableName> >("hide"))
       // {
       //   std::vector<VariableName> hvars = params.get<std::vector<VariableName> >("hide");
       //   hvars.insert(hvars.end(), hide_vars.begin(), hide_vars.end());
       //   params.set<std::vector<VariableName> >("hide") = hvars;
       // }
 
       if (dynamic_cast<Console *>(o) != nullptr)
       {
         if (getParam<bool>("disable_scalars_in_console"))
         {
           // Do not output scalar variables on the screen.
           // CAUTION: there is no public API in MOOSE to control what gets outputted by an ouputter,
           // so we get the input parameters after the object was created and flip the flag there. At
           // this point it is still early enough, so that MOOSE won't notice.
           InputParameters & pars = const_cast<InputParameters &>(o->parameters());
           pars.set<ExecFlagEnum>("execute_scalars_on") = EXEC_NONE;
         }
 
         thm_problem->addScreenOutputter(o->name());
       }
       else if (dynamic_cast<XDA *>(o) != nullptr || dynamic_cast<CSV *>(o) != nullptr ||
                dynamic_cast<Tecplot *>(o) != nullptr || dynamic_cast<Exodus *>(o) != nullptr)
       {
         thm_problem->addFileOutputter(o->name());
       }
     }
   }
 }

◆ validParams()

InputParameters THMSetupOutputAction::validParams ( )

static

Definition at line 26 of file THMSetupOutputAction.C.

 {
   InputParameters params = Action::validParams();
 
   params.addParam<bool>("disable_scalars_in_console",
                         true,
                         "Set to true to force 'execute_scalars_on = NONE' in Console, which "
                         "disables printing of all scalar variables.");
 
   params.addClassDescription("Sets up output for THM.");
 
   return params;
 }

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions