www.mooseframework.org
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
AddSecondarySpeciesAction Class Reference

#include <AddSecondarySpeciesAction.h>

Inheritance diagram for AddSecondarySpeciesAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AddSecondarySpeciesAction (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 & 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
 
PerfGraphperfGraph ()
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &name, const std::string *param=nullptr) 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 MooseEnum getAuxVariableFamilies ()
 
static MooseEnum getAuxVariableOrders ()
 
static MooseEnum getNonlinearVariableFamilies ()
 
static MooseEnum getNonlinearVariableOrders ()
 
static FEType feType (const InputParameters &params)
 
static std::string determineType (const FEType &fe_type, unsigned int components, bool is_fv=false)
 
static std::string variableType (const 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)
 
void init () override
 
void addVariable (const std::string &var_name)
 
void createInitialConditionAction ()
 
std::set< SubdomainIDgetSubdomainIDs ()
 
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

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< AuxVariableName > _secondary_species
 Secondary species to add. More...
 

Detailed Description

Definition at line 14 of file AddSecondarySpeciesAction.h.

Constructor & Destructor Documentation

◆ AddSecondarySpeciesAction()

AddSecondarySpeciesAction::AddSecondarySpeciesAction ( const InputParameters params)

Definition at line 25 of file AddSecondarySpeciesAction.C.

26  : AddAuxVariableAction(params),
27  _secondary_species(getParam<std::vector<AuxVariableName>>("secondary_species"))
28 {
29 }
AddAuxVariableAction(const InputParameters &params)
const T & getParam(const std::string &name) const
const std::vector< AuxVariableName > _secondary_species
Secondary species to add.

Member Function Documentation

◆ act()

void AddSecondarySpeciesAction::act ( )
overridevirtual

Reimplemented from AddAuxVariableAction.

Definition at line 32 of file AddSecondarySpeciesAction.C.

33 {
34  auto fe_type = AddVariableAction::feType(_pars);
35  auto type = AddVariableAction::variableType(fe_type);
36  auto var_params = _factory.getValidParams(type);
37 
38  var_params.applySpecificParameters(_pars, {"family", "order"});
39 
40  for (auto & secondary_specimen : _secondary_species)
41  _problem->addAuxVariable(type, secondary_specimen, var_params);
42 }
static std::string variableType(const FEType &fe_type, const bool is_fv=false, const bool is_array=false)
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
InputParameters getValidParams(const std::string &name) const
const std::string & type() const
static FEType feType(const InputParameters &params)
const InputParameters & _pars
std::shared_ptr< FEProblemBase > & _problem
const std::vector< AuxVariableName > _secondary_species
Secondary species to add.

◆ validParams()

InputParameters AddSecondarySpeciesAction::validParams ( )
static

Definition at line 16 of file AddSecondarySpeciesAction.C.

17 {
19  params.addParam<std::vector<AuxVariableName>>("secondary_species",
20  "The list of secondary species to add");
21  params.addClassDescription("Adds AuxVariables for all secondary species");
22  return params;
23 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()

Member Data Documentation

◆ _secondary_species

const std::vector<AuxVariableName> AddSecondarySpeciesAction::_secondary_species
private

Secondary species to add.

Definition at line 25 of file AddSecondarySpeciesAction.h.

Referenced by act().


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