www.mooseframework.org
SubblockIndexProvider.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "GeneralUserObject.h"
13 
15 
16 template <>
17 InputParameters validParams<SubblockIndexProvider>();
18 
24 class SubblockIndexProvider : public GeneralUserObject
25 {
26 public:
27  static InputParameters validParams();
28 
29  SubblockIndexProvider(const InputParameters & params) : GeneralUserObject(params) {}
30 
34  virtual unsigned int getSubblockIndex(const Elem & /* elem */) const = 0;
35 
39  virtual unsigned int getMaxSubblockIndex() const = 0;
40 };
SubblockIndexProvider::getMaxSubblockIndex
virtual unsigned int getMaxSubblockIndex() const =0
The max index of subblock.
SubblockIndexProvider::getSubblockIndex
virtual unsigned int getSubblockIndex(const Elem &) const =0
The index of subblock this element is on.
SubblockIndexProvider
Abstract base class for user objects that provide an index for a given element that is independent of...
Definition: SubblockIndexProvider.h:24
SubblockIndexProvider::SubblockIndexProvider
SubblockIndexProvider(const InputParameters &params)
Definition: SubblockIndexProvider.h:29
SubblockIndexProvider::validParams
static InputParameters validParams()
Definition: SubblockIndexProvider.C:15
validParams< SubblockIndexProvider >
InputParameters validParams< SubblockIndexProvider >()