PolycrystalUserObjectBase.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 "DenseMatrix.h"
#include "FeatureFloodCount.h"
 
// Forward Declarations
 
class PolycrystalUserObjectBase : public FeatureFloodCount
{
public:
  static InputParameters validParams();
 
  PolycrystalUserObjectBase(const InputParameters & parameters);
 
  virtual void precomputeGrainStructure() {}
 
  virtual void getGrainsBasedOnPoint(const Point & point,
                                     std::vector<unsigned int> & grains) const = 0;
 
  virtual void getGrainsBasedOnElem(const Elem & elem, std::vector<unsigned int> & grains) const
  {
    getGrainsBasedOnPoint(elem.vertex_average(), grains);
  }
 
  virtual unsigned int getNumGrains() const = 0;
 
  virtual Real getVariableValue(unsigned int op_index, const Point & p) const = 0;
 
  virtual Real getNodalVariableValue(unsigned int op_index, const Node & n) const
  {
    return getVariableValue(op_index, static_cast<const Point &>(n));
  }
 
  /* Returns all available coloring algorithms as an enumeration type for input files.
   */
  static MooseEnum coloringAlgorithms();
 
  static std::string coloringAlgorithmDescriptions();
 
  virtual void initialSetup() override;
  virtual void initialize() override;
  virtual void execute() override;
  virtual void finalize() override;
 
protected:
  virtual bool areFeaturesMergeable(const FeatureData & f1, const FeatureData & f2) const override;
  virtual bool isNewFeatureOrConnectedRegion(const DofObject * dof_object,
                                             std::size_t & current_index,
                                             FeatureData *& feature,
                                             Status & status,
                                             unsigned int & new_id) override;
  virtual void prepareDataForTransfer() override;
  virtual void mergeSets() override;
  virtual processor_id_type numberOfDistributedMergeHelpers() const override;
  virtual void restoreOriginalDataStructures(std::vector<std::list<FeatureData>> & orig) override;
 
  void buildGrainAdjacencyMatrix();
 
  void assignOpsToGrains();
 
  bool colorGraph(unsigned int vertex);
 
  bool isGraphValid(unsigned int vertex, unsigned int color);
 
  void printGrainAdjacencyMatrix() const;
 
  /*************************************************
   *************** Data Structures *****************
   ************************************************/
  std::unique_ptr<DenseMatrix<Real>> _adjacency_matrix;
 
  const unsigned int _dim;
 
  const unsigned int _op_num;
 
  std::map<unsigned int, unsigned int> _grain_to_op;
 
  const MooseEnum _coloring_algorithm;
 
  bool _colors_assigned;
 
  const bool _output_adjacency_matrix;
 
  static const unsigned int INVALID_COLOR;
 
  static const unsigned int HALO_THICKNESS;
 
private:
  processor_id_type _num_chunks;
 
  std::vector<unsigned int> _grain_idx_to_op;
 
  std::vector<unsigned int> _prealloc_tmp_grains;
 
  std::map<dof_id_type, std::vector<unsigned int>> _entity_to_grain_cache;
};