www.mooseframework.org
ConservedLangevinNoise.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ConservedLangevinNoise.h"
11 
13 
14 template <>
15 InputParameters
17 {
18  InputParameters params = validParams<LangevinNoise>();
19  params.addClassDescription("Source term for noise from a ConservedNoise userobject");
20  params.addRequiredParam<UserObjectName>(
21  "noise", "ConservedNoise userobject that produces the random numbers");
22  return params;
23 }
24 ConservedLangevinNoise::ConservedLangevinNoise(const InputParameters & parameters)
25  : LangevinNoise(parameters), _noise(getUserObject<ConservedNoiseInterface>("noise"))
26 {
27  if (parameters.isParamSetByUser("seed"))
28  paramError(
29  "seed",
30  "This parameter has no effect in this kernel. The noise is generated in the user object "
31  "specified in the 'noise' parameter. Specify a seed in that user object instead.");
32 }
33 
34 Real
36 {
37  return -_test[_i][_qp] * _noise.getQpValue(_current_elem->id(), _qp) * _amplitude *
38  _multiplier_prop[_qp];
39 }
ConservedNoiseInterface::getQpValue
virtual Real getQpValue(dof_id_type element_id, unsigned int qp) const =0
LangevinNoise
Definition: LangevinNoise.h:20
LangevinNoise::_multiplier_prop
const MaterialProperty< Real > & _multiplier_prop
Definition: LangevinNoise.h:30
ConservedLangevinNoise::ConservedLangevinNoise
ConservedLangevinNoise(const InputParameters &parameters)
Definition: ConservedLangevinNoise.C:24
ConservedNoiseInterface
This Userobject is the base class of Userobjects that generate one random number per timestep and qua...
Definition: ConservedNoiseInterface.h:26
registerMooseObject
registerMooseObject("PhaseFieldApp", ConservedLangevinNoise)
ConservedLangevinNoise::computeQpResidual
virtual Real computeQpResidual()
Definition: ConservedLangevinNoise.C:35
LangevinNoise::_amplitude
const Real _amplitude
Definition: LangevinNoise.h:29
validParams< LangevinNoise >
InputParameters validParams< LangevinNoise >()
Definition: LangevinNoise.C:17
validParams< ConservedLangevinNoise >
InputParameters validParams< ConservedLangevinNoise >()
Definition: ConservedLangevinNoise.C:16
ConservedLangevinNoise::_noise
const ConservedNoiseInterface & _noise
Definition: ConservedLangevinNoise.h:31
ConservedLangevinNoise.h
ConservedLangevinNoise
Definition: ConservedLangevinNoise.h:21