www.mooseframework.org
SubblockIndexProvider.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef SUBBLOCKINDEXPROVIDER_H
16 #define SUBBLOCKINDEXPROVIDER_H
17 
18 #include "GeneralUserObject.h"
19 
21 
22 template <>
23 InputParameters validParams<SubblockIndexProvider>();
24 
30 class SubblockIndexProvider : public GeneralUserObject
31 {
32 public:
33  SubblockIndexProvider(const InputParameters & params) : GeneralUserObject(params) {}
34 
38  virtual unsigned int getSubblockIndex(const Elem & /* elem */) const = 0;
39 
43  virtual unsigned int getMaxSubblockIndex() const = 0;
44 };
45 
46 #endif /* SCALARVARIABLEINDEXPROVIDER_H */
virtual unsigned int getSubblockIndex(const Elem &) const =0
The index of subblock this element is on.
Abstract base class for user objects that provide an index for a given element that is independent of...
SubblockIndexProvider(const InputParameters &params)
InputParameters validParams< SubblockIndexProvider >()
virtual unsigned int getMaxSubblockIndex() const =0
The max index of subblock.