ListGrainSizeDistribution Class Reference

#include <ListGrainSizeDistribution.hpp>

Inheritance diagram for ListGrainSizeDistribution:

Public Member Functions
double	amax () const override
double	amin () const override
double	dnda (double a) const override
const vector< double > &	sizeDistributionValues () const
const vector< double > &	sizes () const
virtual double	amax () const =0
virtual double	amin () const =0
virtual double	dnda (double a) const =0
Public Member Functions inherited from SimulationItem
template<class T >
T *	find (bool setup=true) const
template<class T >
T *	interface (int levels=-999999, bool setup=true) const
virtual string	itemName () const
void	setup ()
string	typeAndName () const
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	ListGrainSizeDistribution ()
void	setupSelfBefore () override
Protected Member Functions inherited from GrainSizeDistribution
	GrainSizeDistribution ()
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
virtual void	setupSelfBefore ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = GrainSizeDistribution
using	ItemType = ListGrainSizeDistribution

Private Attributes
Array	_av
Array	_dndav
vector< double >	_sizeDistributionValues
vector< double >	_sizes

Friends
class	ItemRegistry

Detailed Description

ListGrainSizeDistribution represents a grain size distribution that is fully specified inside the configuration file (i.e. without referring to an input file). It is intended for use in cases where there are just a few data points in the size distribution, but nothing keeps the user from specifying a long list. The grain sizes $a$ must listed be in increasing order, and the size distribution values $\text{dnda}\propto \frac{\text{d}{n}_{\text{D}}}{\text{d}a}$ must be specified corresponding to each grain size. Where needed, the tabulated values are interpolated logarithmically on both axes. Outside of the specified grain size range, the number of dust grains is considered to be zero.

Any required normalization can and should be applied externally to this class in the configuration of the grain population (see GrainSizeDistribution and GrainPopulation).

This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

ListGrainSizeDistribution()

ListGrainSizeDistribution::ListGrainSizeDistribution ( )

inlineprotected

Default constructor for concrete Item subclass ListGrainSizeDistribution : "a dust grain size distribution specified inside the configuration file" .

Member Function Documentation

amax()

double ListGrainSizeDistribution::amax ( ) const

overridevirtual

This function returns the maximum grain size $a_{\text{max}}$, i.e. the last grain size in the configured list.

Implements GrainSizeDistribution.

amin()

double ListGrainSizeDistribution::amin ( ) const

overridevirtual

This function returns the minimum grain size $a_{\text{min}}$, i.e. the first grain size in the configured list.

Implements GrainSizeDistribution.

dnda()

double ListGrainSizeDistribution::dnda ( double  a ) const

overridevirtual

This function returns the value of the distribution $\text{dnda}\propto \frac{\text{d}{n}_{\text{D}}}{\text{d}a}$ for a given grain size $a$, log-log interpolated from the configured table. If $a<a_{\text{min}}$ or $a>a_{\text{max}}$ the function returns zero.

Implements GrainSizeDistribution.

setupSelfBefore()

void ListGrainSizeDistribution::setupSelfBefore ( )

overrideprotectedvirtual

This function verifies the number of configured values.

Reimplemented from SimulationItem.

sizeDistributionValues()

ListGrainSizeDistribution::sizeDistributionValues ( ) const

inline

This function returns the value of the discoverable double list property sizeDistributionValues : "the size distribution values at each of the given grain sizes" .

This property represents a physical quantity of type "pergrainsize" .

The minimum value for this property is "]0" .

sizes()

ListGrainSizeDistribution::sizes ( ) const

inline

This function returns the value of the discoverable double list property sizes : "the grain sizes at which to specify the size distribution" .

This property represents a physical quantity of type "grainsize" .

The minimum value for this property is "[1 Angstrom" .

The maximum value for this property is "1 mm]" .

---

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

• ListGrainSizeDistribution.hpp