MultiAuxVariablesAction.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "MultiAuxVariablesAction.h"
#include "FEProblem.h"
#include "Conversion.h"
#include "MooseMesh.h"

registerMooseAction("PhaseFieldApp", MultiAuxVariablesAction, "add_aux_variable");

InputParameters
MultiAuxVariablesAction::validParams()
{
  InputParameters params = AddAuxVariableAction::validParams();
  params.addClassDescription("Set up auxvariables for components of "
                             "MaterialProperty<std::vector<data_type> > for polycrystal sample.");
  params.addRequiredParam<unsigned int>(
      "grain_num", "Specifies the number of grains to create the aux variables for.");
  params.addRequiredParam<std::vector<std::string>>(
      "variable_base", "Vector that specifies the base name of the variables.");
  MultiMooseEnum data_type("Real RealGradient", "Real");
  params.addRequiredParam<MultiMooseEnum>(
      "data_type",
      data_type,
      "Specifying data type of the materials property, variables are created accordingly");
  return params;
}

MultiAuxVariablesAction::MultiAuxVariablesAction(const InputParameters & params)
  : 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())
{
}

void
MultiAuxVariablesAction::act()
{
  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);
        }
    }
}