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

#include <TabulatedMesh.hpp>

Inheritance diagram for TabulatedMesh:
Inheritance graph
[legend]

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 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

 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 = MoveableMesh
 
using ItemType = TabulatedMesh
 

Private Attributes

Array _mesh
 

Friends

class ItemRegistry
 

Detailed Description

TabulatedMesh is an abstract class for representing a one-dimensional mesh over the unit interval [0,1] with mesh points that are tabulated by the user. The numBins property of the Mesh base class is overridden to match the number of bins in the table defined by the user.

The subclass must load the tabulated data, and this abstract class handles everything else.

The loaded table contains the mesh points (i.e. the border points separating the mesh bins), in arbitrary order. The points may be given 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 table is mapped to unity.

This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ TabulatedMesh()

TabulatedMesh::TabulatedMesh ( )
inlineprotected

Default constructor for abstract Item subclass TabulatedMesh : "a mesh tabulated by the user" .

Member Function Documentation

◆ getMeshBorderPoints()

virtual vector< double > TabulatedMesh::getMeshBorderPoints ( ) const
protectedpure virtual

This function must be implemented in each subclass to return the mesh border points, in arbitrary order and with arbitrary scaling.

Implemented in FileMesh, and ListMesh.

◆ mesh()

Array TabulatedMesh::mesh ( ) const
overridevirtual

This function returns an array containing the mesh points.

Implements Mesh.

◆ setupSelfBefore()

void TabulatedMesh::setupSelfBefore ( )
overrideprotectedvirtual

This function asks the subclass to load the mesh border points and precalculates the final mesh, sorting and scaling the values as described in the class header.

Reimplemented from SimulationItem.


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