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

#include <parameters.h>

Public Types

enum class  Type : std::int8_t { gmsh , dealii , lethe }

Public Member Functions

void parse_parameters (ParameterHandler &prm)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

Type type = Type::dealii
std::string file_name = "none"
std::string grid_type = "hyper_cube"
std::string grid_arguments = "-1 : 1 : false"
unsigned int initial_refinement = 0
unsigned int initial_refinement_at_boundaries = 0
std::vector< int > boundaries_to_refine
bool refine_until_target_size = false
bool simplex = false
double target_size = 1.
bool check_for_diamond_cells = false
bool expand_particle_wall_contact_search = false
Tensor< 1, spacedim > translation
Tensor< 1, spacedim > rotation_axis
double rotation_angle = 0.
double scale = 1.

Detailed Description

template<int dim, int spacedim = dim>
class Parameters::Mesh< dim, spacedim >

Mesh - Parameters that control mesh reading and mesh generation.

Definition at line 2001 of file parameters.h.

Member Enumeration Documentation

◆ Type

template<int dim, int spacedim = dim>
enum class Parameters::Mesh::Type : std::int8_t
strong
Enumerator
gmsh 
dealii 
lethe 

Definition at line 2005 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

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

◆ parse_parameters()

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

Member Data Documentation

◆ boundaries_to_refine

template<int dim, int spacedim = dim>
std::vector<int> Parameters::Mesh< dim, spacedim >::boundaries_to_refine

List of boundary ids to refine.

Definition at line 2030 of file parameters.h.

◆ check_for_diamond_cells

template<int dim, int spacedim = dim>
bool Parameters::Mesh< dim, spacedim >::check_for_diamond_cells = false

Enable checking the input grid for diamond-shaped cells.

Definition at line 2042 of file parameters.h.

◆ expand_particle_wall_contact_search

template<int dim, int spacedim = dim>
bool Parameters::Mesh< dim, spacedim >::expand_particle_wall_contact_search = false

Definition at line 2050 of file parameters.h.

◆ file_name

template<int dim, int spacedim = dim>
std::string Parameters::Mesh< dim, spacedim >::file_name = "none"

File name of the mesh.

Definition at line 2014 of file parameters.h.

◆ grid_arguments

template<int dim, int spacedim = dim>
std::string Parameters::Mesh< dim, spacedim >::grid_arguments = "-1 : 1 : false"

Arguments of the GridTools.

Definition at line 2020 of file parameters.h.

◆ grid_type

template<int dim, int spacedim = dim>
std::string Parameters::Mesh< dim, spacedim >::grid_type = "hyper_cube"

Name of the grid in GridTools.

Definition at line 2017 of file parameters.h.

◆ initial_refinement

template<int dim, int spacedim = dim>
unsigned int Parameters::Mesh< dim, spacedim >::initial_refinement = 0

Initial refinement level of primitive mesh.

Definition at line 2023 of file parameters.h.

◆ initial_refinement_at_boundaries

template<int dim, int spacedim = dim>
unsigned int Parameters::Mesh< dim, spacedim >::initial_refinement_at_boundaries = 0

Initial refinement level of primitive mesh near user-defined boundary conditions

Definition at line 2027 of file parameters.h.

◆ refine_until_target_size

template<int dim, int spacedim = dim>
bool Parameters::Mesh< dim, spacedim >::refine_until_target_size = false

Enable fixing initial refinement from a target size.

Definition at line 2033 of file parameters.h.

◆ rotation_angle

template<int dim, int spacedim = dim>
double Parameters::Mesh< dim, spacedim >::rotation_angle = 0.

Definition at line 2061 of file parameters.h.

◆ rotation_axis

template<int dim, int spacedim = dim>
Tensor<1, spacedim> Parameters::Mesh< dim, spacedim >::rotation_axis
Initial value:
= [] {
Tensor<1, spacedim> axis;
axis[0] = 1.;
return axis;
}()

Definition at line 2056 of file parameters.h.

◆ scale

template<int dim, int spacedim = dim>
double Parameters::Mesh< dim, spacedim >::scale = 1.

Rescale the grid by the scale factor.

Definition at line 2064 of file parameters.h.

◆ simplex

template<int dim, int spacedim = dim>
bool Parameters::Mesh< dim, spacedim >::simplex = false

Allow the use of a simplex mesh.

Definition at line 2036 of file parameters.h.

◆ target_size

template<int dim, int spacedim = dim>
double Parameters::Mesh< dim, spacedim >::target_size = 1.

Target size when automatically refining initial mesh.

Definition at line 2039 of file parameters.h.

◆ translation

template<int dim, int spacedim = dim>
Tensor<1, spacedim> Parameters::Mesh< dim, spacedim >::translation

Definition at line 2053 of file parameters.h.

◆ type

template<int dim, int spacedim = dim>
Type Parameters::Mesh< dim, spacedim >::type = Type::dealii

Definition at line 2011 of file parameters.h.


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