NekSpatialBinUserObject.h

Go to the documentation of this file.

/********************************************************************/
/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
/*                             Cardinal                             */
/*                                                                  */
/*                  (c) 2021 UChicago Argonne, LLC                  */
/*                        ALL RIGHTS RESERVED                       */
/*                                                                  */
/*                 Prepared by UChicago Argonne, LLC                */
/*               Under Contract No. DE-AC02-06CH11357               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*             Prepared by Battelle Energy Alliance, LLC            */
/*               Under Contract No. DE-AC07-05ID14517               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*                 See LICENSE for full restrictions                */
/********************************************************************/

#pragma once

#include "GeneralUserObject.h"
#include "NekFieldInterface.h"
#include "NekBase.h"
#include "SpatialBinUserObject.h"

class NekSpatialBinUserObject : public GeneralUserObject, public NekBase, public NekFieldInterface
{
public:
  static InputParameters validParams();

  NekSpatialBinUserObject(const InputParameters & parameters);

  virtual ~NekSpatialBinUserObject();

  virtual void initialize() {}
  virtual void finalize() {}
  virtual void execute() override;

  virtual void executeUserObject() = 0;

  virtual Real spatialValue(const Point & p) const override final;

  virtual Real spatialValue(const Point & p, const unsigned int & component) const = 0;

  virtual const unsigned int bin(const Point & p) const;

  virtual const unsigned int num_bins() const;

  virtual const std::vector<Point> spatialPoints() const override { return _points; }

  virtual void computeBinVolumes() final;

  virtual void getBinVolumes() = 0;

  const std::vector<unsigned int> unrolledBin(const unsigned int & total_bin_index) const;

  Point nekPoint(const int & local_elem_id, const int & local_node_id) const;

protected:
  void computePoints1D();

  void computePoints2D();

  void computePoints3D();

  void resetPartialStorage();

  void fillCoordinates(const std::vector<unsigned int> & indices, Point & p) const;

  const unsigned int & _interval;

  bool _fixed_mesh;

  const std::vector<UserObjectName> & _bin_names;

  const bool & _map_space_by_qp;

  const bool & _check_zero_contributions;

  std::vector<const SpatialBinUserObject *> _bins;

  std::vector<bool> _has_direction;

  std::vector<unsigned int> _bin_providing_direction;

  unsigned int _n_bins;

  std::vector<Point> _points;

  std::vector<Point> _velocity_bin_directions;

  double * _bin_values;

  double * _bin_values_x;
  double * _bin_values_y;
  double * _bin_values_z;

  double * _bin_volumes;

  int * _bin_counts;

  double * _bin_partial_values;

  int * _bin_partial_counts;
};