#include <THMObject.h>

Inheritance diagram for THMObject:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	THMObject (const InputParameters &parameters)

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

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

Protected Member Functions
template<typename T >
void	passParameter (const std::string &name, const std::string &new_name, InputParameters &params) const
	Passes a parameter from this object's input parameters to another set of input parameters. More...

template<typename T >
void	passParameter (const std::string &name, InputParameters &params) const
	Passes a parameter from this object's input parameters to another set of input parameters. More...

Protected Attributes
const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Detailed Description

Definition at line 17 of file THMObject.h.

Constructor & Destructor Documentation

◆ THMObject()

THMObject::THMObject ( const InputParameters & parameters )

Definition at line 19 of file THMObject.C.

19 : MooseObject(parameters) {}

MooseObject::MooseObject

MooseObject(const InputParameters &parameters)

MooseObject::parameters

const InputParameters & parameters() const

Member Function Documentation

◆ passParameter() [1/2]

template<typename T >

void THMObject::passParameter	(	const std::string &	name,
		const std::string &	new_name,
		InputParameters &	params
	)		const

protected

Passes a parameter from this object's input parameters to another set of input parameters.

Template Parameters

T	the type of the parameter to be passed

Parameters

name[in]	name the name of this object's parameter
new_name[in]	new_name the name of the corresponding parameters in `params`
params[in,out]	params the parameters to which the parameter will be passed

Definition at line 54 of file THMObject.h.

 {
   if (isParamValid(name))
     params.set<T>(new_name) = _pars.get<T>(name);
 }

◆ passParameter() [2/2]

template<typename T >

void THMObject::passParameter	(	const std::string &	name,
		InputParameters &	params
	)		const

protected

Passes a parameter from this object's input parameters to another set of input parameters.

This version overloads the other by assuming that the parameter has the same name.

Template Parameters

T	the type of the parameter to be passed

Parameters

name[in]	name the name of the parameter
params[in,out]	params the parameters to which the parameter will be passed

Definition at line 64 of file THMObject.h.

 {
   passParameter<T>(name, name, params);
 }

◆ validParams()

InputParameters THMObject::validParams ( )

static

Definition at line 13 of file THMObject.C.

Referenced by ComponentGroup::validParams(), and Component::validParams().

 {
   InputParameters params = MooseObject::validParams();
   return params;
 }

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

thermal_hydraulics/include/base/THMObject.h
thermal_hydraulics/src/base/THMObject.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions