www.mooseframework.org
SamplerData.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 
12 // MOOSE includes
13 #include "GeneralVectorPostprocessor.h"
14 #include "SamplerInterface.h"
15 
16 class SamplerData;
17 
18 template <>
19 InputParameters validParams<SamplerData>();
20 
24 class SamplerData : public GeneralVectorPostprocessor, SamplerInterface
25 {
26 public:
27  static InputParameters validParams();
28 
29  SamplerData(const InputParameters & parameters);
30  virtual void initialize() override;
31  virtual void finalize() override;
32  virtual void execute() override;
33  virtual void threadJoin(const UserObject & uo) override;
34 
35 protected:
37  std::vector<VectorPostprocessorValue *> _sample_vectors;
38 
40  Sampler & _sampler;
41 
43  const MooseEnum & _sampler_method;
44 };
SamplerData::_sample_vectors
std::vector< VectorPostprocessorValue * > _sample_vectors
Storage for declared vectors, one for each column.
Definition: SamplerData.h:37
SamplerData::validParams
static InputParameters validParams()
Definition: SamplerData.C:21
SamplerData::finalize
virtual void finalize() override
Definition: SamplerData.C:95
SamplerData::SamplerData
SamplerData(const InputParameters &parameters)
Definition: SamplerData.C:44
SamplerData
A tool for output Sampler data.
Definition: SamplerData.h:24
SamplerData::execute
virtual void execute() override
Definition: SamplerData.C:65
SamplerData::threadJoin
virtual void threadJoin(const UserObject &uo) override
Definition: SamplerData.C:103
SamplerData::initialize
virtual void initialize() override
Definition: SamplerData.C:56
SamplerData::_sampler
Sampler & _sampler
The sampler to extract data.
Definition: SamplerData.h:40
validParams< SamplerData >
InputParameters validParams< SamplerData >()
SamplerData::_sampler_method
const MooseEnum & _sampler_method
The method of data retrival from the Sample.
Definition: SamplerData.h:43