www.mooseframework.org
GeometryBase.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 GEOMETRYBASE_H
16 #define GEOMETRYBASE_H
17 
18 #include "GeneralUserObject.h"
19 
20 class GeometryBase;
21 
22 template <>
24 
30 {
31 public:
33 
34  virtual void initialize() final;
35  virtual void execute() final;
36  virtual void finalize() final;
37 
38  virtual void meshChanged() final;
39 
40 protected:
46  virtual void snapNode(Node & node) = 0;
47 
50 
52  const std::vector<BoundaryID> _boundary_ids;
53 };
54 
55 #endif // GEOMETRYBASE_H
GeometryBase(const InputParameters &parameters)
Definition: GeometryBase.C:30
virtual void initialize() final
Called before execute() is ever called so that data can be cleared.
Definition: GeometryBase.C:38
virtual void execute() final
Execute method.
Definition: GeometryBase.C:43
const std::vector< BoundaryID > _boundary_ids
List of boundaries (or node sets) that will be snapped to a geometry.
Definition: GeometryBase.h:52
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:74
virtual void finalize() final
Finalize.
Definition: GeometryBase.C:48
virtual void meshChanged() final
Called on this object when the mesh changes.
Definition: GeometryBase.C:53
InputParameters validParams< GeometryBase >()
Definition: GeometryBase.C:21
MooseMesh & _mesh
Reference to teh current simulation mesh.
Definition: GeometryBase.h:49
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
Base class for userobjects that snap nodes to a defined geometry when adaptivity happens.
Definition: GeometryBase.h:29
virtual void snapNode(Node &node)=0
Override this method in derived classes to implement a specific geometry.