ConservedNoiseInterface Class Reference

This Userobject is the base class of Userobjects that generate one random number per timestep and quadrature point in a way that the integral over all random numbers is zero. More...

#include <ConservedNoiseInterface.h>

Inheritance diagram for ConservedNoiseInterface:

Public Member Functions
	ConservedNoiseInterface (const InputParameters &parameters)
virtual	~ConservedNoiseInterface ()
virtual Real	getQpValue (dof_id_type element_id, unsigned int qp) const =0

Protected Member Functions
virtual Real	getQpRandom ()=0

Protected Attributes
Real	_integral
Real	_volume
Real	_offset
unsigned int	_qp

Detailed Description

This Userobject is the base class of Userobjects that generate one random number per timestep and quadrature point in a way that the integral over all random numbers is zero.

This can be used for a concentration fluctuation kernel such as ConservedLangevinNoise, that keeps the total concenration constant.

See also

ConservedUniformNoise

ConservedNormalNoise

Definition at line 26 of file ConservedNoiseInterface.h.

Constructor & Destructor Documentation

ConservedNoiseInterface()

ConservedNoiseInterface::ConservedNoiseInterface

(

const InputParameters &

parameters

)

This call turns on Random Number generation for this object, it can be called either in the constructor or in initialSetup().

Definition at line 12 of file ConservedNoiseInterface.C.

  : ElementUserObject(parameters), _integral(0), _volume(0), _qp(0)
{
  setRandomResetFrequency(EXEC_TIMESTEP_END);
}

~ConservedNoiseInterface()

virtual ConservedNoiseInterface::~ConservedNoiseInterface ( )

inlinevirtual

Definition at line 30 of file ConservedNoiseInterface.h.

{}

Member Function Documentation

getQpRandom()

virtual Real ConservedNoiseInterface::getQpRandom ( )

protectedpure virtual

Implemented in ConservedNormalNoiseVeneer< ConservedMaskedNoiseBase >, ConservedNormalNoiseVeneer< ConservedNoiseBase >, ConservedUniformNoiseVeneer< ConservedMaskedNoiseBase >, and ConservedUniformNoiseVeneer< ConservedNoiseBase >.

Referenced by ConservedNoiseBase::execute(), and ConservedMaskedNoiseBase::execute().

getQpValue()

virtual Real ConservedNoiseInterface::getQpValue ( dof_id_type  element_id, unsigned int  qp  ) const

pure virtual

Implemented in ConservedMaskedNoiseBase, and ConservedNoiseBase.

Referenced by ConservedLangevinNoise::computeQpResidual().

Member Data Documentation

_integral

Real ConservedNoiseInterface::_integral

protected

Definition at line 37 of file ConservedNoiseInterface.h.

Referenced by ConservedNoiseBase::execute(), ConservedMaskedNoiseBase::execute(), ConservedNoiseBase::finalize(), ConservedMaskedNoiseBase::finalize(), ConservedNoiseBase::initialize(), ConservedMaskedNoiseBase::initialize(), ConservedNoiseBase::threadJoin(), and ConservedMaskedNoiseBase::threadJoin().

_offset

Real ConservedNoiseInterface::_offset

protected

Definition at line 39 of file ConservedNoiseInterface.h.

Referenced by ConservedNoiseBase::finalize(), ConservedMaskedNoiseBase::finalize(), ConservedNoiseBase::getQpValue(), and ConservedMaskedNoiseBase::getQpValue().

_qp

unsigned int ConservedNoiseInterface::_qp

protected

Definition at line 41 of file ConservedNoiseInterface.h.

Referenced by ConservedNoiseBase::execute(), and ConservedMaskedNoiseBase::execute().

_volume

Real ConservedNoiseInterface::_volume

protected

Definition at line 38 of file ConservedNoiseInterface.h.

Referenced by ConservedNoiseBase::execute(), ConservedMaskedNoiseBase::execute(), ConservedNoiseBase::finalize(), ConservedMaskedNoiseBase::finalize(), ConservedNoiseBase::initialize(), ConservedMaskedNoiseBase::initialize(), ConservedNoiseBase::threadJoin(), and ConservedMaskedNoiseBase::threadJoin().

---

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

• phase_field/include/userobjects/ConservedNoiseInterface.h
• phase_field/src/userobjects/ConservedNoiseInterface.C