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

#include <parameters_lagrangian.h>

Public Member Functions

void declare_parameters (ParameterHandler &prm) const
void parse_parameters (ParameterHandler &prm)
void parse_particle_properties (const unsigned int &particle_type, const ParameterHandler &prm)

Static Public Member Functions

static void declare_default_entry (ParameterHandler &prm)

Public Attributes

Tensor< 1, 3 > g
unsigned int particle_type_number = 1
std::vector< SizeDistributionType > distribution_type
std::vector< double > particle_average_diameter
std::vector< double > particle_size_std
std::vector< bool > custom_distribution_from_file
std::vector< std::string > custom_distribution_filenames
std::vector< ProbabilityFunctionType > custom_probability_function_type
std::vector< bool > custom_distribution_interpolation
std::vector< std::vector< double > > particle_custom_diameter
std::vector< std::vector< double > > particle_custom_probability
std::vector< DistributionWeightingType > distribution_weighting_type
std::vector< unsigned int > seed_for_distributions
std::vector< double > diameter_min_cutoff
std::vector< double > diameter_max_cutoff
std::vector< int > number
std::vector< double > density_particle
std::vector< double > youngs_modulus_particle
std::vector< double > poisson_ratio_particle
std::vector< double > restitution_coefficient_particle
std::vector< double > friction_coefficient_particle
std::vector< double > rolling_viscous_damping_coefficient_particle
std::vector< double > rolling_friction_coefficient_particle
std::vector< double > surface_energy_particle
std::vector< double > hamaker_constant_particle
std::vector< double > thermal_conductivity_particle
std::vector< double > specific_heat_particle
std::vector< double > microhardness_particle
std::vector< double > surface_slope_particle
std::vector< double > surface_roughness_particle
std::vector< double > thermal_accommodation_particle
std::vector< double > real_youngs_modulus_particle
double youngs_modulus_wall = 1000000.
double poisson_ratio_wall = 0.3
double restitution_coefficient_wall = 0.1
double friction_coefficient_wall = 0.1
double rolling_friction_wall = 0.1
double rolling_viscous_damping_wall = 0.1
double surface_energy_wall = 0.0
double hamaker_constant_wall = 4.e-19
double thermal_conductivity_wall = 100
double microhardness_wall = 1.e9
double surface_slope_wall = 0.1
double surface_roughness_wall = 1.e-10
double thermal_accommodation_wall = 0.7
double real_youngs_modulus_wall = 0.
double thermal_conductivity_gas = 0.01
double specific_heat_gas = 1000
double dynamic_viscosity_gas = 1.e-5
double specific_heats_ratio_gas = 1
double molecular_mean_free_path_gas = 68.e-9

Private Member Functions

void initialize_containers (std::vector< SizeDistributionType > &dist_types, std::vector< double > &p_average_diameter, std::vector< double > &p_size_std, std::vector< bool > &custom_dist_read_from_file, std::vector< std::string > &custom_dist_file_names, std::vector< ProbabilityFunctionType > &custom_function_type, std::vector< bool > &custom_interpolation, std::vector< std::vector< double > > &custom_diameter_values, std::vector< std::vector< double > > &custom_probabilities_values, std::vector< DistributionWeightingType > &distribution_weighting_basis_type, std::vector< unsigned int > &seed_for_dist, std::vector< double > &dia_min_cutoff, std::vector< double > &dia_max_cutoff, std::vector< int > &p_number, std::vector< double > &p_density, std::vector< double > &p_youngs_modulus, std::vector< double > &p_poisson_ratio, std::vector< double > &p_restitution_coefficient, std::vector< double > &p_friction_coefficient, std::vector< double > &p_rolling_viscous_damping_coefficient, std::vector< double > &p_rolling_friction_coefficient, std::vector< double > &p_surface_energy, std::vector< double > &p_hamaker_constant, std::vector< double > &p_thermal_conductivity, std::vector< double > &p_specific_heat, std::vector< double > &p_microhardness, std::vector< double > &p_surface_slope, std::vector< double > &p_surface_roughness, std::vector< double > &p_thermal_accommodation, std::vector< double > &p_real_youngs_modulus) const

Private Attributes

unsigned int particle_type_maximum_number = 5

Detailed Description

Physical properties of particles, walls, and interstitial gas for Lagrangian (DEM) simulations.

This structure stores all material properties needed for contact force computations, including per-particle-type mechanical and thermal properties, wall properties, and interstitial gas properties.

Definition at line 131 of file parameters_lagrangian.h.

Member Function Documentation

◆ declare_default_entry()

void Parameters::Lagrangian::LagrangianPhysicalProperties::declare_default_entry ( ParameterHandler & prm)
static

Declare default parameter entries for a single particle type.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 277 of file parameters_lagrangian.cc.

References declare_enum_entry(), Parameters::Lagrangian::number_based, Parameters::Lagrangian::PDF, and Parameters::Lagrangian::uniform.

◆ declare_parameters()

◆ initialize_containers()

void Parameters::Lagrangian::LagrangianPhysicalProperties::initialize_containers ( std::vector< SizeDistributionType > & dist_types,
std::vector< double > & p_average_diameter,
std::vector< double > & p_size_std,
std::vector< bool > & custom_dist_read_from_file,
std::vector< std::string > & custom_dist_file_names,
std::vector< ProbabilityFunctionType > & custom_function_type,
std::vector< bool > & custom_interpolation,
std::vector< std::vector< double > > & custom_diameter_values,
std::vector< std::vector< double > > & custom_probabilities_values,
std::vector< DistributionWeightingType > & distribution_weighting_basis_type,
std::vector< unsigned int > & seed_for_dist,
std::vector< double > & dia_min_cutoff,
std::vector< double > & dia_max_cutoff,
std::vector< int > & p_number,
std::vector< double > & p_density,
std::vector< double > & p_youngs_modulus,
std::vector< double > & p_poisson_ratio,
std::vector< double > & p_restitution_coefficient,
std::vector< double > & p_friction_coefficient,
std::vector< double > & p_rolling_viscous_damping_coefficient,
std::vector< double > & p_rolling_friction_coefficient,
std::vector< double > & p_surface_energy,
std::vector< double > & p_hamaker_constant,
std::vector< double > & p_thermal_conductivity,
std::vector< double > & p_specific_heat,
std::vector< double > & p_microhardness,
std::vector< double > & p_surface_slope,
std::vector< double > & p_surface_roughness,
std::vector< double > & p_thermal_accommodation,
std::vector< double > & p_real_youngs_modulus ) const
private

initialize_containers - Initialize the containers used to store the particle size distribution and physical properties of each particle type.

Parameters
[in,out]dist_typesIndicates the SizeDistributionType type.
[in,out]p_average_diameterAverage diameter.
[in,out]p_size_stdDiameter standard deviation for the normal and lognormal distributions.
[in,out]custom_dist_read_from_fileIndicates whether the diameter and probability values are stored in a separate file.
[in,out]custom_dist_file_namesVector of filenames from which the custom distributions are read.
[in,out]custom_function_typeIndicates whether the values defining the custom distribution correspond to the PDF or the CDF.
[in,out]custom_interpolationIndicates whether the diameter values are interpolated from the input values.
[in,out]custom_diameter_valuesLists of diameters for the custom distribution.
[in,out]custom_probabilities_valuesLists of probability values corresponding to each diameter value in the custom distribution.
[in,out]distribution_weighting_basis_typeWeighting basis for the PSD.
[in,out]seed_for_distPseudo random seed for the PSD sampling.
[in,out]dia_min_cutoffMinimal cutoff value when sampling a PSD.
[in,out]dia_max_cutoffMaximal cutoff value when sampling a PSD.
[in,out]p_numberNumber of particles.
[in,out]p_densityDensity.
[in,out]p_youngs_modulusYoung's modulus.
[in,out]p_poisson_ratioPoisson's ratio.
[in,out]p_restitution_coefficientCoefficient of restitution.
[in,out]p_friction_coefficientSliding friction coefficient.
[in,out]p_rolling_viscous_damping_coefficientRolling viscous damping coefficient
[in,out]p_rolling_friction_coefficientRolling friction coefficient.
[in,out]p_surface_energySurface energy.
[in,out]p_hamaker_constantHamaker constant.
[in,out]p_thermal_conductivityThermal conductivity.
[in,out]p_specific_heatSpecific heat.
[in,out]p_microhardnessMicrohardness.
[in,out]p_surface_slopeSurface slope.
[in,out]p_surface_roughnessSurface roughness.
[in,out]p_thermal_accommodationThermal accommodation coefficient.
[in,out]p_real_youngs_modulusReal Young's modulus.

Definition at line 522 of file parameters_lagrangian.cc.

References particle_type_maximum_number.

◆ parse_parameters()

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

Parse the parameters from the parameter handler.

Parameters
[in]prmThe parameter handler object.

Definition at line 190 of file parameters_lagrangian.cc.

References custom_distribution_filenames, custom_distribution_from_file, custom_distribution_interpolation, custom_probability_function_type, density_particle, diameter_max_cutoff, diameter_min_cutoff, distribution_type, distribution_weighting_type, dynamic_viscosity_gas, friction_coefficient_particle, friction_coefficient_wall, g, hamaker_constant_particle, hamaker_constant_wall, initialize_containers(), microhardness_particle, microhardness_wall, molecular_mean_free_path_gas, number, parse_particle_properties(), particle_average_diameter, particle_custom_diameter, particle_custom_probability, particle_size_std, particle_type_number, poisson_ratio_particle, poisson_ratio_wall, real_youngs_modulus_particle, real_youngs_modulus_wall, restitution_coefficient_particle, restitution_coefficient_wall, rolling_friction_coefficient_particle, rolling_friction_wall, rolling_viscous_damping_coefficient_particle, rolling_viscous_damping_wall, seed_for_distributions, specific_heat_gas, specific_heat_particle, specific_heats_ratio_gas, surface_energy_particle, surface_energy_wall, surface_roughness_particle, surface_roughness_wall, surface_slope_particle, surface_slope_wall, thermal_accommodation_particle, thermal_accommodation_wall, thermal_conductivity_gas, thermal_conductivity_particle, thermal_conductivity_wall, youngs_modulus_particle, and youngs_modulus_wall.

◆ parse_particle_properties()

Member Data Documentation

◆ custom_distribution_filenames

std::vector<std::string> Parameters::Lagrangian::LagrangianPhysicalProperties::custom_distribution_filenames

Filename for the custom distribution for each particle type.

Definition at line 154 of file parameters_lagrangian.h.

◆ custom_distribution_from_file

std::vector<bool> Parameters::Lagrangian::LagrangianPhysicalProperties::custom_distribution_from_file

Indicate if the custom distribution is read from file.

Definition at line 151 of file parameters_lagrangian.h.

◆ custom_distribution_interpolation

std::vector<bool> Parameters::Lagrangian::LagrangianPhysicalProperties::custom_distribution_interpolation

Indicates whether the diameter values generated from the custom distribution are interpolated

Definition at line 161 of file parameters_lagrangian.h.

◆ custom_probability_function_type

std::vector<ProbabilityFunctionType> Parameters::Lagrangian::LagrangianPhysicalProperties::custom_probability_function_type

Custom distribution function type (PDF or CDF).

Definition at line 157 of file parameters_lagrangian.h.

◆ density_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::density_particle

Density of each particle type.

Definition at line 187 of file parameters_lagrangian.h.

◆ diameter_max_cutoff

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::diameter_max_cutoff

Maximum diameter cutoff for lognormal distribution.

Definition at line 181 of file parameters_lagrangian.h.

◆ diameter_min_cutoff

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::diameter_min_cutoff

Minimum diameter cutoff for lognormal distribution.

Definition at line 178 of file parameters_lagrangian.h.

◆ distribution_type

std::vector<SizeDistributionType> Parameters::Lagrangian::LagrangianPhysicalProperties::distribution_type

Definition at line 142 of file parameters_lagrangian.h.

◆ distribution_weighting_type

std::vector<DistributionWeightingType> Parameters::Lagrangian::LagrangianPhysicalProperties::distribution_weighting_type

Distribution weighting type of each particle type (number-based, volume-based)

Definition at line 172 of file parameters_lagrangian.h.

◆ dynamic_viscosity_gas

double Parameters::Lagrangian::LagrangianPhysicalProperties::dynamic_viscosity_gas = 1.e-5

Dynamic viscosity of the interstitial gas.

Definition at line 283 of file parameters_lagrangian.h.

◆ friction_coefficient_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::friction_coefficient_particle

Friction coefficient of each particle type.

Definition at line 199 of file parameters_lagrangian.h.

◆ friction_coefficient_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::friction_coefficient_wall = 0.1

Friction coefficient of the wall.

Definition at line 244 of file parameters_lagrangian.h.

◆ g

Tensor<1, 3> Parameters::Lagrangian::LagrangianPhysicalProperties::g

Gravitational acceleration vector.

Definition at line 135 of file parameters_lagrangian.h.

◆ hamaker_constant_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::hamaker_constant_particle

Hamaker constant of each particle type.

Definition at line 211 of file parameters_lagrangian.h.

◆ hamaker_constant_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::hamaker_constant_wall = 4.e-19

Hamaker constant of the wall.

Definition at line 256 of file parameters_lagrangian.h.

◆ microhardness_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::microhardness_particle

Microhardness of each particle type.

Definition at line 220 of file parameters_lagrangian.h.

◆ microhardness_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::microhardness_wall = 1.e9

Microhardness of the wall.

Definition at line 262 of file parameters_lagrangian.h.

◆ molecular_mean_free_path_gas

double Parameters::Lagrangian::LagrangianPhysicalProperties::molecular_mean_free_path_gas = 68.e-9

Molecular mean free path of the interstitial gas.

Definition at line 289 of file parameters_lagrangian.h.

◆ number

std::vector<int> Parameters::Lagrangian::LagrangianPhysicalProperties::number

Number particles of each particle type.

Definition at line 184 of file parameters_lagrangian.h.

◆ particle_average_diameter

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::particle_average_diameter

Average diameter of each particle type.

Definition at line 145 of file parameters_lagrangian.h.

◆ particle_custom_diameter

std::vector<std::vector<double> > Parameters::Lagrangian::LagrangianPhysicalProperties::particle_custom_diameter

List of diameters for the custom distribution for each particle type.

Definition at line 164 of file parameters_lagrangian.h.

◆ particle_custom_probability

std::vector<std::vector<double> > Parameters::Lagrangian::LagrangianPhysicalProperties::particle_custom_probability

Probability of each diameter value based on volume fraction for the custom distribution for each particle type

Definition at line 168 of file parameters_lagrangian.h.

◆ particle_size_std

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::particle_size_std

Size standard deviation of each particle type.

Definition at line 148 of file parameters_lagrangian.h.

◆ particle_type_maximum_number

unsigned int Parameters::Lagrangian::LagrangianPhysicalProperties::particle_type_maximum_number = 5
private

Definition at line 326 of file parameters_lagrangian.h.

◆ particle_type_number

unsigned int Parameters::Lagrangian::LagrangianPhysicalProperties::particle_type_number = 1

Number of particle types.

Definition at line 138 of file parameters_lagrangian.h.

◆ poisson_ratio_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::poisson_ratio_particle

Poisson's ratio of each particle type.

Definition at line 193 of file parameters_lagrangian.h.

◆ poisson_ratio_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::poisson_ratio_wall = 0.3

Poisson's ratio of the wall.

Definition at line 238 of file parameters_lagrangian.h.

◆ real_youngs_modulus_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::real_youngs_modulus_particle

Real Young's modulus of each particle type.

Definition at line 232 of file parameters_lagrangian.h.

◆ real_youngs_modulus_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::real_youngs_modulus_wall = 0.

Real Young's modulus of the wall.

Definition at line 274 of file parameters_lagrangian.h.

◆ restitution_coefficient_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::restitution_coefficient_particle

Coefficients of restitution of each particle type.

Definition at line 196 of file parameters_lagrangian.h.

◆ restitution_coefficient_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::restitution_coefficient_wall = 0.1

Coefficient of restitution of the wall.

Definition at line 241 of file parameters_lagrangian.h.

◆ rolling_friction_coefficient_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::rolling_friction_coefficient_particle

Rolling friction coefficient of each particle type.

Definition at line 205 of file parameters_lagrangian.h.

◆ rolling_friction_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::rolling_friction_wall = 0.1

Rolling friction coefficient of the wall.

Definition at line 247 of file parameters_lagrangian.h.

◆ rolling_viscous_damping_coefficient_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::rolling_viscous_damping_coefficient_particle

Rolling viscous damping coefficient of each particle type.

Definition at line 202 of file parameters_lagrangian.h.

◆ rolling_viscous_damping_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::rolling_viscous_damping_wall = 0.1

Rolling viscous damping coefficient of the wall.

Definition at line 250 of file parameters_lagrangian.h.

◆ seed_for_distributions

std::vector<unsigned int> Parameters::Lagrangian::LagrangianPhysicalProperties::seed_for_distributions

Random seed for the size distribution.

Definition at line 175 of file parameters_lagrangian.h.

◆ specific_heat_gas

double Parameters::Lagrangian::LagrangianPhysicalProperties::specific_heat_gas = 1000

Specific heat of the interstitial gas.

Definition at line 280 of file parameters_lagrangian.h.

◆ specific_heat_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::specific_heat_particle

Specific heat of each particle type.

Definition at line 217 of file parameters_lagrangian.h.

◆ specific_heats_ratio_gas

double Parameters::Lagrangian::LagrangianPhysicalProperties::specific_heats_ratio_gas = 1

Specific heats ratio of the interstitial gas.

Definition at line 286 of file parameters_lagrangian.h.

◆ surface_energy_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::surface_energy_particle

Surface energy of each particle type.

Definition at line 208 of file parameters_lagrangian.h.

◆ surface_energy_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::surface_energy_wall = 0.0

Surface energy of the wall.

Definition at line 253 of file parameters_lagrangian.h.

◆ surface_roughness_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::surface_roughness_particle

Surface roughness of each particle type.

Definition at line 226 of file parameters_lagrangian.h.

◆ surface_roughness_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::surface_roughness_wall = 1.e-10

Surface roughness of the wall.

Definition at line 268 of file parameters_lagrangian.h.

◆ surface_slope_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::surface_slope_particle

Surface slope of each particle type.

Definition at line 223 of file parameters_lagrangian.h.

◆ surface_slope_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::surface_slope_wall = 0.1

Surface slope of the wall.

Definition at line 265 of file parameters_lagrangian.h.

◆ thermal_accommodation_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::thermal_accommodation_particle

Thermal accommodation coefficient of each particle type.

Definition at line 229 of file parameters_lagrangian.h.

◆ thermal_accommodation_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::thermal_accommodation_wall = 0.7

Thermal accommodation coefficient of the wall.

Definition at line 271 of file parameters_lagrangian.h.

◆ thermal_conductivity_gas

double Parameters::Lagrangian::LagrangianPhysicalProperties::thermal_conductivity_gas = 0.01

Thermal conductivity of the interstitial gas.

Definition at line 277 of file parameters_lagrangian.h.

◆ thermal_conductivity_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::thermal_conductivity_particle

Thermal conductivity of each particle type.

Definition at line 214 of file parameters_lagrangian.h.

◆ thermal_conductivity_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::thermal_conductivity_wall = 100

Thermal conductivity of the wall.

Definition at line 259 of file parameters_lagrangian.h.

◆ youngs_modulus_particle

std::vector<double> Parameters::Lagrangian::LagrangianPhysicalProperties::youngs_modulus_particle

Young's modulus of each particle type.

Definition at line 190 of file parameters_lagrangian.h.

◆ youngs_modulus_wall

double Parameters::Lagrangian::LagrangianPhysicalProperties::youngs_modulus_wall = 1000000.

Young's modulus of the wall.

Definition at line 235 of file parameters_lagrangian.h.


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