FileGrainSizeDistribution Class Reference

#include <FileGrainSizeDistribution.hpp>

Inheritance diagram for FileGrainSizeDistribution:

Public Member Functions
double	amax () const override
double	amin () const override
double	dnda (double a) const override
string	filename () 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
	FileGrainSizeDistribution ()
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 = FileGrainSizeDistribution

Private Attributes
Array	_av
Array	_dndav
string	_filename

Friends
class	ItemRegistry

Detailed Description

FileGrainSizeDistribution represents a grain size distribution that is loaded from a text column input file. The floating point numbers in the first two columns of the text file specify respectively the grain size \(a\) and the corresponding size distribution value \(\text{dnda} \propto \frac{\text{d}n_\text{D}}{\text{d}a}\). Where needed, the tabulated values loaded from the file are interpolated logarithmically on both axes. Outside of the specified grain size range, the size distribution value is considered to be zero.

The grain sizes \(a\) are by default given in micron and must be listed in increasing order. The \(\text{dnda}(a)\) values have untis of inverse length and are by default given in 1/micron. These units can be overridden by column header info in the file. 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

FileGrainSizeDistribution()

FileGrainSizeDistribution::FileGrainSizeDistribution ( )

inlineprotected

Default constructor for concrete Item subclass FileGrainSizeDistribution : "a dust grain size distribution loaded from a text file" .

Member Function Documentation

amax()

double FileGrainSizeDistribution::amax ( ) const

overridevirtual

This function returns the maximum grain size \(a_\text{max}\), i.e. the last grain size in the table loaded from file.

Implements GrainSizeDistribution.

amin()

double FileGrainSizeDistribution::amin ( ) const

overridevirtual

This function returns the minimum grain size \(a_\text{min}\), i.e. the first grain size in the table loaded from file.

Implements GrainSizeDistribution.

dnda()

double FileGrainSizeDistribution::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 table loaded from file. If \(a<a_\text{min}\) or \(a>a_\text{max}\) the function returns zero.

Implements GrainSizeDistribution.

filename()

string FileGrainSizeDistribution::filename ( ) const

inline

This function returns the value of the discoverable string property filename : "the name of the file with the dust grain size distribution" .

setupSelfBefore()

void FileGrainSizeDistribution::setupSelfBefore ( )

overrideprotectedvirtual

This function loads the input file as described in the class header.

Reimplemented from SimulationItem.

---

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

• FileGrainSizeDistribution.hpp