ConservedNoiseBase 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 <ConservedNoiseBase.h>

Inheritance diagram for ConservedNoiseBase:

Public Member Functions
	ConservedNoiseBase (const InputParameters &parameters)
virtual	~ConservedNoiseBase ()
virtual void	initialize ()
virtual void	execute ()
virtual void	threadJoin (const UserObject &y)
virtual void	finalize ()
Real	getQpValue (dof_id_type element_id, unsigned int qp) const

Protected Member Functions
virtual Real	getQpRandom ()=0

Protected Attributes
std::unordered_map< dof_id_type, std::vector< Real > >	_random_data
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 31 of file ConservedNoiseBase.h.

Constructor & Destructor Documentation

ConservedNoiseBase()

ConservedNoiseBase::ConservedNoiseBase

(

const InputParameters &

parameters

)

Definition at line 23 of file ConservedNoiseBase.C.

  : ConservedNoiseInterface(parameters)
{
}

~ConservedNoiseBase()

virtual ConservedNoiseBase::~ConservedNoiseBase ( )

inlinevirtual

Definition at line 36 of file ConservedNoiseBase.h.

{}

Member Function Documentation

execute()

void ConservedNoiseBase::execute ( )

virtual

Definition at line 37 of file ConservedNoiseBase.C.

{
  // reserve space for each quadrature point in the element
  std::vector<Real> & me = _random_data[_current_elem->id()] =
      std::vector<Real>(_qrule->n_points());
 
  // store a random number for each quadrature point
  for (_qp = 0; _qp < _qrule->n_points(); _qp++)
  {
    me[_qp] = getQpRandom();
    _integral += _JxW[_qp] * _coord[_qp] * me[_qp];
    _volume += _JxW[_qp] * _coord[_qp];
  }
}

finalize()

void ConservedNoiseBase::finalize ( )

virtual

Definition at line 63 of file ConservedNoiseBase.C.

{
  gatherSum(_integral);
  gatherSum(_volume);
 
  _offset = _integral / _volume;
}

getQpRandom()

virtual Real ConservedNoiseInterface::getQpRandom ( )

protectedpure virtualinherited

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

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

getQpValue()

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

virtual

Implements ConservedNoiseInterface.

Definition at line 72 of file ConservedNoiseBase.C.

{
  const auto it_pair = _random_data.find(element_id);
 
  if (it_pair == _random_data.end())
    mooseError("Element not found.");
  else
  {
    libmesh_assert_less(qp, it_pair->second.size());
    return it_pair->second[qp] - _offset;
  }
}

initialize()

void ConservedNoiseBase::initialize ( )

virtual

Definition at line 29 of file ConservedNoiseBase.C.

{
  _random_data.clear();
  _integral = 0.0;
  _volume = 0.0;
}

threadJoin()

void ConservedNoiseBase::threadJoin ( const UserObject &  y )

virtual

Definition at line 53 of file ConservedNoiseBase.C.

{
  const ConservedNoiseBase & uo = static_cast<const ConservedNoiseBase &>(y);
 
  _random_data.insert(uo._random_data.begin(), uo._random_data.end());
  _integral += uo._integral;
  _volume += uo._volume;
}

Member Data Documentation

_integral

Real ConservedNoiseInterface::_integral

protectedinherited

Definition at line 37 of file ConservedNoiseInterface.h.

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

_offset

Real ConservedNoiseInterface::_offset

protectedinherited

Definition at line 39 of file ConservedNoiseInterface.h.

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

_qp

unsigned int ConservedNoiseInterface::_qp

protectedinherited

Definition at line 41 of file ConservedNoiseInterface.h.

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

_random_data

std::unordered_map<dof_id_type, std::vector<Real> > ConservedNoiseBase::_random_data

protected

Definition at line 46 of file ConservedNoiseBase.h.

Referenced by execute(), getQpValue(), initialize(), and threadJoin().

_volume

Real ConservedNoiseInterface::_volume

protectedinherited

Definition at line 38 of file ConservedNoiseInterface.h.

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

---

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

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