SymPowMesh Class Reference

#include <SymPowMesh.hpp>

Inheritance diagram for SymPowMesh:

Public Member Functions
Array	mesh () const override
double	ratio () const
Public Member Functions inherited from Mesh
int	numBins () 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
	SymPowMesh ()
Protected Member Functions inherited from Mesh
	Mesh ()
void	setNumBins (int value)
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	_ratio

Friends
class	ItemRegistry

Detailed Description

The SymPowMesh class represents a mesh on the unit interval \([0,1]\) with a symmetric power-law distribution of the mesh points. This distribution is such that the bin sizes form a geometric series, starting from the innermost bin and moving outwards symmetrically. If the number of bins is odd, there is one innermost bin; if it is even, there are two equal-size innermost bins. The actual distribution is characterized by a single parameter: the bin width ratio between the outermost and the innermost bins. This ratio can be larger than one (in which case the bin size increases when moving outwards) or smaller than one (in which case the bin size decrease from the centre to the edge of the interval). If the mesh has only one bin, this bin spans the complete interval \([0,1]\). If the mesh has two bins, each bin spans exactly half of the interval \([0,1]\).

Constructor & Destructor Documentation

SymPowMesh()

SymPowMesh::SymPowMesh ( )

inlineprotected

Default constructor for concrete Item subclass SymPowMesh: "a symmetric power-law mesh".

Member Function Documentation

mesh()

Array SymPowMesh::mesh ( ) const

overridevirtual

This function returns an array containing the mesh points.

Implements Mesh.

ratio()

double SymPowMesh::ratio ( ) const

inline

This function returns the value of the discoverable double property ratio: "the bin width ratio between the outermost and the innermost bins".

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

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

---

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

• SymPowMesh.hpp