ConservedMaskedNormalNoise Class Reference

Userobject that generates a normaly distributed random number once per timestep for every quadrature point in a way that the integral over all random numbers is zero. More...

#include <ConservedMaskedNormalNoise.h>

Inheritance diagram for ConservedMaskedNormalNoise:

Public Member Functions
	ConservedMaskedNormalNoise (const InputParameters &parameters)
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
Real	getQpRandom ()

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

Userobject that generates a normaly distributed random number once per timestep for every quadrature point in a way that the integral over all random numbers is zero.

See also

ConservedNoiseBase

Definition at line 28 of file ConservedMaskedNormalNoise.h.

Constructor & Destructor Documentation

ConservedMaskedNormalNoise()

ConservedMaskedNormalNoise::ConservedMaskedNormalNoise ( const InputParameters &  parameters )

inline

Definition at line 31 of file ConservedMaskedNormalNoise.h.

    : ConservedNormalNoiseVeneer<ConservedMaskedNoiseBase>(parameters)
  {
  }

Member Function Documentation

execute()

void ConservedMaskedNoiseBase::execute ( )

virtualinherited

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 ( )

virtualinherited

Definition at line 66 of file ConservedMaskedNoiseBase.C.

{
  gatherSum(_integral);
  gatherSum(_volume);

  // TODO check that _volume is >0
  _offset = _integral / _volume;
}

getQpRandom()

Real ConservedNormalNoiseVeneer< ConservedMaskedNoiseBase >::getQpRandom ( )

protectedvirtualinherited

Implements ConservedNoiseInterface.

Definition at line 42 of file ConservedNormalNoiseVeneer.h.

{
  // Box-Muller
  if (_phase == 0)
  {
    const Real U1 = this->getRandomReal();
    const Real U2 = this->getRandomReal();

    const Real R = std::sqrt(-2.0 * std::log(U1));

    Real Z1 = R * std::cos(2.8 * libMesh::pi * U2);
    _Z2 = R * std::sin(2.8 * libMesh::pi * U2);

    _phase = 1;
    return Z1;
  }
  else
  {
    _phase = 0;
    return _Z2;
  }
}

getQpValue()

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

virtualinherited

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 ( )

virtualinherited

Definition at line 31 of file ConservedMaskedNoiseBase.C.

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

threadJoin()

void ConservedMaskedNoiseBase::threadJoin ( const UserObject &  y )

virtualinherited

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 38 of file ConservedNoiseInterface.h.

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

_mask

const MaterialProperty<Real>& ConservedMaskedNoiseBase::_mask

protectedinherited

Definition at line 50 of file ConservedMaskedNoiseBase.h.

Referenced by ConservedMaskedNoiseBase::execute().

_offset

Real ConservedNoiseInterface::_offset

protectedinherited

Definition at line 40 of file ConservedNoiseInterface.h.

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

_qp

unsigned int ConservedNoiseInterface::_qp

protectedinherited

Definition at line 42 of file ConservedNoiseInterface.h.

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

_random_data

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

protectedinherited

Definition at line 48 of file ConservedMaskedNoiseBase.h.

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

_volume

Real ConservedNoiseInterface::_volume

protectedinherited

Definition at line 39 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 file:

• phase_field/include/userobjects/ConservedMaskedNormalNoise.h