Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Distribution Class Referenceabstract

#include <distributions.h>

Inheritance diagram for Distribution:
[legend]

Public Member Functions

virtual ~Distribution ()=default
virtual std::vector< double > particle_size_sampling (const unsigned int &number_of_particles)=0
virtual double find_min_diameter ()=0
virtual double find_max_diameter ()=0
virtual void print_psd_declaration_string (const unsigned int particle_type, const ConditionalOStream &pcout)=0

Protected Member Functions

 Distribution (const Parameters::Lagrangian::DistributionWeightingType &distribution_weighting_type)

Protected Attributes

const Parameters::Lagrangian::DistributionWeightingType weighting_type
double dia_min_cutoff
double dia_max_cutoff

Detailed Description

Definition at line 11 of file distributions.h.

Constructor & Destructor Documentation

◆ Distribution()

Distribution::Distribution ( const Parameters::Lagrangian::DistributionWeightingType & distribution_weighting_type)
protected

Definition at line 12 of file distributions.cc.

References dia_max_cutoff, dia_min_cutoff, and weighting_type.

◆ ~Distribution()

virtual Distribution::~Distribution ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ find_max_diameter()

virtual double Distribution::find_max_diameter ( )
pure virtual

Return the maximum diameter for a certain distribution.

Returns
The maximum diameter of a certain distribution.

Implemented in CustomDistribution, LogNormalDistribution, NormalDistribution, and UniformDistribution.

◆ find_min_diameter()

virtual double Distribution::find_min_diameter ( )
pure virtual

Return the minimum diameter for a certain distribution.

Returns
The minimum diameter of a certain distribution.

Implemented in CustomDistribution, LogNormalDistribution, NormalDistribution, and UniformDistribution.

◆ particle_size_sampling()

virtual std::vector< double > Distribution::particle_size_sampling ( const unsigned int & number_of_particles)
pure virtual

Carries out the size sampling of particles. This is the base class of NormalDistribution, UniformDistribution and CustomDistribution classes.

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

Implemented in CustomDistribution, LogNormalDistribution, NormalDistribution, and UniformDistribution.

◆ print_psd_declaration_string()

virtual void Distribution::print_psd_declaration_string ( const unsigned int particle_type,
const ConditionalOStream & pcout )
pure virtual

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

Implemented in CustomDistribution, LogNormalDistribution, NormalDistribution, and UniformDistribution.

Member Data Documentation

◆ dia_max_cutoff

double Distribution::dia_max_cutoff
protected

Maximum cutoff diameters values.

Definition at line 27 of file distributions.h.

◆ dia_min_cutoff

double Distribution::dia_min_cutoff
protected

Minimal cutoff diameters values.

Definition at line 22 of file distributions.h.

◆ weighting_type

const Parameters::Lagrangian::DistributionWeightingType Distribution::weighting_type
protected

Definition at line 14 of file distributions.h.


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