#include <LogNormalGrainSizeDistribution.hpp>

Inheritance diagram for LogNormalGrainSizeDistribution:

[legend]

Public Member Functions
	LogNormalGrainSizeDistribution (SimulationItem *parent, double minSize, double maxSize, double centroid, double width)

double	centroid () const

double	dnda (double a) const override

double	width () const

Public Member Functions inherited from RangeGrainSizeDistribution
double	amax () const override

double	amin () const override

double	maxSize () const

double	minSize () 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
	LogNormalGrainSizeDistribution ()

Protected Member Functions inherited from RangeGrainSizeDistribution
	RangeGrainSizeDistribution ()

	RangeGrainSizeDistribution (double minSize, double maxSize)

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 = RangeGrainSizeDistribution

using	ItemType = LogNormalGrainSizeDistribution

Private Attributes
double	_centroid

double	_width

Friends
class	ItemRegistry

Detailed Description

LogNormalGrainSizeDistribution is a GrainSizeDistribution subclass that represents a log-normal dust grain size distribution of the form

\[ \frac{\text{d}n_\text{D}}{\text{d}a} \propto \frac{1}{a} \,\exp\left[ - \frac{(\ln(a/a_0))^2}{2\sigma^2} \right] \qquad \text{for}\quad a_\text{min} \leq a \leq a_\text{max}. \]

The size range of the distribution can be configured in the RangeGrainSizeDistribution base class. The remaining two parameters, the centroid \(a_0\) and the width \(\sigma\), can be configured as attributes in this class. The function is scaled arbitrarily.

The functional form for the grain size distribution implemented by this class is inspired by the DustEM code, which is described in Compiègne et al. 2011 (AA, 525, A103) and can be downloaded from http://www.ias.u-psud.fr/DUSTEM/.

Constructor & Destructor Documentation

◆ LogNormalGrainSizeDistribution() [1/2]

LogNormalGrainSizeDistribution::LogNormalGrainSizeDistribution ( )

inlineprotected

Default constructor for concrete Item subclass LogNormalGrainSizeDistribution : "a log-normal dust grain size distribution" .

◆ LogNormalGrainSizeDistribution() [2/2]

LogNormalGrainSizeDistribution::LogNormalGrainSizeDistribution	(	SimulationItem *	parent,
		double	minSize,
		double	maxSize,
		double	centroid,
		double	width
	)

explicit

This constructor can be invoked by classes that wish to hard-code the creation of a new grain size distribution object of this type (as opposed to creation through the ski file). Before the constructor returns, the newly created object is hooked up as a child to the specified parent in the simulation hierarchy (so it will automatically be deleted), its properties have been initialized to the specified values, and its setup() function has been called.

Member Function Documentation

◆ centroid()

LogNormalGrainSizeDistribution::centroid ( ) const

inline

This function returns the value of the discoverable double property centroid : "the centroid a0 of the log-normal law" .

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

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

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

The default value for this property is given by the conditional value expression "1 nm" .

◆ dnda()

double LogNormalGrainSizeDistribution::dnda ( double a ) const

overridevirtual

This function returns the value of \(\frac{\text{d}n_\text{D}}{\text{d}a}\) as described in the header for this class (with an arbitrary proportionality factor of one).

Implements GrainSizeDistribution.

Reimplemented in ModifiedLogNormalGrainSizeDistribution.

◆ width()

LogNormalGrainSizeDistribution::width ( ) const

inline

This function returns the value of the discoverable double property width : "the width σ of the log-normal law" .

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

The maximum value for this property is "5]" .

The default value for this property is given by the conditional value expression "0.4" .

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

LogNormalGrainSizeDistribution.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends