https://mooseframework.inl.gov
OverlayMeshGenerator.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 #include "MeshGenerator.h"
12 
13 /*
14  * Mesh generator to create a Overlay mesh
15  */
17 {
18 public:
21  std::unique_ptr<MeshBase> generate() override;
22 
23 protected:
26 
28  std::unique_ptr<MeshBase> * _build_mesh;
29 
31  const MeshGeneratorName _mesh_name;
32 
34  std::unique_ptr<MeshBase> * _input_mesh;
35 };
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::unique_ptr< MeshBase > * _input_mesh
Hold the input mesh.
const MeshGeneratorName _mesh_name
Name of the input mesh.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:33
std::unique_ptr< MeshBase > generate() override
Generate / modify the mesh.
const InputParameters & parameters() const
Get the parameters of the object.
MooseEnum _dim
The dimension of the mesh.
std::unique_ptr< MeshBase > * _build_mesh
Hold the generated mesh.
static InputParameters validParams()
OverlayMeshGenerator(const InputParameters &parameters)
MeshGenerators are objects that can modify or add to an existing mesh.
Definition: MeshGenerator.h:32