Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Laura Prieto Saavedra <[email protected]>
  • Loading branch information
blaisb and lpsaavedra authored Mar 5, 2024
1 parent 08a9b2f commit 5a724dc
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions doc/source/parameters/cfd/mesh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ This subsection provides information of the simulation geometry and its mesh. Th
# Initial refinement of the mesh near user-specified boundaries
set initial boundary refinement = 0
# Lists of boundaries next to which the mesh should be refined. The list must contain integers seperated by commas.
set boundaries refined = 0 , 1
# Lists of boundaries next to which the mesh should be refined. The list must contain integers separated by commas.
set boundaries refined = 0, 1
# Indicates that the mesh is a simplex mesh
set simplex = false
Expand All @@ -47,6 +47,6 @@ This subsection provides information of the simulation geometry and its mesh. Th

* The initial refinement number determines the number of refinements the grid will undergo in the simulation before the simulation is run. This allows one to refine a coarse grid automatically. By default, most deal.II grids will be as coarse as possible and need to be refined. This is a desirable behavior for parallel simulations, since for quad/hex meshes, the coarsest level of the grid is shared amongst all cores. Consequently, using a coarse grid with too many cells will lead to a prohibitive memory consumption.

* The initial boundary refinement determines the number of refinement the grid will undergo in the simulation in the vicinities of the boundary specified by the ``boundaries refined`` parameter.
* The initial boundary refinement determines the number of refinements the grid will undergo in the simulation in the vicinities of the boundary specified by the ``boundaries refined`` parameter.

* `simplex`. If simplex is set to true, it indicates that the mesh being read is made of only simplex elements. If the mesh is of ``type = dealii`` it will be converted from a quad/hex mesh to a simplex mesh. If the mesh is of ``type = gsmh``, it will be read from a file as long as it is only made of simplices.
8 changes: 4 additions & 4 deletions include/core/grids.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ read_mesh_and_manifolds(
/**
* @brief Refine a mesh around specific boundary ids
*
* @param n_refinement The number of times the boundary should be refined
* @param[in] n_refinement The number of times the boundary should be refined
*
* @param boundary_ids The boundary ids for which the cells should be refined
* @param[in] boundary_ids The boundary ids for which the cells should be refined
*
* @param triangulation The triangulation on which refinement must be carried out
* @param[in, out] triangulation The triangulation on which refinement must be carried out
*
*/
template <int dim, int spacedim = dim>
Expand All @@ -96,7 +96,7 @@ refine_triangulation_at_boundaries(
const unsigned int n_refinement,
parallel::DistributedTriangulationBase<dim, spacedim> &triangulation)
{
// For the amount of refinement required
// For the amount of refinements required
for (unsigned int r = 0; r < n_refinement; ++r)
{
// Loop over the cells and flag all cells which are within the list of
Expand Down
6 changes: 3 additions & 3 deletions include/core/parameters.h
Original file line number Diff line number Diff line change
Expand Up @@ -1186,16 +1186,16 @@ namespace Parameters
/// List of boundary ids to refine
std::vector<int> boundaries_to_refine;

/// Enabling fixing initial refinement from a target size
/// Enable fixing initial refinement from a target size
bool refine_until_target_size;

/// Allowing the use of a simplex mesh
/// Allow the use of a simplex mesh
bool simplex;

/// Target size when automatically refining initial mesh
double target_size;

/// Enables checking the input grid for diamond-shaped cells
/// Enable checking the input grid for diamond-shaped cells
bool check_for_diamond_cells;

/* A boolean parameter which enables adding the neighbor boundary cells of
Expand Down

0 comments on commit 5a724dc

Please sign in to comment.