MeshGenerator.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "MooseObject.h"
#include "Restartable.h"

// Included so mesh generators don't need to include this when constructing MeshBase objects
#include "MooseMesh.h"

#include "libmesh/mesh_base.h"

// Forward declarations
class MeshGenerator;
class MooseMesh;

template <>
InputParameters validParams<MeshGenerator>();

class MeshGenerator : public MooseObject, public Restartable
{
public:
  MeshGenerator(const InputParameters & parameters);

  virtual std::unique_ptr<MeshBase> generate() = 0;

  std::vector<std::string> & getDependencies() { return _depends_on; }

protected:
  std::unique_ptr<MeshBase> & getMesh(const std::string & input_mesh_generator_parameter_name);

  std::unique_ptr<MeshBase> &
  getMeshByName(const MeshGeneratorName & input_mesh_generator_parameter_name);

  std::shared_ptr<MooseMesh> & _mesh;

private:
  std::vector<std::string> _depends_on;

  std::unique_ptr<MeshBase> _null_mesh = nullptr;
};