ClearDensityRecipe Class Reference

#include <ClearDensityRecipe.hpp>

Inheritance diagram for ClearDensityRecipe:

Public Member Functions
void	beginUpdate (int numCells) override
double	fieldStrengthThreshold () const
UpdateStatus	update (MaterialState *state, const Array &Jv) override
Public Member Functions inherited from DynamicStateRecipe
virtual void	beginUpdate (int numCells)=0
virtual bool	endUpdate (int numCells, int numUpdated, int numNotConverged)
int	maxNotConvergedCells () const
virtual UpdateStatus	update (MaterialState *state, const Array &Jv)=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
	ClearDensityRecipe ()
Protected Member Functions inherited from DynamicStateRecipe
	DynamicStateRecipe ()
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 = DynamicStateRecipe
using	ItemType = ClearDensityRecipe

Private Attributes
Array	_dlambdav
double	_fieldStrengthThreshold

Friends
class	ItemRegistry

Detailed Description

ClearDensityRecipe is a dynamic medium state recipe mainly intended for testing purposes. The recipe sets the density to zero for all medium components in all spatial cells where the radiation field strength $U$ exceeds a given threshold value $U_{\mathrm{c}\mathrm{u}\mathrm{t}}$ configured by the user. The recipe converges when no additional cells have been cleared after an iteration.

The radiation field strength $U$ in this recipe is defined as

$$U=\frac{{\int }_0^{\mathrm{\infty }}{J}_{\lambda }\text{d}\lambda }{{\int }_0^{\mathrm{\infty }}{J}_{\lambda }^{\text{MW}}\text{d}\lambda },$$

where $J_{\lambda }^{\text{MW}}$ is the local interstellar radiation field in the Milky Way according to Mathis et al. (1983).

Constructor & Destructor Documentation

ClearDensityRecipe()

ClearDensityRecipe::ClearDensityRecipe ( )

inlineprotected

Default constructor for concrete Item subclass ClearDensityRecipe : "a recipe that clears material in cells above a given radiation field strength" .

Member Function Documentation

beginUpdate()

void ClearDensityRecipe::beginUpdate ( int  numCells )

overridevirtual

This function is called before an update cycle begins. It caches the radiation field wavelength grid.

Implements DynamicStateRecipe.

fieldStrengthThreshold()

ClearDensityRecipe::fieldStrengthThreshold ( ) const

inline

This function returns the value of the discoverable double property fieldStrengthThreshold : "the field strength above which material is cleared from a cell" .

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

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

update()

UpdateStatus ClearDensityRecipe::update ( MaterialState *  state, const Array &  Jv  )

overridevirtual

This function is called repeatedly as part of the update cycle. If the density of the medium component in the cell under study is nonzero, it calculates the strength of the radiation field. If this value exceeds the configured threshold, the density is set to zero. The function returns UpdatedNotConverged if the density has been updated and NotUpdated otherwise.

Implements DynamicStateRecipe.

---

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

• ClearDensityRecipe.hpp