Skip to content

Commit

Permalink
Remove [MeshGenerator] syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
aeslaughter committed Oct 20, 2020
1 parent 7e2c990 commit a4c5ed4
Show file tree
Hide file tree
Showing 57 changed files with 195 additions and 211 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Adds `MeshGenerator` objects into the system that are listed under `MeshGenerators/` in the input file.

!syntax parameters /MeshGenerators/AddMeshGeneratorAction
!syntax parameters /Mesh/AddMeshGeneratorAction
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ attributes as well as retrieving those attributes.

One of the most important features of the MeshMetaDataInterface is it's availablity during recover
operations. Any system deriving from the interface will have access to attributes created during the initial setup
phase of the simulation. This removes the need to retrieve [MeshGenerators](meshgenerators/MeshGenerator.md),
[UserObjects](syntax/UserObjects/index.md), or [MooseMesh](syntax/Mesh/index.md) objects that might contain specifc
phase of the simulation. This removes the need to retrieve [MeshGenerator](meshgenerators/MeshGenerator.md),
[UserObject](syntax/UserObjects/index.md), or [MooseMesh](syntax/Mesh/index.md) objects that might contain specific
APIs that store that same information.

## MeshGenerators

The MeshGenerator system is the only system that may set attributes in the mesh meta-data store. Attributes are typically
written during the "act" phase. Here is an example of attributes written by the built-in GeneratedMeshGenerator object:

!listing framework/src/meshgenerators/GeneratedMeshGenerator.C start=GeneratedMeshGenerator::setMeshMetaData() end=void
!listing framework/src/meshgenerators/GeneratedMeshGenerator.C start=GeneratedMeshGenerator::setMeshMetaData() end=void
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AllSideSetsByNormalsGenerator

!syntax description /MeshGenerators/AllSideSetsByNormalsGenerator
!syntax description /Mesh/AllSideSetsByNormalsGenerator

## Overview

Expand All @@ -16,8 +16,8 @@ The sideset number assignment is not predictable. This utility assigns sideset n
unique normals seen while iterating over the mesh. Further enhancements could be made to more
carefully control this assignment.

!syntax parameters /MeshGenerators/AllSideSetsByNormalsGenerator
!syntax parameters /Mesh/AllSideSetsByNormalsGenerator

!syntax inputs /MeshGenerators/AllSideSetsByNormalsGenerator
!syntax inputs /Mesh/AllSideSetsByNormalsGenerator

!syntax children /MeshGenerators/AllSideSetsByNormalsGenerator
!syntax children /Mesh/AllSideSetsByNormalsGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AnnularMeshGenerator

!syntax description /MeshGenerators/AnnularMeshGenerator
!syntax description /Mesh/AnnularMeshGenerator

## Overview

Expand All @@ -27,8 +27,8 @@ Sidesets are also created:
- Sideset 2 is called "dmin" and is the set of sides at the minimum angle, which is created only in the case of a sector of an annulus (or disc)
- Sideset 3 is called "dmax" and is the set of sides at the maximum angle, which is created only in the case of a sector of an annulus (or disc)

!syntax parameters /MeshGenerators/AnnularMeshGenerator
!syntax parameters /Mesh/AnnularMeshGenerator

!syntax inputs /MeshGenerators/AnnularMeshGenerator
!syntax inputs /Mesh/AnnularMeshGenerator

!syntax children /MeshGenerators/AnnularMeshGenerator
!syntax children /Mesh/AnnularMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BlockDeletionGenerator

!syntax description /MeshGenerators/BlockDeletionGenerator
!syntax description /Mesh/BlockDeletionGenerator

## Overview

Expand All @@ -9,8 +9,8 @@ user provided subdomain ID. While most mesh generation operations should be
based on geometric operations, it is sometimes easier to remove discretized
elements for certain problems.

!syntax parameters /MeshGenerators/BlockDeletionGenerator
!syntax parameters /Mesh/BlockDeletionGenerator

!syntax inputs /MeshGenerators/BlockDeletionGenerator
!syntax inputs /Mesh/BlockDeletionGenerator

!syntax children /MeshGenerators/BlockDeletionGenerator
!syntax children /Mesh/BlockDeletionGenerator
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# BoundingBoxNodeSetGenerator

!syntax description /MeshGenerators/BoundingBoxNodeSetGenerator
!syntax description /Mesh/BoundingBoxNodeSetGenerator

## Overview

The MeshGenerator allows the user to specify a bounding box that overlays the
mesh domain. All of the nodes inside or outside of that bounding box are then
added to a new nodeset, which is specified by the user.

!syntax parameters /MeshGenerators/BoundingBoxNodeSetGenerator
!syntax parameters /Mesh/BoundingBoxNodeSetGenerator

!syntax inputs /MeshGenerators/BoundingBoxNodeSetGenerator
!syntax inputs /Mesh/BoundingBoxNodeSetGenerator

!syntax children /MeshGenerators/BoundingBoxNodeSetGenerator
!syntax children /Mesh/BoundingBoxNodeSetGenerator
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# BreakBoundaryOnSubdomainGenerator

!syntax description /MeshGenerators/BreakBoundaryOnSubdomainGenerator
!syntax description /Mesh/BreakBoundaryOnSubdomainGenerator

!syntax parameters /MeshGenerators/BreakBoundaryOnSubdomainGenerator
!syntax parameters /Mesh/BreakBoundaryOnSubdomainGenerator

!syntax inputs /MeshGenerators/BreakBoundaryOnSubdomainGenerator
!syntax inputs /Mesh/BreakBoundaryOnSubdomainGenerator

!syntax children /MeshGenerators/BreakBoundaryOnSubdomainGenerator
!syntax children /Mesh/BreakBoundaryOnSubdomainGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BreakMeshByBlockGenerator

!syntax description /MeshGenerators/BreakMeshByBlockGenerator
!syntax description /Mesh/BreakMeshByBlockGenerator

## Description

Expand Down Expand Up @@ -29,6 +29,6 @@ interface will be named `wood_Block2`.

!listing test/tests/meshgenerators/break_mesh_by_block_generator/break_mesh_2DJunction_splittrue.i block=Mesh

!syntax parameters /MeshGenerators/BreakMeshByBlockGenerator
!syntax parameters /Mesh/BreakMeshByBlockGenerator

!syntax inputs /MeshGenerators/BreakMeshByBlockGenerator
!syntax inputs /Mesh/BreakMeshByBlockGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CartesianMeshGenerator

!syntax description /MeshGenerators/CartesianMeshGenerator
!syntax description /Mesh/CartesianMeshGenerator

## Overview

Expand All @@ -20,8 +20,8 @@ Each linear subdivision in x, y, or z can be additionally subdivided into sub-el
!listing moose/test/tests/meshgenerators/cartesian_mesh_generator/cartesian_mesh_3D.i
block=Mesh

!syntax parameters /MeshGenerators/CartesianMeshGenerator
!syntax parameters /Mesh/CartesianMeshGenerator

!syntax inputs /MeshGenerators/CartesianMeshGenerator
!syntax inputs /Mesh/CartesianMeshGenerator

!syntax children /MeshGenerators/CartesianMeshGenerator
!syntax children /Mesh/CartesianMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CombinerGenerator

!syntax description /MeshGenerators/CombinerGenerator
!syntax description /Mesh/CombinerGenerator

## Overview

Expand Down Expand Up @@ -47,8 +47,8 @@ Will generate a mesh that looks like:

!media media/meshgenerators/combiner.png style=width:75%;

!syntax parameters /MeshGenerators/CombinerGenerator
!syntax parameters /Mesh/CombinerGenerator

!syntax inputs /MeshGenerators/CombinerGenerator
!syntax inputs /Mesh/CombinerGenerator

!syntax children /MeshGenerators/CombinerGenerator
!syntax children /Mesh/CombinerGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ConcentricCircleMeshGenerator

!syntax description /MeshGenerators/ConcentricCircleMeshGenerator
!syntax description /Mesh/ConcentricCircleMeshGenerator

## Overview

Expand Down Expand Up @@ -41,8 +41,8 @@ If one needs to enhance `ConcentricCircleMeshGenerator,` Laplace smoothing has t

!listing test/tests/meshgenerators/concentric_circle_mesh_generator/concentric_circle_mesh_generator.i block=Mesh

!syntax parameters /MeshGenerators/ConcentricCircleMeshGenerator
!syntax parameters /Mesh/ConcentricCircleMeshGenerator

!syntax inputs /MeshGenerators/ConcentricCircleMeshGenerator
!syntax inputs /Mesh/ConcentricCircleMeshGenerator

!syntax children /MeshGenerators/ConcentricCircleMeshGenerator
!syntax children /Mesh/ConcentricCircleMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DistributedRectilinearMeshGenerator

!syntax description /MeshGenerators/DistributedRectilinearMeshGenerator
!syntax description /Mesh/DistributedRectilinearMeshGenerator

## Overview

Expand All @@ -27,8 +27,8 @@ Final steps include adding in "ghosted" elements and making sure that boundary c

!listing distributed_rectilinear_mesh_generator.i block=Mesh

!syntax parameters /MeshGenerators/DistributedRectilinearMeshGenerator
!syntax parameters /Mesh/DistributedRectilinearMeshGenerator

!syntax inputs /MeshGenerators/DistributedRectilinearMeshGenerator
!syntax inputs /Mesh/DistributedRectilinearMeshGenerator

!syntax children /MeshGenerators/DistributedRectilinearMeshGenerator
!syntax children /Mesh/DistributedRectilinearMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ElementGenerator

!syntax description /MeshGenerators/ElementGenerator
!syntax description /Mesh/ElementGenerator

## Overview

Expand All @@ -10,8 +10,8 @@ The user has to provide the positions of the nodes for his element, as well as t

## Further ElementGenerator Documentation

!syntax parameters /MeshGenerators/ElementGenerator
!syntax parameters /Mesh/ElementGenerator

!syntax inputs /MeshGenerators/ElementGenerator
!syntax inputs /Mesh/ElementGenerator

!syntax children /MeshGenerators/ElementGenerator
!syntax children /Mesh/ElementGenerator
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ElementSubdomainIDGenerator

!syntax description /MeshGenerators/ElementSubdomainIDGenerator
!syntax description /Mesh/ElementSubdomainIDGenerator

!syntax parameters /MeshGenerators/ElementSubdomainIDGenerator
!syntax parameters /Mesh/ElementSubdomainIDGenerator

!syntax inputs /MeshGenerators/ElementSubdomainIDGenerator
!syntax inputs /Mesh/ElementSubdomainIDGenerator

!syntax children /MeshGenerators/ElementSubdomainIDGenerator
!syntax children /Mesh/ElementSubdomainIDGenerator
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ExtraNodesetGenerator

!syntax description /MeshGenerators/ExtraNodesetGenerator
!syntax description /Mesh/ExtraNodesetGenerator

!syntax parameters /MeshGenerators/ExtraNodesetGenerator
!syntax parameters /Mesh/ExtraNodesetGenerator

!syntax inputs /MeshGenerators/ExtraNodesetGenerator
!syntax inputs /Mesh/ExtraNodesetGenerator

!syntax children /MeshGenerators/ExtraNodesetGenerator
!syntax children /Mesh/ExtraNodesetGenerator
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# FancyExtruderGenerator

!syntax description /MeshGenerators/FancyExtruderGenerator
!syntax description /Mesh/FancyExtruderGenerator

## Overview

The `FancyExtruderGenerator` adds more customization options over the [MeshExtruderGenerator](MeshExtruderGenerator.md).

!syntax parameters /MeshGenerators/FancyExtruderGenerator
!syntax parameters /Mesh/FancyExtruderGenerator

!syntax inputs /MeshGenerators/FancyExtruderGenerator
!syntax inputs /Mesh/FancyExtruderGenerator

!syntax children /MeshGenerators/FancyExtruderGenerator
!syntax children /Mesh/FancyExtruderGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FileMeshGenerator

!syntax description /MeshGenerators/FileMeshGenerator
!syntax description /Mesh/FileMeshGenerator

## Supported File Formats

Expand Down Expand Up @@ -30,8 +30,8 @@ The names of the extra element integers will be the same as the names of the ele

## Further FileMeshGenerator Documentation

!syntax parameters /MeshGenerators/FileMeshGenerator
!syntax parameters /Mesh/FileMeshGenerator

!syntax inputs /MeshGenerators/FileMeshGenerator
!syntax inputs /Mesh/FileMeshGenerator

!syntax children /MeshGenerators/FileMeshGenerator
!syntax children /Mesh/FileMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GeneratedMeshGenerator

!syntax description /MeshGenerators/GeneratedMeshGenerator
!syntax description /Mesh/GeneratedMeshGenerator

## Overview

Expand All @@ -14,8 +14,8 @@ prisms ("boxes"). The mesh automatically creates boundaries that are logically n
The length, width, and height of the domain, as well as the number of elements in each direction can be specified
independently.

!syntax parameters /MeshGenerators/GeneratedMeshGenerator
!syntax parameters /Mesh/GeneratedMeshGenerator

!syntax inputs /MeshGenerators/GeneratedMeshGenerator
!syntax inputs /Mesh/GeneratedMeshGenerator

!syntax children /MeshGenerators/GeneratedMeshGenerator
!syntax children /Mesh/GeneratedMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ImageMeshGenerator

!syntax description /MeshGenerators/ImageMeshGenerator
!syntax description /Mesh/ImageMeshGenerator

## Overview

Expand All @@ -9,8 +9,8 @@ dimensional image. It is generally used in union with the [ImageFunction](/Image
perform simulations that rely on image data, such as setting up an initial condition of a grain structure. By default
the generated mesh is sized to the dimensions of the images and creates one element per pixel.

!syntax parameters /MeshGenerators/ImageMeshGenerator
!syntax parameters /Mesh/ImageMeshGenerator

!syntax inputs /MeshGenerators/ImageMeshGenerator
!syntax inputs /Mesh/ImageMeshGenerator

!syntax children /MeshGenerators/ImageMeshGenerator
!syntax children /Mesh/ImageMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ImageSubdomainGenerator

!syntax description /MeshGenerators/ImageSubdomainGenerator
!syntax description /Mesh/ImageSubdomainGenerator

## Example Syntax

Expand All @@ -19,8 +19,8 @@ In this example, the parameter `threshold` is used. This sets a color value abov

!media media/framework/mesh_modifiers/kitten_out.png style=width:550px;float:center;margin-left:40px

!syntax parameters /MeshGenerators/ImageSubdomainGenerator
!syntax parameters /Mesh/ImageSubdomainGenerator

!syntax inputs /MeshGenerators/ImageSubdomainGenerator
!syntax inputs /Mesh/ImageSubdomainGenerator

!syntax children /MeshGenerators/ImageSubdomainGenerator
!syntax children /Mesh/ImageSubdomainGenerator
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# LowerDBlockFromSidesetGenerator

!syntax description /MeshGenerators/LowerDBlockFromSidesetGenerator
!syntax description /Mesh/LowerDBlockFromSidesetGenerator

## Overview

Expand All @@ -9,8 +9,8 @@ block of elements along those sides. The order of the newly create lower
dimensional element block will match the order of the parent elements
(e.g. first order for first order parents, second order for second order parents).

!syntax parameters /MeshGenerators/LowerDBlockFromSidesetGenerator
!syntax parameters /Mesh/LowerDBlockFromSidesetGenerator

!syntax inputs /MeshGenerators/LowerDBlockFromSidesetGenerator
!syntax inputs /Mesh/LowerDBlockFromSidesetGenerator

!syntax children /MeshGenerators/LowerDBlockFromSidesetGenerator
!syntax children /Mesh/LowerDBlockFromSidesetGenerator

0 comments on commit a4c5ed4

Please sign in to comment.