Positions.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 "GeneralReporter.h"
#include "KDTree.h"

class Positions : public GeneralReporter
{
public:
  static InputParameters validParams();
  Positions(const InputParameters & parameters);
  virtual ~Positions() = default;

  const std::vector<Point> & getPositions(bool initial) const;
  const std::vector<std::vector<Point>> & getPositionsVector2D() const;
  const std::vector<std::vector<std::vector<Point>>> & getPositionsVector3D() const;
  const std::vector<std::vector<std::vector<std::vector<Point>>>> & getPositionsVector4D() const;

  unsigned int getNumPositions(bool initial = false) const
  {
    mooseAssert(initialized(initial), "Position should be initialized");
    return (initial && _initial_positions) ? _initial_positions->size() : _positions.size();
  }

  const Point & getPosition(unsigned int index, bool initial) const;

  const Point & getNearestPosition(const Point & target, bool initial) const;

  unsigned int getNearestPositionIndex(const Point & target, bool initial) const;

  Real getMinDistanceBetweenPositions() const;

  bool arePositionsCoplanar() const;

  bool initialized(bool initial) const;

protected:
  virtual void initialize() override = 0;

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

  virtual void finalize() override;

  virtual void meshChanged() override { initialSetup(); }

  virtual void timestepSetup() override {}
  virtual void residualSetup() override {}
  virtual void jacobianSetup() override {}

  void clearPositions();

  void unrollMultiDPositions();

  const std::vector<Point> * const _initial_positions;

  std::vector<Point> & _positions;

  std::vector<std::vector<Point>> _positions_2d;

  std::vector<std::vector<std::vector<Point>>> _positions_3d;

  std::vector<std::vector<std::vector<std::vector<Point>>>> _positions_4d;

  std::unique_ptr<KDTree> _initial_positions_kd_tree;
  std::unique_ptr<KDTree> _positions_kd_tree;

  bool _need_broadcast;

  const bool _need_sort;

  bool _initialized;
};