www.mooseframework.org
NodalValueSampler.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 "NodalValueSampler.h"
11 
12 // MOOSE includes
13 #include "MooseVariableFE.h"
14 
15 // C++ includes
16 #include <numeric>
17 
19 
22 {
24 
25  params.addClassDescription("Samples values of nodal variable(s).");
26 
27  params += SamplerBase::validParams();
28 
29  return params;
30 }
31 
33  : NodalVariableVectorPostprocessor(parameters), SamplerBase(parameters, this, _communicator)
34 {
35  // ensure that variables are nodal, i.e., not scalar and and not elemental
36  for (unsigned int i = 0; i < _coupled_moose_vars.size(); i++)
37  if (_coupled_moose_vars[i]->feType().family == SCALAR || !_coupled_moose_vars[i]->isNodal())
38  paramError("variable", "The variable '", _coupled_moose_vars[i]->name(), "' is not nodal.");
39 
40  std::vector<std::string> var_names(_coupled_moose_vars.size());
41  _values.resize(_coupled_moose_vars.size());
42  _has_values.resize(_coupled_moose_vars.size());
43 
44  for (unsigned int i = 0; i < _coupled_moose_vars.size(); i++)
45  var_names[i] = _coupled_moose_vars[i]->name();
46 
47  // Initialize the data structures in SamplerBase
48  SamplerBase::setupVariables(var_names);
49 }
50 
51 void
53 {
55 }
56 
57 void
59 {
60  // There may not be a nodal solution value at every node. This
61  // can happen if, for instance, you have a LINEAR, LAGRANGE
62  // variable defined on a mesh with quadratic elements.
63  //
64  // We currently handle the following cases:
65  // 1.) *none* of the coupled vars have values at the current node
66  // 2.) *all* of the coupled vars have values at the current node
67  //
68  // If you have two different discretizations, you'll have to use two
69  // separate NodalValueSampler objects to get their values.
70  for (unsigned int i = 0; i < _coupled_standard_moose_vars.size(); i++)
71  {
72  const VariableValue & nodal_solution = _coupled_standard_moose_vars[i]->dofValues();
73 
74  if (nodal_solution.size() > 0)
75  {
76  _values[i] = nodal_solution[_qp];
77  _has_values[i] = 1;
78  }
79  else
80  {
81  _values[i] = 0.; // arbitrary, will not be used
82  _has_values[i] = 0;
83  }
84  }
85 
86  // Sum the number of values we had
87  unsigned int num_values =
88  std::accumulate(_has_values.begin(), _has_values.end(), 0, std::plus<unsigned int>());
89 
90  // If the number of values matches the number of available values,
91  // call addSample() as normal. If there are more than zero values
92  // available but less than the number requested, throw an error.
93  // Otherwise, num_values==0, and we can skip adding the sample
94  // entirely without error.
95  if (num_values == _has_values.size())
97 
98  else if (num_values != 0 && num_values < _has_values.size())
99  mooseError("You must use separate NodalValueSampler objects for variables with different "
100  "discretizations.");
101 }
102 
103 void
105 {
107 }
108 
109 void
111 {
112  const auto & vpp = static_cast<const NodalValueSampler &>(y);
113 
115 }
Base class for VectorPostprocessors that need to do "sampling" of values in the domain.
Definition: SamplerBase.h:36
virtual void initialize()
Initialize the datastructures.
Definition: SamplerBase.C:75
SCALAR
const Node *const & _current_node
Reference to current node pointer.
virtual void execute() override
Execute method.
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...
virtual void initialize() override
Initialize the datastructures.
Samples values of nodal variable(s).
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:56
std::vector< MooseVariable * > _coupled_standard_moose_vars
Vector of standard coupled variables.
Definition: Coupleable.h:1330
NodalValueSampler(const InputParameters &parameters)
virtual void threadJoin(const UserObject &y) override
Must override.
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:51
virtual void threadJoin(const SamplerBase &y)
Join the values.
Definition: SamplerBase.C:145
std::vector< unsigned int > _has_values
Vector of 0 and 1 values which records whether values are present at the current node.
void paramError(const std::string &param, Args... args) const
Emits an error prefixed with the file and line number of the given param (from the input file) along ...
const unsigned int _qp
Quadrature point index.
static InputParameters validParams()
Definition: SamplerBase.C:22
std::vector< MooseVariableFieldBase * > _coupled_moose_vars
Vector of all coupled variables.
Definition: Coupleable.h:1327
OutputTools< Real >::VariableValue VariableValue
Definition: MooseTypes.h:302
virtual void finalize()
Finalize the values.
Definition: SamplerBase.C:91
virtual void finalize() override
Finalize the values.
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:61
Base class VectorPostprocessors operating on nodal variables.
static InputParameters validParams()
registerMooseObject("MooseApp", NodalValueSampler)
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
Base class for user-specific data.
Definition: UserObject.h:39