www.mooseframework.org
SideValueSampler.C
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 #include "SideValueSampler.h"
11 
12 // MOOSE includes
13 #include "MooseVariableFE.h"
14 
15 #include "libmesh/quadrature.h"
16 
18 
19 template <>
22 {
24 
25  params += validParams<SamplerBase>();
26 
27  params.addRequiredCoupledVar(
28  "variable", "The names of the variables that this VectorPostprocessor operates on");
29 
30  return params;
31 }
32 
34  : SideVectorPostprocessor(parameters), SamplerBase(parameters, this, _communicator)
35 {
36  std::vector<std::string> var_names(_coupled_moose_vars.size());
37  _values.resize(_coupled_moose_vars.size());
38 
39  for (unsigned int i = 0; i < _coupled_moose_vars.size(); i++)
40  var_names[i] = _coupled_moose_vars[i]->name();
41 
42  // Initialize the datastructions in SamplerBase
43  SamplerBase::setupVariables(var_names);
44 }
45 
46 void
48 {
50 }
51 
52 void
54 {
55  for (unsigned int _qp = 0; _qp < _qrule->n_points(); _qp++)
56  {
57  for (unsigned int i = 0; i < _coupled_moose_vars.size(); i++)
58  _values[i] = (dynamic_cast<MooseVariable *>(_coupled_moose_vars[i]))->sln()[_qp];
59 
61  }
62 }
63 
64 void
66 {
68 }
69 
70 void
72 {
73  const SideValueSampler & vpp = static_cast<const SideValueSampler &>(y);
74 
76 }
Base class for VectorPostprocessors that need to do "sampling" of values in the domain.
Definition: SamplerBase.h:40
virtual void initialize()
Initialize the datastructures.
Definition: SamplerBase.C:76
SideValueSampler(const InputParameters &parameters)
std::vector< Real > _values
So we don&#39;t have to create and destroy this vector over and over again.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const MooseArray< Point > & _q_point
virtual void finalize() override
Finalize the values.
void setupVariables(const std::vector< std::string > &variable_names)
You MUST call this in the constructor of the child class and pass down the name of the variables...
Definition: SamplerBase.C:52
unsigned int _qp
virtual void threadJoin(const SamplerBase &y)
Join the values.
Definition: SamplerBase.C:146
InputParameters validParams< SideValueSampler >()
InputParameters validParams< SideVectorPostprocessor >()
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
registerMooseObject("MooseApp", SideValueSampler)
virtual void finalize()
Finalize the values.
Definition: SamplerBase.C:92
virtual void addSample(const Point &p, const Real &id, const std::vector< Real > &values)
Call this with the value of every variable at each point you want to sample at.
Definition: SamplerBase.C:62
const QBase *const & _qrule
std::vector< MooseVariableFEBase * > _coupled_moose_vars
Vector of all coupled variables.
Definition: Coupleable.h:740
InputParameters validParams< SamplerBase >()
Definition: SamplerBase.C:23
virtual void threadJoin(const UserObject &y) override
Must override.
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:59
virtual void execute() override
Execute method.
const Elem *const & _current_elem
virtual void initialize() override
Initialize the datastructures.
Base class for user-specific data.
Definition: UserObject.h:37