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

#include <Mesh.hpp>

Inheritance diagram for Mesh:
Inheritance graph
[legend]

Public Member Functions

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

 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 = SimulationItem
 
using ItemType = Mesh
 

Private Attributes

int _numBins
 

Friends

class ItemRegistry
 

Detailed Description

The Mesh class is an abstract base class that characterizes different types of one-dimensional meshes over the unit interval \([0,1]\). A mesh is essentially a partition of this interval into a number of \(N\) finite bins. Internally, a mesh consists of an ordered array of \(N+1\) mesh points \(\{t_i\}\), with \(t_0=0\) and \(t_N=1\). The different subclasses of the Mesh class indicate different mesh point distributions, such as linear distributions, etc.

Constructor & Destructor Documentation

◆ Mesh()

Mesh::Mesh ( )
inlineprotected

Default constructor for abstract Item subclass Mesh : "a mesh" .

Member Function Documentation

◆ mesh()

virtual Array Mesh::mesh ( ) const
pure virtual

This pure virtual function returns an array containing the \(N+1\) mesh points \(\{t_i\}\) in ascending order, with \(t_0=0\) and \(t_N=1\).

Implemented in LinMesh, LogMesh, PowMesh, SymPowMesh, and TabulatedMesh.

◆ numBins()

Mesh::numBins ( ) const
inline

This function returns the value of the discoverable integer property numBins : "the number of bins in the mesh" .

The minimum value for this property is "1" .

The maximum value for this property is "100000" .

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

◆ setNumBins()

void Mesh::setNumBins ( int  value)
protected

Sets the number of bins in the mesh. Can be used by subclasses that wish to override the number of bins configured by the corresponding property in this base class.


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