AddPrimarySpeciesAction Class Reference

#include <AddPrimarySpeciesAction.h>

Inheritance diagram for AddPrimarySpeciesAction:

Public Member Functions
	AddPrimarySpeciesAction (const InputParameters &params)
virtual void	act () override

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 19 of file AddPrimarySpeciesAction.h.

Constructor & Destructor Documentation

AddPrimarySpeciesAction()

AddPrimarySpeciesAction::AddPrimarySpeciesAction

(

const InputParameters &

params

)

Definition at line 26 of file AddPrimarySpeciesAction.C.

  : AddVariableAction(params),
    _vars(getParam<std::vector<NonlinearVariableName>>("primary_species")),
    _scaling(isParamValid("scaling") ? getParam<std::vector<Real>>("scaling")
                                     : std::vector<Real>(1, 1.0))
{
}

Member Function Documentation

act()

void AddPrimarySpeciesAction::act ( )

overridevirtual

Definition at line 35 of file AddPrimarySpeciesAction.C.

{
  auto fe_type = AddVariableAction::feType(_pars);
  auto type = AddVariableAction::determineType(fe_type, 1);
  auto var_params = _factory.getValidParams(type);
 
  var_params.applySpecificParameters(_pars, {"family", "order", "scaling"});
 
  for (auto & var : _vars)
    _problem->addVariable(type, var, var_params);
}

Member Data Documentation

_scaling

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

private

Variable scaling.

Definition at line 30 of file AddPrimarySpeciesAction.h.

_vars

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

private

Primary species to add.

Definition at line 28 of file AddPrimarySpeciesAction.h.

Referenced by act().

---

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

• chemical_reactions/include/actions/AddPrimarySpeciesAction.h
• chemical_reactions/src/actions/AddPrimarySpeciesAction.C