www.mooseframework.org
Indicator.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 INDICATOR_H
16 #define INDICATOR_H
17 
18 #include "MooseObject.h"
19 #include "BlockRestrictable.h"
20 #include "SetupInterface.h"
21 #include "FunctionInterface.h"
22 #include "UserObjectInterface.h"
24 #include "Restartable.h"
25 #include "OutputInterface.h"
27 
28 // Forward Declarations
29 class Indicator;
30 class MooseMesh;
31 class SubProblem;
32 class Assembly;
33 
34 template <>
36 
37 class Indicator : public MooseObject,
38  public BlockRestrictable,
39  public SetupInterface,
40  public FunctionInterface,
41  public UserObjectInterface,
43  public Restartable,
44  public OutputInterface,
46 {
47 public:
49  virtual ~Indicator(){};
50 
58  virtual void computeIndicator() = 0;
59 
65  virtual void finalize(){};
66 
68 
69  // TODO: Fixme
70  bool isActive() const { return true; }
71 
72 protected:
76  NumericVector<Number> & _solution;
77 
79 
81 
83 };
84 #endif /* INDICATOR_H */
SystemBase & _sys
Definition: Indicator.h:75
SubProblem & _subproblem
Definition: Indicator.h:73
A class for creating restricted objects.
Definition: Restartable.h:31
Keeps track of stuff related to assembling.
Definition: Assembly.h:63
virtual void finalize()
Can be overridden to do a final postprocessing of the indicator field.
Definition: Indicator.h:65
A class to provide an common interface to objects requiring "outputs" option.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
NumericVector< Number > & _solution
Definition: Indicator.h:76
MooseMesh & _mesh
Definition: Indicator.h:82
bool isActive() const
Definition: Indicator.h:70
Base class for a system (of equations)
Definition: SystemBase.h:91
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
THREAD_ID _tid
Definition: Indicator.h:78
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:74
InputParameters validParams< Indicator >()
Definition: Indicator.C:27
Interface for objects that need to use UserObjects.
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:53
An interface for accessing Materials.
virtual void computeIndicator()=0
Pure virtual that must be overridden.
An interface that restricts an object to subdomains via the &#39;blocks&#39; input parameter.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
Indicator(const InputParameters &parameters)
Definition: Indicator.C:48
virtual ~Indicator()
Definition: Indicator.h:49
FEProblemBase & _fe_problem
Definition: Indicator.h:74
SubProblem & subProblem()
Definition: Indicator.h:67
Interface for objects that need to use functions.
unsigned int THREAD_ID
Definition: MooseTypes.h:79
Assembly & _assembly
Definition: Indicator.h:80