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

Inheritance diagram for ConservedMaskedNoiseBase:

Public Member Functions
	ConservedMaskedNoiseBase (const InputParameters &parameters)
virtual	~ConservedMaskedNoiseBase ()
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< std::pair< Real, Real > > >	_random_data
const MaterialProperty< Real > &	_mask
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.

It behaves as ConservedNoiseBase but allows the user to specify a multiplicator in the form of a MaterialProperty that is multiplied on each random number, effectively masking the random number field.

See also

ConservedUniformNoise

ConservedNormalNoise

Definition at line 32 of file ConservedMaskedNoiseBase.h.

Constructor & Destructor Documentation

ConservedMaskedNoiseBase()

ConservedMaskedNoiseBase::ConservedMaskedNoiseBase

(

const InputParameters &

parameters

)

Definition at line 25 of file ConservedMaskedNoiseBase.C.

  : ConservedNoiseInterface(parameters), _mask(getMaterialProperty<Real>("mask"))
{
}

~ConservedMaskedNoiseBase()

virtual ConservedMaskedNoiseBase::~ConservedMaskedNoiseBase ( )

inlinevirtual

Definition at line 37 of file ConservedMaskedNoiseBase.h.

{}

Member Function Documentation

execute()

void ConservedMaskedNoiseBase::execute ( )

virtual

Definition at line 39 of file ConservedMaskedNoiseBase.C.

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

finalize()

void ConservedMaskedNoiseBase::finalize ( )

virtual

Definition at line 66 of file ConservedMaskedNoiseBase.C.

{
  gatherSum(_integral);
  gatherSum(_volume);
 
  // TODO check that _volume is >0
  _offset = _integral / _volume;
}

getQpRandom()

virtual Real ConservedNoiseInterface::getQpRandom ( )

protectedpure virtualinherited

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

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

getQpValue()

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

virtual

Implements ConservedNoiseInterface.

Definition at line 76 of file ConservedMaskedNoiseBase.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].first - _offset) * it_pair->second[qp].second;
  }
}

initialize()

void ConservedMaskedNoiseBase::initialize ( )

virtual

Definition at line 31 of file ConservedMaskedNoiseBase.C.

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

threadJoin()

void ConservedMaskedNoiseBase::threadJoin ( const UserObject &  y )

virtual

Definition at line 56 of file ConservedMaskedNoiseBase.C.

{
  const ConservedMaskedNoiseBase & uo = static_cast<const ConservedMaskedNoiseBase &>(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 ConservedNoiseBase::execute(), execute(), ConservedNoiseBase::finalize(), finalize(), ConservedNoiseBase::initialize(), initialize(), ConservedNoiseBase::threadJoin(), and threadJoin().

_mask

const MaterialProperty<Real>& ConservedMaskedNoiseBase::_mask

protected

Definition at line 49 of file ConservedMaskedNoiseBase.h.

Referenced by execute().

_offset

Real ConservedNoiseInterface::_offset

protectedinherited

Definition at line 39 of file ConservedNoiseInterface.h.

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

_qp

unsigned int ConservedNoiseInterface::_qp

protectedinherited

Definition at line 41 of file ConservedNoiseInterface.h.

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

_random_data

std::unordered_map<dof_id_type, std::vector<std::pair<Real, Real> > > ConservedMaskedNoiseBase::_random_data

protected

Definition at line 47 of file ConservedMaskedNoiseBase.h.

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

_volume

Real ConservedNoiseInterface::_volume

protectedinherited

Definition at line 38 of file ConservedNoiseInterface.h.

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

---

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

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