The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
PowMesh Class Reference

#include <PowMesh.hpp>

Inheritance diagram for PowMesh:
Inheritance graph
[legend]

Public Member Functions

Array mesh () const override
 
double ratio () const
 
- 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 ItemgetItemProperty (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)
 
Itemoperator= (const Item &)=delete
 
Itemparent () 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

 PowMesh ()
 
- 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 = MoveableMesh
 
using ItemType = PowMesh
 

Private Attributes

double _ratio
 

Friends

class ItemRegistry
 

Detailed Description

The PowMesh class represents meshes on the unit interval \([0,1]\) with a power-law distribution of the mesh points. This distribution is such that the bin sizes form a geometric series, i.e. each bin is a constant factor larger than the previous one. The actual distribution is characterized by a single parameter: the bin width ratio between the last and the first bin,

\[ {\cal{R}} = \frac{t_N-t_{N-1}}{t_1-t_0}.\]

This ratio can be larger than one (in which case the first bin is the smallest) or smaller than one (in which case the last bin is the smallest). If the mesh has only one bin, this single bin spans the complete interval \([0,1]\).

Constructor & Destructor Documentation

◆ PowMesh()

PowMesh::PowMesh ( )
inlineprotected

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

Member Function Documentation

◆ mesh()

Array PowMesh::mesh ( ) const
overridevirtual

This function returns an array containing the mesh points.

Implements Mesh.

◆ ratio()

PowMesh::ratio ( ) const
inline

This function returns the value of the discoverable double property ratio : "the bin width ratio between the last and the first bin" .

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: