Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::MeshBoxRefinement< dim, spacedim > Struct Template Reference

#include <parameters.h>

Public Member Functions

void declare_parameters (ParameterHandler &prm)
void parse_parameters (ParameterHandler &prm)

Public Attributes

unsigned int number_of_refinement_boxes = 0
const unsigned int max_number_of_refinement_boxes = 20
std::shared_ptr< std::vector< Mesh< dim, spacedim > > > refinement_boxes_meshes
std::vector< unsigned int > box_additional_refinements

Detailed Description

template<int dim, int spacedim = dim>
struct Parameters::MeshBoxRefinement< dim, spacedim >

Container of the parameters for box refinements. The regions to refine can be described by either a GMSH or a deal.II mesh.

Definition at line 2175 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

template<int dim, int spacedim>
void Parameters::MeshBoxRefinement< dim, spacedim >::declare_parameters ( ParameterHandler & prm)

Declare the parameters.

Parameters
[in,out]prmParameterHandler object.

Definition at line 3342 of file parameters.cc.

References max_number_of_refinement_boxes, and number_of_refinement_boxes.

◆ parse_parameters()

template<int dim, int spacedim>
void Parameters::MeshBoxRefinement< dim, spacedim >::parse_parameters ( ParameterHandler & prm)

Parse the parameters.

Parameters
[in]prmParameterHandler object.

Definition at line 3371 of file parameters.cc.

References box_additional_refinements, max_number_of_refinement_boxes, and number_of_refinement_boxes.

Member Data Documentation

◆ box_additional_refinements

template<int dim, int spacedim = dim>
std::vector<unsigned int> Parameters::MeshBoxRefinement< dim, spacedim >::box_additional_refinements
Initial value:
=
std::vector<unsigned int>(max_number_of_refinement_boxes)
const unsigned int max_number_of_refinement_boxes

Vector of additional refinement values of the different boxes.

Definition at line 2197 of file parameters.h.

◆ max_number_of_refinement_boxes

template<int dim, int spacedim = dim>
const unsigned int Parameters::MeshBoxRefinement< dim, spacedim >::max_number_of_refinement_boxes = 20

Maximum number of refinement boxes that can be defined by a user.

Remarks
A maximal value has to be initialized to fill the vectors with parameter declarations.

Definition at line 2186 of file parameters.h.

◆ number_of_refinement_boxes

template<int dim, int spacedim = dim>
unsigned int Parameters::MeshBoxRefinement< dim, spacedim >::number_of_refinement_boxes = 0

Number of boxes delimiting refinement regions.

Definition at line 2178 of file parameters.h.

◆ refinement_boxes_meshes

template<int dim, int spacedim = dim>
std::shared_ptr<std::vector<Mesh<dim, spacedim> > > Parameters::MeshBoxRefinement< dim, spacedim >::refinement_boxes_meshes
Initial value:
=
std::make_shared<std::vector<Mesh<dim, spacedim>>>(

Shared pointer of a vector of GMSH and deal.II meshes representing refinement areas.

Definition at line 2192 of file parameters.h.


The documentation for this struct was generated from the following files: