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 | Private Attributes | List of all members
AddPrimarySpeciesAction Class Reference

#include <AddPrimarySpeciesAction.h>

Inheritance diagram for AddPrimarySpeciesAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AddPrimarySpeciesAction (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)
 
InputParameters & getObjectParams ()
 
const InputParameters & getObjectParams () 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)
 
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 ()
 
static MooseEnum getNonlinearVariableFamilies ()
 
static MooseEnum getNonlinearVariableOrders ()
 
static libMesh::FEType feType (const InputParameters &params)
 
static std::string determineType (const libMesh::FEType &fe_type, unsigned int components, bool is_fv=false)
 
static std::string variableType (const libMesh::FEType &fe_type, const bool is_fv=false, const bool is_array=false)
 

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)
 
virtual void init ()
 
void addVariable (const std::string &var_name)
 
virtual std::string varName () const
 
void createInitialConditionAction (const std::vector< Real > &value)
 
std::set< SubdomainID > getSubdomainIDs ()
 
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

libMesh::FEType _fe_type
 
bool _scalar_var
 
bool _fv_var
 
unsigned int _components
 
std::function< void(FEProblemBase &, const std::string &, const std::string &, InputParameters &)> _problem_add_var_method
 
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
 

Private Attributes

const std::vector< NonlinearVariableName > _vars
 Primary species to add. More...
 
const std::vector< Real > _scaling
 Variable scaling. More...
 

Detailed Description

Definition at line 14 of file AddPrimarySpeciesAction.h.

Constructor & Destructor Documentation

◆ AddPrimarySpeciesAction()

AddPrimarySpeciesAction::AddPrimarySpeciesAction ( const InputParameters &  params)

Definition at line 25 of file AddPrimarySpeciesAction.C.

26  : AddVariableAction(params),
27  _vars(getParam<std::vector<NonlinearVariableName>>("primary_species")),
28  _scaling(isParamValid("scaling") ? getParam<std::vector<Real>>("scaling")
29  : std::vector<Real>(1, 1.0))
30 {
31 }
AddPrimarySpeciesAction::_vars
const std::vector< NonlinearVariableName > _vars
Primary species to add.
Definition: AddPrimarySpeciesAction.h:25
AddVariableAction::isParamValid
bool isParamValid(const std::string &name) const
AddVariableAction::getParam
const T & getParam(const std::string &name) const
AddVariableAction::AddVariableAction
AddVariableAction(const InputParameters &params)
AddPrimarySpeciesAction::_scaling
const std::vector< Real > _scaling
Variable scaling.
Definition: AddPrimarySpeciesAction.h:27

Member Function Documentation

◆ act()

void AddPrimarySpeciesAction::act ( )
overridevirtual

Reimplemented from AddVariableAction.

Definition at line 34 of file AddPrimarySpeciesAction.C.

35 {
36  auto fe_type = AddVariableAction::feType(_pars);
37  auto type = AddVariableAction::variableType(fe_type);
38  auto var_params = _factory.getValidParams(type);
39 
40  var_params.applySpecificParameters(_pars, {"family", "order", "scaling"});
41 
42  for (auto & var : _vars)
43  _problem->addVariable(type, var, var_params);
44 }
InputParameters::applySpecificParameters
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
AddPrimarySpeciesAction::_vars
const std::vector< NonlinearVariableName > _vars
Primary species to add.
Definition: AddPrimarySpeciesAction.h:25
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
AddVariableAction::_factory
Factory & _factory
AddVariableAction::type
const std::string & type() const
AddVariableAction::variableType
static std::string variableType(const libMesh::FEType &fe_type, const bool is_fv=false, const bool is_array=false)
AddVariableAction::feType
static libMesh::FEType feType(const InputParameters &params)
AddVariableAction::_pars
const InputParameters & _pars
AddVariableAction::_problem
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters AddPrimarySpeciesAction::validParams ( )
static

Definition at line 16 of file AddPrimarySpeciesAction.C.

17 {
18  InputParameters params = AddVariableAction::validParams();
19  params.addRequiredParam<std::vector<NonlinearVariableName>>(
20  "primary_species", "The list of primary variables to add");
21  params.addClassDescription("Adds Variables for all primary species");
22  return params;
23 }
AddVariableAction::validParams
static InputParameters validParams()
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _scaling

const std::vector<Real> AddPrimarySpeciesAction::_scaling
private

Variable scaling.

Definition at line 27 of file AddPrimarySpeciesAction.h.

◆ _vars

const std::vector<NonlinearVariableName> AddPrimarySpeciesAction::_vars
private

Primary species to add.

Definition at line 25 of file AddPrimarySpeciesAction.h.

Referenced by act().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:44:33 for https://mooseframework.inl.gov by   doxygen 1.8.14