PolycrystalRandomIC.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 "PolycrystalRandomIC.h"
#include "MooseRandom.h"
 
registerMooseObject("PhaseFieldApp", PolycrystalRandomIC);
 
InputParameters
PolycrystalRandomIC::validParams()
{
  InputParameters params = RandomICBase::validParams();
  params.addClassDescription("Random initial condition for a polycrystalline material");
  params.addRequiredParam<unsigned int>("op_num", "Number of order parameters");
  params.addRequiredParam<unsigned int>("op_index", "The index for the current order parameter");
  params.addRequiredParam<unsigned int>("random_type", "Type of random grain structure");
  return params;
}
 
PolycrystalRandomIC::PolycrystalRandomIC(const InputParameters & parameters)
  : RandomICBase(parameters),
    _op_num(getParam<unsigned int>("op_num")),
    _op_index(getParam<unsigned int>("op_index")),
    _random_type(getParam<unsigned int>("random_type"))
{
}
 
Real
PolycrystalRandomIC::value(const Point &)
{
  Real val = generateRandom();
 
  switch (_random_type)
  {
    case 0: // Continuously random
      return val;
 
    case 1: // Discretely random
    {
      unsigned int rndind = _op_num * val;
 
      if (rndind == _op_index)
        return 1.0;
      else
        return 0.0;
    }
  }
 
  paramError("random_type", "Bad type passed in PolycrystalRandomIC");
}