PolycrystalRandomICAction.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 "PolycrystalRandomICAction.h"
#include "Factory.h"
#include "FEProblem.h"
#include "Conversion.h"

registerMooseAction("PhaseFieldApp", PolycrystalRandomICAction, "add_ic");

InputParameters
PolycrystalRandomICAction::validParams()
{
  InputParameters params = Action::validParams();
  params.addClassDescription("Sets random polycrystal initial conditions for each order parameter");
  params.addRequiredParam<unsigned int>("op_num", "number of order parameters to create");
  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
  MooseEnum typ_options("continuous discrete");
  params.addRequiredParam<MooseEnum>("random_type",
                                     typ_options,
                                     "The type of random polycrystal initial condition. Whether "
                                     "one order parameter is chosen to be 1 at each node or if "
                                     "each other parameter continuously varies from 0 to 1");
  params.addParam<std::vector<SubdomainName>>(
      "block", {}, "Block restriction for the initial condition");

  return params;
}

PolycrystalRandomICAction::PolycrystalRandomICAction(const InputParameters & params)
  : Action(params),
    _op_num(getParam<unsigned int>("op_num")),
    _var_name_base(getParam<std::string>("var_name_base")),
    _random_type(getParam<MooseEnum>("random_type"))
{
}

void
PolycrystalRandomICAction::act()
{
#ifdef DEBUG
  Moose::err << "Inside the PolycrystalRandomICAction Object" << std::endl;
#endif

  // Loop through the number of order parameters
  for (unsigned int op = 0; op < _op_num; op++)
  {
    // Set parameters for BoundingBoxIC
    InputParameters poly_params = _factory.getValidParams("PolycrystalRandomIC");
    poly_params.set<VariableName>("variable") = _var_name_base + Moose::stringify(op);
    poly_params.set<unsigned int>("op_index") = op;
    poly_params.set<unsigned int>("random_type") = _random_type;
    poly_params.applySpecificParameters(parameters(), {"op_num", "block"});

    // Add initial condition
    _problem->addInitialCondition("PolycrystalRandomIC",
                                  "ICs/PolycrystalICs/PolycrystalRandomIC_" + Moose::stringify(op),
                                  poly_params);
  }
}