https://mooseframework.inl.gov
Loading...
Searching...
No Matches
ConservedLangevinNoise.C
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
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
11
13
16{
18 params.addClassDescription("Source term for noise from a ConservedNoise userobject");
19 params.addRequiredParam<UserObjectName>(
20 "noise", "ConservedNoise userobject that produces the random numbers");
21 return params;
22}
24 : LangevinNoise(parameters), _noise(getUserObject<ConservedNoiseInterface>("noise"))
25{
26 if (parameters.isParamSetByUser("seed"))
28 "seed",
29 "This parameter has no effect in this kernel. The noise is generated in the user object "
30 "specified in the 'noise' parameter. Specify a seed in that user object instead.");
31}
32
33Real
registerMooseObject("PhaseFieldApp", ConservedLangevinNoise)
static InputParameters validParams()
const ConservedNoiseInterface & _noise
ConservedLangevinNoise(const InputParameters &parameters)
This Userobject is the base class of Userobjects that generate one random number per timestep and qua...
virtual Real getQpValue(dof_id_type element_id, unsigned int qp) const =0
bool isParamSetByUser(const std::string &name) const
void addRequiredParam(const std::string &name, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)
unsigned int _qp
const Elem *const & _current_elem
unsigned int _i
const VariableTestValue & _test
const Real _amplitude
static InputParameters validParams()
const MaterialProperty< Real > & _multiplier_prop
const InputParameters & parameters() const
void paramError(const std::string &param, Args... args) const