SymCosMesh Class Reference

#include <SymCosMesh.hpp>

Inheritance diagram for SymCosMesh:

Public Member Functions
Array	mesh () const override
Public Member Functions inherited from Mesh
virtual Array	mesh () const =0
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
	SymCosMesh ()
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 = Mesh
using	ItemType = SymCosMesh

Friends
class	ItemRegistry

Detailed Description

The SymCosMesh class represents a symmetric cosine mesh. The mesh points are spaced such that when the mesh is used to subdivide a spherical volume into conical slices by polar inclination angle \(0 \le \theta \le \pi\), the resulting slices have equal volume. Specifically, the mesh is contructed as follows:

• construct an equidistant linear mesh over the (inverted) interval \([1,-1]\) with the requested number of bins;
• replace each mesh point by the arc-cosine of its value, resulting in a mesh with the intended spacing over the interval \([0,\pi]\);
• divide each mesh point by \(\pi\), rescaling the mesh to the unit interval \([0,1]\).

The scaling in the latter step is required to conform to the standards for all Mesh classes. When the mesh is actually used to discretize an inclination angle, it will be scaled back to the range \([0,\pi]\).

Constructor & Destructor Documentation

SymCosMesh()

SymCosMesh::SymCosMesh ( )

inlineprotected

Default constructor for concrete Item subclass SymCosMesh : "a symmetric cosine mesh" .

Member Function Documentation

mesh()

Array SymCosMesh::mesh ( ) const

overridevirtual

This function returns an array containing the mesh points.

Implements Mesh.

---

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

• SymCosMesh.hpp