SamplerBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "MooseTypes.h"

// Forward Declarations
class InputParameters;
class VectorPostprocessor;
class TransientBase;

namespace libMesh
{
class Point;

namespace Parallel
{
class Communicator;
}
}

template <typename T>
InputParameters validParams();

class SamplerBase
{
public:
  static InputParameters validParams();

  SamplerBase(const InputParameters & parameters,
              VectorPostprocessor * vpp,
              const libMesh::Parallel::Communicator & comm);
  virtual ~SamplerBase() = default;

protected:
  void setupVariables(const std::vector<std::string> & variable_names);

  void checkForStandardFieldVariableType(const MooseVariableFieldBase * const var_ptr,
                                         const std::string & var_param_name = "variable") const;

  virtual void addSample(const Point & p, const Real & id, const std::vector<Real> & values);

  virtual void initialize();

  virtual void finalize();

  virtual void threadJoin(const SamplerBase & y);

  const InputParameters & _sampler_params;

  VectorPostprocessor * _vpp;

  const libMesh::Parallel::Communicator & _comm;

  const TransientBase * const _sampler_transient;

  std::vector<std::string> _variable_names;

  const unsigned int _sort_by;

  VectorPostprocessorValue & _x;
  VectorPostprocessorValue & _y;
  VectorPostprocessorValue & _z;

  VectorPostprocessorValue & _id;

  std::vector<VectorPostprocessorValue *> _values;

private:
  std::size_t _curr_num_samples = 0;
  std::set<std::size_t, std::greater<std::size_t>> _curr_indices;
  std::size_t _curr_total_samples = 0;
};