www.mooseframework.org
GeneratedMesh.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 
12 #include "MooseMesh.h"
13 
17 class GeneratedMesh : public MooseMesh
18 {
19 public:
21 
23  GeneratedMesh(const GeneratedMesh & /* other_mesh */) = default;
24 
25  // No copy
26  GeneratedMesh & operator=(const GeneratedMesh & other_mesh) = delete;
27 
28  virtual std::unique_ptr<MooseMesh> safeClone() const override;
29 
30  virtual void buildMesh() override;
31  virtual Real getMinInDimension(unsigned int component) const override;
32  virtual Real getMaxInDimension(unsigned int component) const override;
33  virtual void prepared(bool state) override;
34 
35 protected:
38 
40  unsigned int _nx, _ny, _nz;
41 
44 
51 
58 
61 };
bool prepared() const
Setter/getter for whether the mesh is prepared.
Definition: MooseMesh.C:2887
virtual std::unique_ptr< MooseMesh > safeClone() const override
A safer version of the clone() method that hands back an allocated object wrapped in a smart pointer...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
MooseEnum _dim
The dimension of the mesh.
Definition: GeneratedMesh.h:37
virtual Real getMaxInDimension(unsigned int component) const override
bool _dims_may_have_changed
Boolean to indicate that dimensions may have changed.
Definition: GeneratedMesh.h:60
virtual Real getMinInDimension(unsigned int component) const override
Returns the min or max of the requested dimension respectively.
virtual void buildMesh() override
Must be overridden by child classes.
Mesh generated from parameters.
Definition: GeneratedMesh.h:17
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:88
unsigned int _ny
Definition: GeneratedMesh.h:40
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:31
Real _xmin
The min/max values for x,y,z component.
Definition: GeneratedMesh.h:43
GeneratedMesh(const InputParameters &parameters)
Definition: GeneratedMesh.C:79
GeneratedMesh & operator=(const GeneratedMesh &other_mesh)=delete
unsigned int _nz
Definition: GeneratedMesh.h:40
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
bool _gauss_lobatto_grid
All of the libmesh build_line/square/cube routines support an option to grade the mesh into the bound...
Definition: GeneratedMesh.h:50
const InputParameters & parameters() const
Get the parameters of the object.
unsigned int _nx
Number of elements in x, y, z direction.
Definition: GeneratedMesh.h:40
Real _bias_x
The amount by which to bias the cells in the x,y,z directions.
Definition: GeneratedMesh.h:57
static InputParameters validParams()
Definition: GeneratedMesh.C:28