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

#include <parameters_cfd_dem.h>

Public Member Functions

 VoidFractionParameters ()
virtual ~VoidFractionParameters ()=default
virtual void declare_parameters (ParameterHandler &prm)
virtual void parse_parameters (ParameterHandler &prm)

Public Attributes

VoidFractionMode mode = VoidFractionMode::function
Functions::ParsedFunction< dim > void_fraction
bool read_dem = false
std::string dem_file_name = "dem"
double l2_smoothing_length = 0.001
unsigned int particle_refinement_factor = 0
double qcm_smoothing_length = 0
bool qcm_sphere_equal_cell_volume = false
QCMFilterType qcm_filter_type = QCMFilterType::spherical
VoidFractionQuadratureRule quadrature_rule
unsigned int n_quadrature_points = 0
bool project_particle_velocity = false
bool output_qcm = false

Detailed Description

template<int dim>
class Parameters::VoidFractionParameters< dim >

Parameters controlling the void fraction computation in CFD-DEM simulations.

This class stores the method, quadrature settings, and auxiliary parameters used to compute the void fraction field from the particle distribution.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 160 of file parameters_cfd_dem.h.

Constructor & Destructor Documentation

◆ VoidFractionParameters()

template<int dim>
Parameters::VoidFractionParameters< dim >::VoidFractionParameters ( )
inline

Definition at line 163 of file parameters_cfd_dem.h.

References void_fraction.

◆ ~VoidFractionParameters()

template<int dim>
virtual Parameters::VoidFractionParameters< dim >::~VoidFractionParameters ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ declare_parameters()

template<int dim>
void Parameters::VoidFractionParameters< dim >::declare_parameters ( ParameterHandler & prm)
virtual

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 37 of file parameters_cfd_dem.cc.

References declare_enum_entry(), dem_file_name, l2_smoothing_length, mode, n_quadrature_points, output_qcm, particle_refinement_factor, project_particle_velocity, qcm_filter_type, qcm_smoothing_length, qcm_sphere_equal_cell_volume, quadrature_rule, read_dem, and void_fraction.

◆ parse_parameters()

template<int dim>
void Parameters::VoidFractionParameters< dim >::parse_parameters ( ParameterHandler & prm)
virtual

Member Data Documentation

◆ dem_file_name

template<int dim>
std::string Parameters::VoidFractionParameters< dim >::dem_file_name = "dem"

File name of the DEM simulation checkpoint.

Definition at line 199 of file parameters_cfd_dem.h.

◆ l2_smoothing_length

template<int dim>
double Parameters::VoidFractionParameters< dim >::l2_smoothing_length = 0.001

Smoothing length for L2 projection of the void fraction.

Definition at line 202 of file parameters_cfd_dem.h.

◆ mode

Void fraction computation method.

Definition at line 190 of file parameters_cfd_dem.h.

◆ n_quadrature_points

template<int dim>
unsigned int Parameters::VoidFractionParameters< dim >::n_quadrature_points = 0

Number of quadrature points per cell used for void fraction integration.

Definition at line 228 of file parameters_cfd_dem.h.

◆ output_qcm

template<int dim>
bool Parameters::VoidFractionParameters< dim >::output_qcm = false

Output QCM quadrature points and filter characteristics.

Definition at line 234 of file parameters_cfd_dem.h.

◆ particle_refinement_factor

template<int dim>
unsigned int Parameters::VoidFractionParameters< dim >::particle_refinement_factor = 0

Refinement factor applied to the particle radius for void fraction.

Definition at line 205 of file parameters_cfd_dem.h.

◆ project_particle_velocity

template<int dim>
bool Parameters::VoidFractionParameters< dim >::project_particle_velocity = false

Project particle velocity onto the fluid mesh.

Definition at line 231 of file parameters_cfd_dem.h.

◆ qcm_filter_type

template<int dim>
QCMFilterType Parameters::VoidFractionParameters< dim >::qcm_filter_type = QCMFilterType::spherical

Filter kernel used by the QCM to weigh particle contributions onto the mesh. The characteristic length of the filter is taken from qcm_smoothing_length (and qcm_sphere_equal_cell_volume when no length is set). For spherical, the length is the averaging-sphere radius. For gaussian, the length is the standard deviation sigma.

Definition at line 221 of file parameters_cfd_dem.h.

◆ qcm_smoothing_length

template<int dim>
double Parameters::VoidFractionParameters< dim >::qcm_smoothing_length = 0

Smoothing length used in the quadrature centered method. For the spherical filter, half of this value is the averaging-sphere radius; for the gaussian filter, half of this value is the standard deviation sigma.

Definition at line 211 of file parameters_cfd_dem.h.

◆ qcm_sphere_equal_cell_volume

template<int dim>
bool Parameters::VoidFractionParameters< dim >::qcm_sphere_equal_cell_volume = false

Use a sphere volume equal to the cell volume in QCM.

Definition at line 214 of file parameters_cfd_dem.h.

◆ quadrature_rule

template<int dim>
VoidFractionQuadratureRule Parameters::VoidFractionParameters< dim >::quadrature_rule
Initial value:

Quadrature rule used for void fraction integration.

Definition at line 224 of file parameters_cfd_dem.h.

◆ read_dem

template<int dim>
bool Parameters::VoidFractionParameters< dim >::read_dem = false

Read particle data from a DEM simulation checkpoint.

Definition at line 196 of file parameters_cfd_dem.h.

◆ void_fraction

template<int dim>
Functions::ParsedFunction<dim> Parameters::VoidFractionParameters< dim >::void_fraction

Analytical void fraction function (used when mode is function).

Definition at line 193 of file parameters_cfd_dem.h.


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