MultiAppGeneralFieldKDTreeTransferBase.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

#include "MultiAppGeneralFieldTransfer.h"
#include "KDTree.h"
#include "SolutionInvalidInterface.h"

class MultiAppGeneralFieldKDTreeTransferBase : public MultiAppGeneralFieldTransfer
{
public:
  static InputParameters validParams();

  MultiAppGeneralFieldKDTreeTransferBase(const InputParameters & parameters);

  void initialSetup() override;

  // Use solution invalid output for these warnings
  usingCombinedWarningSolutionWarnings;

protected:
  virtual void prepareEvaluationOfInterpValues(const unsigned int var_index) override;

  using MultiAppGeneralFieldTransfer::inBlocks;
  bool inBlocks(const std::set<SubdomainID> & blocks,
                const MooseMesh & mesh,
                const Elem * elem) const override;

  bool usesMooseAppCoordTransform() const override { return true; }
  /*
   * Build KD-Trees for each local app
   * @param var_index the index of the variable being transferred
   * @details fills _local_kdtrees, _local_points and _local_values
   *          Indexing is: local apps (outer-indexing) OR positions (if using nearest_positions),
   *          local nodes (inner-indexing)
   */
  virtual void buildKDTrees(const unsigned int var_index) = 0;

  void computeNumSources();

  unsigned int getAppIndex(unsigned int kdtree_index, unsigned int app_index_in_tree) const;

  unsigned int getNumAppsPerTree() const;

  unsigned int getNumDivisions() const;

  Point getPointInSourceKDTreeFrame(unsigned int i_source, const Point & pt) const;

  bool checkRestrictionsForSource(const Point & pt,
                                  const unsigned int valid_mesh_div,
                                  const unsigned int i_from) const;

  void evaluateNearestNodeFromKDTrees(const Point & pt,
                                      unsigned int source_index,
                                      std::pair<Real, Real> & outgoing_val,
                                      bool & point_found);

  std::vector<std::shared_ptr<KDTree>> _local_kdtrees;

  std::vector<std::vector<std::shared_ptr<KDTree>>> _local_positions_kdtrees;

  std::vector<std::vector<Point>> _local_points;

  std::vector<std::vector<Real>> _local_values;

  unsigned int _num_nearest_points;

  const bool _group_subapps;

  unsigned int _num_sources;
};