SingleGrainSizeDistribution Class Reference

#include <SingleGrainSizeDistribution.hpp>

Inheritance diagram for SingleGrainSizeDistribution:

Public Member Functions
double	amax () const override
double	amin () const override
double	dnda (double a) const override
double	size () const
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
	SingleGrainSizeDistribution ()
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
using	ItemType

Private Attributes
double	_size

Friends
class	ItemRegistry

Detailed Description

SingleGrainSizeDistribution represents a grain size distribution approximating a delta function at some specific grain size. The single grain size is configured through an attribute managed by this class. The amin() and amax() functions in this class return a very narrow range of width \(\Delta a=a_\text{s}/1000\) centered on the specified size \(a_\text{s}\), and the function dnda() returns a constant distribution function value (arbitrarily scaled).

Constructor & Destructor Documentation

SingleGrainSizeDistribution()

SingleGrainSizeDistribution::SingleGrainSizeDistribution ( )

inlineprotected

Default constructor for concrete Item subclass SingleGrainSizeDistribution: "a single-size dust grain size distribution".

Member Function Documentation

amax()

double SingleGrainSizeDistribution::amax ( ) const

overridevirtual

This function returns the maximum grain size \(a_\text{max} = a_\text{s} + \frac{1}{2}\Delta a\) with \(\Delta a=a_\text{s}/1000\).

Implements GrainSizeDistribution.

amin()

double SingleGrainSizeDistribution::amin ( ) const

overridevirtual

This function returns the minimum grain size \(a_\text{min} = a_\text{s} - \frac{1}{2}\Delta a\) with \(\Delta a=a_\text{s}/1000\).

Implements GrainSizeDistribution.

dnda()

double SingleGrainSizeDistribution::dnda ( double a ) const

overridevirtual

This function returns the constant value distribution function value, arbitrarily set to one.

Implements GrainSizeDistribution.

size()

double SingleGrainSizeDistribution::size ( ) const

inline

This function returns the value of the discoverable double property size: "the single grain size for this 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:

• SingleGrainSizeDistribution.hpp