www.mooseframework.org
ConservedMaskedNoiseBase.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
13 
14 #include <unordered_map>
15 
16 // Forward Declarations
18 
19 template <>
21 
33 {
34 public:
35  ConservedMaskedNoiseBase(const InputParameters & parameters);
36 
38 
39  virtual void initialize();
40  virtual void execute();
41  virtual void threadJoin(const UserObject & y);
42  virtual void finalize();
43 
44  Real getQpValue(dof_id_type element_id, unsigned int qp) const;
45 
46 protected:
47  std::unordered_map<dof_id_type, std::vector<std::pair<Real, Real>>> _random_data;
48 
49  const MaterialProperty<Real> & _mask;
50 };
51 
ConservedMaskedNoiseBase::threadJoin
virtual void threadJoin(const UserObject &y)
Definition: ConservedMaskedNoiseBase.C:56
validParams< ConservedMaskedNoiseBase >
InputParameters validParams< ConservedMaskedNoiseBase >()
Definition: ConservedMaskedNoiseBase.C:16
ConservedMaskedNoiseBase::finalize
virtual void finalize()
Definition: ConservedMaskedNoiseBase.C:66
ConservedMaskedNoiseBase::getQpValue
Real getQpValue(dof_id_type element_id, unsigned int qp) const
Definition: ConservedMaskedNoiseBase.C:76
ConservedNoiseInterface
This Userobject is the base class of Userobjects that generate one random number per timestep and qua...
Definition: ConservedNoiseInterface.h:26
ConservedMaskedNoiseBase::ConservedMaskedNoiseBase
ConservedMaskedNoiseBase(const InputParameters &parameters)
Definition: ConservedMaskedNoiseBase.C:25
ConservedMaskedNoiseBase::~ConservedMaskedNoiseBase
virtual ~ConservedMaskedNoiseBase()
Definition: ConservedMaskedNoiseBase.h:37
ConservedMaskedNoiseBase::execute
virtual void execute()
Definition: ConservedMaskedNoiseBase.C:39
ConservedMaskedNoiseBase::_random_data
std::unordered_map< dof_id_type, std::vector< std::pair< Real, Real > > > _random_data
Definition: ConservedMaskedNoiseBase.h:47
ConservedNoiseInterface.h
ConservedMaskedNoiseBase
This Userobject is the base class of Userobjects that generate one random number per timestep and qua...
Definition: ConservedMaskedNoiseBase.h:32
ConservedMaskedNoiseBase::_mask
const MaterialProperty< Real > & _mask
Definition: ConservedMaskedNoiseBase.h:49
ConservedMaskedNoiseBase::initialize
virtual void initialize()
Definition: ConservedMaskedNoiseBase.C:31