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

#include <FileMesh.hpp>

Inheritance diagram for FileMesh:
Inheritance graph
[legend]

Public Member Functions

string filename () 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 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

 FileMesh ()
 
- 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 = FileMesh
 

Private Member Functions

vector< double > getMeshBorderPoints () const override
 

Private Attributes

string _filename
 

Friends

class ItemRegistry
 

Detailed Description

FileMesh is a subclass of the MoveableMesh class. It represents a one-dimensional mesh over the unit interval [0,1] with mesh points that are read from a file. The numBins property of the Mesh base class is overridden to match the number of bins defined by the file.

The input text file contains the mesh points (i.e. the border points separating the mesh bins), one point per line, 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 file is mapped to unity.

Constructor & Destructor Documentation

◆ FileMesh()

FileMesh::FileMesh ( )
inlineprotected

Default constructor for concrete Item subclass FileMesh : "a mesh read from a file" .

Member Function Documentation

◆ filename()

string FileMesh::filename ( ) const
inline

This function returns the value of the discoverable string property filename : "the name of the file with the mesh border points" .

◆ getMeshBorderPoints()

vector< double > FileMesh::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.


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