Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::Lagrangian::BCDEM Struct Reference

#include <parameters_lagrangian.h>

Public Member Functions

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

Static Public Member Functions

static void declare_default_entry (ParameterHandler &prm, const types::boundary_id default_boundary_id)

Public Attributes

unsigned int number_of_dem_boundary_conditions = 0
std::set< types::boundary_id > outlet_boundaries
std::map< types::boundary_id, Tensor< 1, 3 > > boundary_translational_velocity
std::map< types::boundary_id, double > boundary_rotational_speed
std::map< types::boundary_id, Tensor< 1, 3 > > boundary_rotational_vector
std::map< types::boundary_id, Point< 3 > > point_on_rotation_axis
std::map< types::boundary_id, WallThermalBoundaryType > thermal_boundary_type
std::map< types::boundary_id, std::shared_ptr< Function< 3 > > > boundary_temperature
PeriodicBoundaries periodic_boundaries

Static Private Attributes

static constexpr unsigned int max_number_of_dem_boundary_conditions = 10

Detailed Description

Boundary conditions for DEM simulations.

This structure stores the motion parameters, the thermal parameters and the periodic boundary information for each boundary of the DEM domain. A boundary's type is encoded by which container holds it (see outlet_boundaries below); fixed walls are the default and are not stored in any container. For multi-physics simulations, each wall also has a thermal boundary type (adiabatic by default) and, if its temperature is imposed, a temperature function.

Definition at line 811 of file parameters_lagrangian.h.

Member Function Documentation

◆ declare_default_entry()

void Parameters::Lagrangian::BCDEM::declare_default_entry ( ParameterHandler & prm,
const types::boundary_id default_boundary_id )
static

Declare default parameter entries for a single boundary condition.

Parameters
[in,out]prmThe parameter handler object.
[in]default_boundary_idDefault value of the boundary id. This corresponds to the number of the boundary condition subsection.

Definition at line 1547 of file parameters_lagrangian.cc.

References Parameters::Lagrangian::adiabatic, and declare_enum_entry().

◆ declare_parameters()

void Parameters::Lagrangian::BCDEM::declare_parameters ( ParameterHandler & prm) const

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 1499 of file parameters_lagrangian.cc.

References declare_default_entry(), max_number_of_dem_boundary_conditions, and number_of_dem_boundary_conditions.

◆ parse_boundary_conditions()

void Parameters::Lagrangian::BCDEM::parse_boundary_conditions ( ParameterHandler & prm)

◆ parse_parameters()

void Parameters::Lagrangian::BCDEM::parse_parameters ( ParameterHandler & prm)

Parse the parameters from the parameter handler.

Parameters
[in]prmThe parameter handler object.

Definition at line 1525 of file parameters_lagrangian.cc.

References number_of_dem_boundary_conditions, and parse_boundary_conditions().

Member Data Documentation

◆ boundary_rotational_speed

std::map<types::boundary_id, double> Parameters::Lagrangian::BCDEM::boundary_rotational_speed

Rotational speed (rad/s) of each rotational boundary, keyed by the mesh boundary id. Only rotational boundaries have an entry.

Definition at line 831 of file parameters_lagrangian.h.

◆ boundary_rotational_vector

std::map<types::boundary_id, Tensor<1, 3> > Parameters::Lagrangian::BCDEM::boundary_rotational_vector

Rotational axis vector of each rotational boundary, keyed by the mesh boundary id. Only rotational boundaries have an entry.

Definition at line 835 of file parameters_lagrangian.h.

◆ boundary_temperature

std::map<types::boundary_id, std::shared_ptr<Function<3> > > Parameters::Lagrangian::BCDEM::boundary_temperature

Temperature function of each wall with an imposed temperature, keyed by the mesh boundary id. It is evaluated at the particle-wall contact points, so it can vary in space and time.

Definition at line 853 of file parameters_lagrangian.h.

◆ boundary_translational_velocity

std::map<types::boundary_id, Tensor<1, 3> > Parameters::Lagrangian::BCDEM::boundary_translational_velocity

Translational velocity of each translational boundary, keyed by the mesh boundary id. Only translational boundaries have an entry.

Definition at line 827 of file parameters_lagrangian.h.

◆ max_number_of_dem_boundary_conditions

unsigned int Parameters::Lagrangian::BCDEM::max_number_of_dem_boundary_conditions = 10
staticconstexprprivate

Maximum number of boundary condition subsections declared in the parameter handler.

Definition at line 899 of file parameters_lagrangian.h.

◆ number_of_dem_boundary_conditions

unsigned int Parameters::Lagrangian::BCDEM::number_of_dem_boundary_conditions = 0

Number of DEM boundary conditions.

Definition at line 815 of file parameters_lagrangian.h.

◆ outlet_boundaries

std::set<types::boundary_id> Parameters::Lagrangian::BCDEM::outlet_boundaries

Boundary ids designated as outlets. A boundary's DEM boundary condition type is encoded by which container holds it: outlets here, translational/rotational boundaries in the motion maps below, and periodic boundaries in periodic_boundaries. Fixed walls (the default) appear in none of these containers.

Definition at line 822 of file parameters_lagrangian.h.

◆ periodic_boundaries

PeriodicBoundaries Parameters::Lagrangian::BCDEM::periodic_boundaries

Periodic boundary pairs, keyed by the principal periodic boundary id (periodic id 0).

Definition at line 857 of file parameters_lagrangian.h.

◆ point_on_rotation_axis

std::map<types::boundary_id, Point<3> > Parameters::Lagrangian::BCDEM::point_on_rotation_axis

Point on the rotational axis of each rotational boundary, keyed by the mesh boundary id. Only rotational boundaries have an entry.

Definition at line 839 of file parameters_lagrangian.h.

◆ thermal_boundary_type

std::map<types::boundary_id, WallThermalBoundaryType> Parameters::Lagrangian::BCDEM::thermal_boundary_type

Type of thermal boundary condition of each wall, keyed by the mesh boundary id. Only the walls (fixed_wall, translational and rotational boundaries) declared in the DEM boundary conditions have an entry. It is only used in multiphysic DEM. The boundaries without an entry are adiabatic.

Definition at line 847 of file parameters_lagrangian.h.


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