www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ConservedNoiseInterface Class Referenceabstract

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:
[legend]

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 27 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.

13  : ElementUserObject(parameters), _integral(0), _volume(0), _qp(0)
14 {
19  setRandomResetFrequency(EXEC_TIMESTEP_END);
20 }

◆ ~ConservedNoiseInterface()

virtual ConservedNoiseInterface::~ConservedNoiseInterface ( )
inlinevirtual

Definition at line 31 of file ConservedNoiseInterface.h.

31 {}

Member Function Documentation

◆ getQpRandom()

virtual Real ConservedNoiseInterface::getQpRandom ( )
protectedpure virtual

◆ getQpValue()

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

Member Data Documentation

◆ _integral

Real ConservedNoiseInterface::_integral
protected

◆ _offset

Real ConservedNoiseInterface::_offset
protected

◆ _qp

unsigned int ConservedNoiseInterface::_qp
protected

◆ _volume

Real ConservedNoiseInterface::_volume
protected

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