GrainTrackerInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "InputParameters.h"
#include "FeatureFloodCount.h"

// Forward declarations

class GrainTrackerInterface
{
public:
  static InputParameters validParams();

  virtual Real getEntityValue(dof_id_type entity_id,
                              FeatureFloodCount::FieldType,
                              std::size_t var_index = 0) const = 0;

  virtual const std::vector<unsigned int> & getVarToFeatureVector(dof_id_type elem_id) const = 0;

  virtual unsigned int getFeatureVar(unsigned int feature_id) const = 0;

  virtual std::size_t getNumberActiveGrains() const = 0;

  virtual std::size_t getTotalFeatureCount() const = 0;

  virtual Point getGrainCentroid(unsigned int grain_id) const = 0;

  virtual bool doesFeatureIntersectBoundary(unsigned int grain_id) const = 0;

  virtual std::vector<unsigned int> getNewGrainIDs() const;
};