MultiAuxVariablesAction Class Reference

Automatically generates all auxvariables given vectors telling it the names and how many to create. More...

#include <MultiAuxVariablesAction.h>

Inheritance diagram for MultiAuxVariablesAction:

Public Member Functions
	MultiAuxVariablesAction (InputParameters params)
virtual void	act ()

Protected Attributes
const unsigned int	_grain_num
	number of grains to create More...
const std::vector< std::string > &	_var_name_base
	base name for the auxvariables More...
const unsigned int	_num_var
	number of auxvariables More...
const MultiMooseEnum &	_data_type
	list of material properties to be used More...
const unsigned int	_data_size
	number of properties More...

Detailed Description

Automatically generates all auxvariables given vectors telling it the names and how many to create.

Definition at line 18 of file MultiAuxVariablesAction.h.

Constructor & Destructor Documentation

MultiAuxVariablesAction()

MultiAuxVariablesAction::MultiAuxVariablesAction

(

InputParameters

params

)

Definition at line 36 of file MultiAuxVariablesAction.C.

  : AddAuxVariableAction(params),
    _grain_num(getParam<unsigned int>("grain_num")),
    _var_name_base(getParam<std::vector<std::string>>("variable_base")),
    _num_var(_var_name_base.size()),
    _data_type(getParam<MultiMooseEnum>("data_type")),
    _data_size(_data_type.size())
{
}

Member Function Documentation

act()

void MultiAuxVariablesAction::act ( )

virtual

for exatrcting data from MaterialProperty<std::vector<Real> >

for exatrcting data from MaterialProperty<std::vector<RealGradient> >

The name of the variable is the variable name base followed by the order parameter and a suffix mentioning dimension it applies to.

Definition at line 47 of file MultiAuxVariablesAction.C.

{
  init();
 
  if (_num_var != _data_size)
    mooseError("Data type not provided for all the AuxVariables in MultiAuxVariablesAction");
 
  // mesh dimension & components required for gradient variables
  const unsigned int dim = _mesh->dimension();
  const std::vector<char> suffix = {'x', 'y', 'z'};
 
  // Loop through the number of order parameters
  for (unsigned int val = 0; val < _num_var; ++val)
    for (unsigned int gr = 0; gr < _grain_num; ++gr)
    {
      if (_data_type[val] == "Real")
      {
        // Create variable names with variable name base followed by the order parameter it applies
        // to.
        std::string var_name = _var_name_base[val] + Moose::stringify(gr);
 
        _problem->addAuxVariable(_type, var_name, _moose_object_pars);
      }
      if (_data_type[val] == "RealGradient")
        for (unsigned int x = 0; x < dim; ++x)
        {
          std::string var_name = _var_name_base[val] + Moose::stringify(gr) + "_" + suffix[x];
 
          _problem->addAuxVariable(_type, var_name, _moose_object_pars);
        }
    }
}

Member Data Documentation

_data_size

const unsigned int MultiAuxVariablesAction::_data_size

protected

number of properties

Definition at line 39 of file MultiAuxVariablesAction.h.

Referenced by act().

_data_type

const MultiMooseEnum& MultiAuxVariablesAction::_data_type

protected

list of material properties to be used

Definition at line 36 of file MultiAuxVariablesAction.h.

Referenced by act().

_grain_num

const unsigned int MultiAuxVariablesAction::_grain_num

protected

number of grains to create

Definition at line 27 of file MultiAuxVariablesAction.h.

Referenced by act().

_num_var

const unsigned int MultiAuxVariablesAction::_num_var

protected

number of auxvariables

Definition at line 33 of file MultiAuxVariablesAction.h.

Referenced by act().

_var_name_base

const std::vector<std::string>& MultiAuxVariablesAction::_var_name_base

protected

base name for the auxvariables

Definition at line 30 of file MultiAuxVariablesAction.h.

Referenced by act().

---

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

• phase_field/include/action/MultiAuxVariablesAction.h
• phase_field/src/action/MultiAuxVariablesAction.C