ListMesh Class Reference

#include <ListMesh.hpp>

Inheritance diagram for ListMesh:

Public Member Functions
const vector< double > &	points () const
Public Member Functions inherited from TabulatedMesh
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
	ListMesh ()
Protected Member Functions inherited from TabulatedMesh
	TabulatedMesh ()
virtual vector< double >	getMeshBorderPoints () const =0
void	setupSelfBefore () override
Protected Member Functions inherited from MoveableMesh
	MoveableMesh ()
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 = TabulatedMesh
using	ItemType = ListMesh

Private Member Functions
vector< double >	getMeshBorderPoints () const override

Private Attributes
vector< double >	_points

Friends
class	ItemRegistry

Detailed Description

ListMesh is a subclass of the MoveableMesh class. It represents a one-dimensional mesh over the unit interval [0,1] with mesh points that are fully specified inside the configuration file (i.e. without referring to an input file). It is intended for use in cases where there are just a mesh border points, but nothing keeps the user from specifying a long list. The numBins property of the Mesh base class is overridden to match the number of bins defined by the user.

The configured list specifies the mesh points (i.e. the border points separating the mesh bins) in arbitrary order and in arbitary units. If the smallest point is not zero, an extra zero mesh point is inserted. The mesh is scaled so that the largest point in the list is mapped to unity.

Constructor & Destructor Documentation

ListMesh()

ListMesh::ListMesh ( )

inlineprotected

Default constructor for concrete Item subclass ListMesh : "a mesh specified inside the configuration file" .

Member Function Documentation

getMeshBorderPoints()

vector< double > ListMesh::getMeshBorderPoints ( ) const

overrideprivatevirtual

This function loads the mesh border points from the configured file and returns them, in arbitrary order and with arbitrary scaling.

Implements TabulatedMesh.

points()

ListMesh::points ( ) const

inline

This function returns the value of the discoverable double list property points : "the mesh border points" .

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

---

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

• ListMesh.hpp