ConservedLangevinNoise.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 "ConservedLangevinNoise.h"

registerMooseObject("PhaseFieldApp", ConservedLangevinNoise);

InputParameters
ConservedLangevinNoise::validParams()
{
  InputParameters params = LangevinNoise::validParams();
  params.addClassDescription("Source term for noise from a ConservedNoise userobject");
  params.addRequiredParam<UserObjectName>(
      "noise", "ConservedNoise userobject that produces the random numbers");
  return params;
}
ConservedLangevinNoise::ConservedLangevinNoise(const InputParameters & parameters)
  : LangevinNoise(parameters), _noise(getUserObject<ConservedNoiseInterface>("noise"))
{
  if (parameters.isParamSetByUser("seed"))
    paramError(
        "seed",
        "This parameter has no effect in this kernel. The noise is generated in the user object "
        "specified in the 'noise' parameter. Specify a seed in that user object instead.");
}

Real
ConservedLangevinNoise::computeQpResidual()
{
  return -_test[_i][_qp] * _noise.getQpValue(_current_elem->id(), _qp) * _amplitude *
         _multiplier_prop[_qp];
}