https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
AddComponentAction Class Reference

#include <AddComponentAction.h>

Inheritance diagram for AddComponentAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AddComponentAction (const InputParameters &params)
 
virtual void act () override
 
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)
 
InputParametersgetObjectParams ()
 
const InputParametersgetObjectParams () 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)
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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
 
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
 
PerfGraphperfGraph ()
 
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 _group
 True if building a component group. More...
 
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

Definition at line 14 of file AddComponentAction.h.

Constructor & Destructor Documentation

◆ AddComponentAction()

AddComponentAction::AddComponentAction ( const InputParameters params)

Definition at line 25 of file AddComponentAction.C.

26  : MooseObjectAction(params), _group(_type == "ComponentGroup")
27 {
28 }
MooseObjectAction(const InputParameters &params)
std::string _type
bool _group
True if building a component group.

Member Function Documentation

◆ act()

void AddComponentAction::act ( )
overridevirtual

Implements MooseObjectAction.

Definition at line 31 of file AddComponentAction.C.

32 {
33  // Error if using an unsupported mesh type, as most components cannot handle working with a
34  // regular MooseMesh instead of a THM mesh
35  if (!dynamic_cast<THMMesh *>(_mesh.get()))
36  mooseError("The Components block cannot be used to add a Component in conjunction with the "
37  "Mesh block at this time");
38 
39  if (!_group)
40  {
41  THMProblem * thm_problem = dynamic_cast<THMProblem *>(_problem.get());
42  if (thm_problem)
43  {
44  _moose_object_pars.set<THMProblem *>("_thm_problem") = thm_problem;
45 
46  std::vector<std::string> parts;
47  MooseUtils::tokenize<std::string>(_moose_object_pars.blockFullpath(), parts);
48 
49  std::stringstream res;
50  std::copy(++parts.begin(), parts.end(), std::ostream_iterator<std::string>(res, "/"));
51 
52  std::string comp_name = res.str();
53  comp_name.pop_back();
54 
55  thm_problem->addComponent(_type, comp_name, _moose_object_pars);
56  }
57  }
58 }
Specialization of FEProblem to run with component subsystem.
Definition: THMProblem.h:18
T & set(const std::string &name, bool quiet_mode=false)
std::shared_ptr< MooseMesh > & _mesh
std::string _type
virtual void addComponent(const std::string &type, const std::string &name, InputParameters params)
Add a component into this simulation.
Definition: Simulation.C:991
InputParameters _moose_object_pars
std::string blockFullpath() const
void mooseError(Args &&... args) const
std::shared_ptr< FEProblemBase > & _problem
bool _group
True if building a component group.

◆ validParams()

InputParameters AddComponentAction::validParams ( )
static

Definition at line 17 of file AddComponentAction.C.

18 {
20  params.makeParamNotRequired<std::string>("type");
21  params.set<std::string>("type") = "ComponentGroup";
22  return params;
23 }
static InputParameters validParams()
T & set(const std::string &name, bool quiet_mode=false)
void makeParamNotRequired(const std::string &name)

Member Data Documentation

◆ _group

bool AddComponentAction::_group
protected

True if building a component group.

Definition at line 23 of file AddComponentAction.h.

Referenced by act().


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