Assesses convergence of all Component objects in a simulation. More...

#include <ComponentsConvergence.h>

Inheritance diagram for ComponentsConvergence:

Public Types
enum	MooseConvergenceStatus

typedef MooseEnumItem	IterationType

typedef DataFileName	DataFileParameterType

Public Member Functions
	ComponentsConvergence (const InputParameters &parameters)

virtual void	initialSetup () override

virtual void	preLoop () override

virtual void	preIteration () override

virtual MooseConvergenceStatus	checkConvergence (unsigned int n_iter) override final

virtual void	checkIterationType (IterationType) const

bool	verbose () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

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

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

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

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

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

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

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

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

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

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

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

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

PerfGraph &	perfGraph ()

bool	isImplicit ()

Moose::StateArg	determineState () 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

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 void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
virtual MooseConvergenceStatus	checkConvergenceInner (unsigned int iter) override

void	verboseOutput (std::ostringstream &oss)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) 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

Protected Attributes
const THMProblem *const	_thm_problem
	THM problem.

std::vector< Convergence * >	_convergence_objects
	Convergence objects for all Components that provide one.

const unsigned int	_min_iterations

const unsigned int	_max_iterations

const bool	_converge_at_max_iterations

PerfID	_perfid_check_convergence

THREAD_ID	_tid

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

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 Parallel::Communicator &	_communicator

Private Member Functions
const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const bool	_verbose

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const std::string	_ti_name

Detailed Description

Assesses convergence of all Component objects in a simulation.

Definition at line 19 of file ComponentsConvergence.h.

Constructor & Destructor Documentation

◆ ComponentsConvergence()

ComponentsConvergence::ComponentsConvergence ( const InputParameters & parameters )

Definition at line 26 of file ComponentsConvergence.C.

  : IterationCountConvergence(parameters),
    _thm_problem(
        dynamic_cast<THMProblem *>(getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")))
{
  if (!_thm_problem)
    mooseError("ComponentsConvergence only works with THMProblem.");
}

Member Function Documentation

◆ checkConvergenceInner()

Convergence::MooseConvergenceStatus ComponentsConvergence::checkConvergenceInner ( unsigned int iter )

overrideprotectedvirtual

Reimplemented from IterationCountConvergence.

Definition at line 63 of file ComponentsConvergence.C.

{
  bool all_converged = true;
  for (auto & conv : _convergence_objects)
  {
    const auto status = conv->checkConvergence(iter);
    if (status == Convergence::MooseConvergenceStatus::DIVERGED)
      return Convergence::MooseConvergenceStatus::DIVERGED;
    else if (status == Convergence::MooseConvergenceStatus::ITERATING)
      all_converged = false;
    else
    {
      // checking in case additional status added in future
      mooseAssert(status == Convergence::MooseConvergenceStatus::CONVERGED,
                  "Status not implemented");
    }
  }
 
  if (all_converged)
    return Convergence::MooseConvergenceStatus::CONVERGED;
  else
    return Convergence::MooseConvergenceStatus::ITERATING;
}

◆ initialSetup()

void ComponentsConvergence::initialSetup ( )

overridevirtual

Reimplemented from IterationCountConvergence.

Definition at line 36 of file ComponentsConvergence.C.

{
  IterationCountConvergence::initialSetup();
 
  for (const auto & comp : _thm_problem->getComponents())
  {
    const auto nl_conv = comp->getNonlinearConvergence();
    if (nl_conv)
      _convergence_objects.push_back(nl_conv);
  }
}

◆ preIteration()

void ComponentsConvergence::preIteration ( )

overridevirtual

Reimplemented from IterationCountConvergence.

Definition at line 56 of file ComponentsConvergence.C.

{
  for (auto & conv : _convergence_objects)
    conv->preIteration();
}

◆ preLoop()

void ComponentsConvergence::preLoop ( )

overridevirtual

Reimplemented from IterationCountConvergence.

Definition at line 49 of file ComponentsConvergence.C.

{
  for (auto & conv : _convergence_objects)
    conv->preLoop();
}

◆ validParams()

InputParameters ComponentsConvergence::validParams ( )

static

Definition at line 17 of file ComponentsConvergence.C.

{
  InputParameters params = IterationCountConvergence::validParams();
 
  params.addClassDescription("Assesses convergence of all Component objects in a simulation.");
 
  return params;
}

Member Data Documentation

◆ _convergence_objects

std::vector<Convergence *> ComponentsConvergence::_convergence_objects

protected

Convergence objects for all Components that provide one.

Definition at line 38 of file ComponentsConvergence.h.

Referenced by checkConvergenceInner(), initialSetup(), preIteration(), and preLoop().

◆ _thm_problem

const THMProblem* const ComponentsConvergence::_thm_problem

protected

THM problem.

Definition at line 35 of file ComponentsConvergence.h.

Referenced by ComponentsConvergence(), and initialSetup().

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

thermal_hydraulics/include/convergence/ComponentsConvergence.h
thermal_hydraulics/src/convergence/ComponentsConvergence.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ComponentsConvergence()

Member Function Documentation

◆ checkConvergenceInner()

◆ initialSetup()

◆ preIteration()

◆ preLoop()

◆ validParams()

Member Data Documentation

◆ _convergence_objects

◆ _thm_problem