ConservedLangevinNoise Class Reference

#include <ConservedLangevinNoise.h>

Inheritance diagram for ConservedLangevinNoise:

Public Member Functions
	ConservedLangevinNoise (const InputParameters &parameters)

Protected Member Functions
virtual void	residualSetup ()
virtual Real	computeQpResidual ()

Protected Attributes
const Real	_amplitude
const MaterialProperty< Real > &	_multiplier_prop

Private Attributes
const ConservedNoiseInterface &	_noise

Detailed Description

Definition at line 21 of file ConservedLangevinNoise.h.

Constructor & Destructor Documentation

ConservedLangevinNoise()

ConservedLangevinNoise::ConservedLangevinNoise

(

const InputParameters &

parameters

)

Definition at line 24 of file ConservedLangevinNoise.C.

  : 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.");
}

Member Function Documentation

computeQpResidual()

Real ConservedLangevinNoise::computeQpResidual ( )

protectedvirtual

Reimplemented from LangevinNoise.

Definition at line 35 of file ConservedLangevinNoise.C.

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

residualSetup()

virtual void ConservedLangevinNoise::residualSetup ( )

inlineprotectedvirtual

Reimplemented from LangevinNoise.

Definition at line 27 of file ConservedLangevinNoise.h.

{};

Member Data Documentation

_amplitude

const Real LangevinNoise::_amplitude

protectedinherited

Definition at line 29 of file LangevinNoise.h.

Referenced by LangevinNoise::computeQpResidual(), and computeQpResidual().

_multiplier_prop

const MaterialProperty<Real>& LangevinNoise::_multiplier_prop

protectedinherited

Definition at line 30 of file LangevinNoise.h.

Referenced by LangevinNoise::computeQpResidual(), and computeQpResidual().

_noise

const ConservedNoiseInterface& ConservedLangevinNoise::_noise

private

Definition at line 31 of file ConservedLangevinNoise.h.

Referenced by computeQpResidual().

---

The documentation for this class was generated from the following files:

• phase_field/include/kernels/ConservedLangevinNoise.h
• phase_field/src/kernels/ConservedLangevinNoise.C