www.mooseframework.org
ConservedNoiseBase.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
17 class ConservedNoiseBase;
18 
19 template <>
20 InputParameters validParams<ConservedNoiseBase>();
21 
32 {
33 public:
34  ConservedNoiseBase(const InputParameters & parameters);
35 
36  virtual ~ConservedNoiseBase() {}
37 
38  virtual void initialize();
39  virtual void execute();
40  virtual void threadJoin(const UserObject & y);
41  virtual void finalize();
42 
43  Real getQpValue(dof_id_type element_id, unsigned int qp) const;
44 
45 protected:
46  std::unordered_map<dof_id_type, std::vector<Real>> _random_data;
47 };
48 
ConservedNoiseBase::finalize
virtual void finalize()
Definition: ConservedNoiseBase.C:63
ConservedNoiseBase::initialize
virtual void initialize()
Definition: ConservedNoiseBase.C:29
validParams< ConservedNoiseBase >
InputParameters validParams< ConservedNoiseBase >()
Definition: ConservedNoiseBase.C:16
ConservedNoiseInterface
This Userobject is the base class of Userobjects that generate one random number per timestep and qua...
Definition: ConservedNoiseInterface.h:26
ConservedNoiseBase::ConservedNoiseBase
ConservedNoiseBase(const InputParameters &parameters)
Definition: ConservedNoiseBase.C:23
ConservedNoiseBase::threadJoin
virtual void threadJoin(const UserObject &y)
Definition: ConservedNoiseBase.C:53
ConservedNoiseBase::~ConservedNoiseBase
virtual ~ConservedNoiseBase()
Definition: ConservedNoiseBase.h:36
ConservedNoiseBase::_random_data
std::unordered_map< dof_id_type, std::vector< Real > > _random_data
Definition: ConservedNoiseBase.h:46
ConservedNoiseBase::execute
virtual void execute()
Definition: ConservedNoiseBase.C:37
ConservedNoiseInterface.h
ConservedNoiseBase
This Userobject is the base class of Userobjects that generate one random number per timestep and qua...
Definition: ConservedNoiseBase.h:31
ConservedNoiseBase::getQpValue
Real getQpValue(dof_id_type element_id, unsigned int qp) const
Definition: ConservedNoiseBase.C:72