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

#include <parameters_lagrangian.h>

Public Types

enum class  MotionType { translational , rotational , none }

Public Member Functions

void parse_parameters (ParameterHandler &prm)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

enum Parameters::Lagrangian::GridMotion::MotionType motion_type = MotionType::none
Tensor< 1, dim > grid_translational_velocity
double grid_rotational_speed = 0
unsigned int grid_rotational_axis = 0

Detailed Description

template<int dim>
class Parameters::Lagrangian::GridMotion< dim >

Parameters for grid (mesh) motion in DEM simulations.

This class defines the type and parameters of the grid motion, which can be translational, rotational or none.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 911 of file parameters_lagrangian.h.

Member Enumeration Documentation

◆ MotionType

template<int dim>
enum class Parameters::Lagrangian::GridMotion::MotionType
strong

Type of grid motion.

Enumerator
translational 

Translating grid at the velocity GridMotion::grid_translational_velocity.

rotational 

Rotating grid at the speed GridMotion::grid_rotational_speed around the GridMotion::grid_rotational_axis.

none 

Static grid.

Definition at line 917 of file parameters_lagrangian.h.

Member Function Documentation

◆ declare_parameters()

template<int dim>
void Parameters::Lagrangian::GridMotion< dim >::declare_parameters ( ParameterHandler & prm)
static

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 1732 of file parameters_lagrangian.cc.

References declare_enum_entry(), grid_rotational_axis, grid_rotational_speed, grid_translational_velocity, and motion_type.

◆ parse_parameters()

template<int dim>
void Parameters::Lagrangian::GridMotion< dim >::parse_parameters ( ParameterHandler & prm)

Parse the parameters from the parameter handler.

Parameters
[in]prmThe parameter handler object.

Definition at line 1777 of file parameters_lagrangian.cc.

References grid_rotational_axis, grid_rotational_speed, grid_translational_velocity, motion_type, and string_to_enum().

Member Data Documentation

◆ grid_rotational_axis

template<int dim>
unsigned int Parameters::Lagrangian::GridMotion< dim >::grid_rotational_axis = 0

Rotational axis of the rotating grid (0=x, 1=y, 2=z).

Definition at line 936 of file parameters_lagrangian.h.

◆ grid_rotational_speed

template<int dim>
double Parameters::Lagrangian::GridMotion< dim >::grid_rotational_speed = 0

Rotational speed of the rotating grid (rad/s).

Definition at line 933 of file parameters_lagrangian.h.

◆ grid_translational_velocity

template<int dim>
Tensor<1, dim> Parameters::Lagrangian::GridMotion< dim >::grid_translational_velocity

Translational velocity of the moving grid.

Definition at line 930 of file parameters_lagrangian.h.

◆ motion_type

Type of grid motion.


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