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

#include <parameters_lagrangian.h>

Public Member Functions

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

Static Public Member Functions

static void declare_default_entry (ParameterHandler &prm)

Public Attributes

unsigned int floating_walls_number = 0
std::vector< Point< dim > > points_on_walls
std::vector< Tensor< 1, dim > > floating_walls_normal_vectors
std::vector< double > time_start
std::vector< double > time_end

Private Attributes

unsigned int max_number_floating_walls = 9

Detailed Description

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

Parameters for floating walls in DEM simulations.

Floating walls are planar boundaries that can be activated and deactivated at specified times during the simulation. Each wall is defined by a point on its surface and a normal vector.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 734 of file parameters_lagrangian.h.

Member Function Documentation

◆ declare_default_entry()

template<int dim>
void Parameters::Lagrangian::FloatingWalls< dim >::declare_default_entry ( ParameterHandler & prm)
static

Declare default parameter entries for a single floating wall.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 1444 of file parameters_lagrangian.cc.

◆ declare_parameters()

template<int dim>
void Parameters::Lagrangian::FloatingWalls< dim >::declare_parameters ( ParameterHandler & prm) const

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 1326 of file parameters_lagrangian.cc.

References declare_default_entry(), floating_walls_number, and max_number_floating_walls.

◆ parse_floating_wall()

template<int dim>
void Parameters::Lagrangian::FloatingWalls< dim >::parse_floating_wall ( const ParameterHandler & prm)

Parse parameters for a single floating wall.

Parameters
[in]prmThe parameter handler object.

Definition at line 1480 of file parameters_lagrangian.cc.

References floating_walls_normal_vectors, points_on_walls, time_end, time_start, and value_string_to_tensor().

◆ parse_parameters()

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

Parse the parameters from the parameter handler.

Parameters
[in]prmThe parameter handler object.

Definition at line 1352 of file parameters_lagrangian.cc.

References floating_walls_number, and parse_floating_wall().

Member Data Documentation

◆ floating_walls_normal_vectors

template<int dim>
std::vector<Tensor<1, dim> > Parameters::Lagrangian::FloatingWalls< dim >::floating_walls_normal_vectors

Outward normal vector of each floating wall.

Definition at line 744 of file parameters_lagrangian.h.

◆ floating_walls_number

template<int dim>
unsigned int Parameters::Lagrangian::FloatingWalls< dim >::floating_walls_number = 0

Number of floating walls.

Definition at line 738 of file parameters_lagrangian.h.

◆ max_number_floating_walls

template<int dim>
unsigned int Parameters::Lagrangian::FloatingWalls< dim >::max_number_floating_walls = 9
private

Definition at line 785 of file parameters_lagrangian.h.

◆ points_on_walls

template<int dim>
std::vector<Point<dim> > Parameters::Lagrangian::FloatingWalls< dim >::points_on_walls

A point on each floating wall surface.

Definition at line 741 of file parameters_lagrangian.h.

◆ time_end

template<int dim>
std::vector<double> Parameters::Lagrangian::FloatingWalls< dim >::time_end

Deactivation time of each floating wall.

Definition at line 750 of file parameters_lagrangian.h.

◆ time_start

template<int dim>
std::vector<double> Parameters::Lagrangian::FloatingWalls< dim >::time_start

Activation time of each floating wall.

Definition at line 747 of file parameters_lagrangian.h.


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