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

#include <LogMesh.hpp>

Inheritance diagram for LogMesh:
Inheritance graph
[legend]

Public Member Functions

double centralBinFraction () const
 
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

 LogMesh ()
 
- Protected Member Functions inherited from AnchoredMesh
 AnchoredMesh ()
 
- 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 = AnchoredMesh
 
using ItemType = LogMesh
 

Private Attributes

double _centralBinFraction
 

Friends

class ItemRegistry
 

Detailed Description

The LogMesh class represents origin-anchored, logarithmic meshes. Specifically, the first bin covers the interval \([0,t_\text{c}]\) and the widths of the remaining bins are distributed logarithmically over the interval \([t_\text{c},1]\), where \(t_\text{c}\) is a user-configurable parameter. If the mesh has only one bin, the value of \(t_\text{c}\) is ignored and the single bin spans the complete interval \([0,1]\).

Constructor & Destructor Documentation

◆ LogMesh()

LogMesh::LogMesh ( )
inlineprotected

Default constructor for concrete Item subclass LogMesh : "a logarithmic mesh" .

Member Function Documentation

◆ centralBinFraction()

LogMesh::centralBinFraction ( ) const
inline

This function returns the value of the discoverable double property centralBinFraction : "the central bin width fraction" .

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

The maximum value for this property is "1[" .

The default value for this property is given by the conditional value expression "1e-3" .

◆ mesh()

Array LogMesh::mesh ( ) const
overridevirtual

This function returns an array containing the mesh points.

Implements Mesh.


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