Skip to content

Commit

Permalink
Address review: remove unnecessary headers, doco improvements
Browse files Browse the repository at this point in the history
Co-Authored-By: roystgnr <[email protected]>
  • Loading branch information
MengnanLi91 and roystgnr committed Jan 30, 2024
1 parent 056122a commit 53edc62
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Overview

The `OverlayMeshGenerator` object is the built-in mesh generation capable of creating an overlaying mesh with the given mesh block. The overlay mesh uses [DistributedRectilinearMeshGenerator.md] as sub-generator. The input parameters for DistributedRectilinearMeshGenerator are all available for OverlayMeshGenerator. The required input parameters are [!param](/Mesh/OverlayMeshGenerator/dim) (the dimension of the domain) and [!param](/Mesh/OverlayMeshGenerator/input) (the base mesh we want to overlay).
The `OverlayMeshGenerator` object is the built-in mesh generation capable of creating a Cartesian mesh overlaying the given input mesh. The overlay mesh uses [DistributedRectilinearMeshGenerator.md] as sub-generator. The input parameters for DistributedRectilinearMeshGenerator are all available for OverlayMeshGenerator. The required input parameters are [!param](/Mesh/OverlayMeshGenerator/dim) (the dimension of the domain) and [!param](/Mesh/OverlayMeshGenerator/input) (the base mesh we want to overlay).

## Example Syntax

Expand Down
2 changes: 1 addition & 1 deletion framework/include/meshgenerators/OverlayMeshGenerator.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

#pragma once
#include "MeshGenerator.h"
#include "libmesh/mesh_generation.h"

/*
* Mesh generator to create a Overlay mesh
*/
Expand Down
3 changes: 0 additions & 3 deletions framework/src/meshgenerators/OverlayMeshGenerator.C
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
#include "InputParameters.h"

// libMesh includes
#include "libmesh/mesh_generation.h"
#include "libmesh/unstructured_mesh.h"
#include "libmesh/replicated_mesh.h"
#include "libmesh/mesh_modification.h"
#include "libmesh/mesh_tools.h"

Expand Down
2 changes: 1 addition & 1 deletion test/tests/meshgenerators/overlay_mesh_generator/tests
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
issues = '#23513'
design = 'meshgenerators/OverlayMeshGenerator.md'
[Test]
requirement = 'The system shall be able to create in a distributed manner a rectilinear mesh overlaying with the given mesh.'
requirement = 'The system shall be able to create in a distributed manner a rectilinear mesh overlaying a given mesh.'
type = 'Exodiff'
input = 'overlay_mesh_generator.i'
cli_args = '--mesh-only'
Expand Down

0 comments on commit 53edc62

Please sign in to comment.