Action that adds postprocessors for linear and nonlinear iterations. More...

#include <AddIterationCountPostprocessorsAction.h>

Inheritance diagram for AddIterationCountPostprocessorsAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	AddIterationCountPostprocessorsAction (const InputParameters &parameters)

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
bool	_add_pps
	True if iteration count postprocessors should be added. More...

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

Action that adds postprocessors for linear and nonlinear iterations.

Definition at line 17 of file AddIterationCountPostprocessorsAction.h.

Constructor & Destructor Documentation

◆ AddIterationCountPostprocessorsAction()

AddIterationCountPostprocessorsAction::AddIterationCountPostprocessorsAction ( const InputParameters & parameters )

Definition at line 27 of file AddIterationCountPostprocessorsAction.C.

   : Action(parameters), _add_pps(getParam<bool>("count_iterations"))
 {
 }

Member Function Documentation

◆ act()

void AddIterationCountPostprocessorsAction::act ( )

virtual

Implements Action.

Definition at line 34 of file AddIterationCountPostprocessorsAction.C.

 {
   if (_add_pps)
   {
     const std::vector<std::string> it_per_step_class_names = {"NumLinearIterations",
                                                               "NumNonlinearIterations"};
     const std::vector<std::string> it_per_step_names = {"num_linear_iterations_per_step",
                                                         "num_nonlinear_iterations_per_step"};
     const std::vector<std::string> total_it_names = {"num_linear_iterations",
                                                      "num_nonlinear_iterations"};
 
     for (unsigned int i = 0; i < it_per_step_class_names.size(); i++)
     {
       // iterations per time step
       {
         const std::string class_name = "AddPostprocessorAction";
         InputParameters action_params = _action_factory.getValidParams(class_name);
         associateWithParameter("count_iterations", action_params);
         action_params.set<std::string>("type") = it_per_step_class_names[i];
         auto action = std::static_pointer_cast<MooseObjectAction>(
             _action_factory.create(class_name, it_per_step_names[i], action_params));
         _awh.addActionBlock(action);
       }
       // cumulative iterations
       {
         const std::string class_name = "AddPostprocessorAction";
         InputParameters action_params = _action_factory.getValidParams(class_name);
         associateWithParameter("count_iterations", action_params);
         action_params.set<std::string>("type") = "CumulativeValuePostprocessor";
         auto action = std::static_pointer_cast<MooseObjectAction>(
             _action_factory.create(class_name, total_it_names[i], action_params));
         action->getObjectParams().set<PostprocessorName>("postprocessor") = it_per_step_names[i];
         _awh.addActionBlock(action);
       }
     }
   }
 }

◆ validParams()

InputParameters AddIterationCountPostprocessorsAction::validParams ( )

static

Definition at line 18 of file AddIterationCountPostprocessorsAction.C.

 {
   InputParameters params = Action::validParams();
   params.addParam<bool>(
       "count_iterations", false, "Add postprocessors for linear and nonlinear iterations");
   params.addClassDescription("Adds postprocessors for linear and nonlinear iterations");
   return params;
 }

Member Data Documentation

◆ _add_pps

bool AddIterationCountPostprocessorsAction::_add_pps

protected

True if iteration count postprocessors should be added.

Definition at line 26 of file AddIterationCountPostprocessorsAction.h.

Referenced by act().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes