Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
UniformDistribution Class Reference

#include <distributions.h>

Inheritance diagram for UniformDistribution:
[legend]

Public Member Functions

 UniformDistribution (const double &d_values)
virtual std::vector< double > particle_size_sampling (const unsigned int &number_of_particles) override
double find_min_diameter () override
double find_max_diameter () override
void print_psd_declaration_string (const unsigned int particle_type, const ConditionalOStream &pcout) override
Public Member Functions inherited from Distribution
virtual ~Distribution ()=default

Private Attributes

const double diameter_value

Additional Inherited Members

Protected Member Functions inherited from Distribution
 Distribution (const Parameters::Lagrangian::DistributionWeightingType &distribution_weighting_type)
Protected Attributes inherited from Distribution
const Parameters::Lagrangian::DistributionWeightingType weighting_type
double dia_min_cutoff
double dia_max_cutoff

Detailed Description

Definition at line 231 of file distributions.h.

Constructor & Destructor Documentation

◆ UniformDistribution()

UniformDistribution::UniformDistribution ( const double & d_values)

The constructor stores the parameters necessary to define the uniform distribution.

Parameters
d_valuesDiameter values for each particle type.

Definition at line 348 of file distributions.cc.

References diameter_value, and Distribution::Distribution().

Member Function Documentation

◆ find_max_diameter()

double UniformDistribution::find_max_diameter ( )
overridevirtual

Find the maximum diameter of the uniform distribution.

Returns
The diameter of the distribution.

Implements Distribution.

Definition at line 374 of file distributions.cc.

References diameter_value.

◆ find_min_diameter()

double UniformDistribution::find_min_diameter ( )
overridevirtual

Find the minimum diameter of the uniform distribution.

Returns
The diameter of the distribution.

Implements Distribution.

Definition at line 368 of file distributions.cc.

References diameter_value.

◆ particle_size_sampling()

std::vector< double > UniformDistribution::particle_size_sampling ( const unsigned int & number_of_particles)
overridevirtual

Carries out the size sampling of every particle inserted at an insertion time step for the uniform distribution.

Parameters
[in]number_of_particlesNumber of particles inserted at a given insertion time step.

Implements Distribution.

Definition at line 355 of file distributions.cc.

◆ print_psd_declaration_string()

void UniformDistribution::print_psd_declaration_string ( const unsigned int particle_type,
const ConditionalOStream & pcout )
overridevirtual

Print the declaration string relative to the particle size distribution used.

Parameters
particle_typeParticle type of the distribution
pcoutParallel conditional output stream used to print the information

Implements Distribution.

Definition at line 380 of file distributions.cc.

Member Data Documentation

◆ diameter_value

const double UniformDistribution::diameter_value
private

The diameter value of the distribution.

Definition at line 285 of file distributions.h.


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