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

#include <SphericalClipGeometryDecorator.hpp>

Inheritance diagram for SphericalClipGeometryDecorator:
Inheritance graph
[legend]

Public Member Functions

double centerX () const
 
double centerY () const
 
double centerZ () const
 
double clipRadius () const
 
int dimension () const override
 
bool inside (Position bfr) const override
 
- Public Member Functions inherited from ClipGeometryDecorator
double density (Position bfr) const override
 
Position generatePosition () const override
 
Geometrygeometry () const
 
Remove remove () const
 
double SigmaX () const override
 
double SigmaY () const override
 
double SigmaZ () const override
 
virtual double density (Position bfr) const =0
 
virtual int dimension () const =0
 
virtual Position generatePosition () const =0
 
virtual double SigmaX () const =0
 
virtual double SigmaY () const =0
 
virtual double SigmaZ () const =0
 
- 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

 SphericalClipGeometryDecorator ()
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from ClipGeometryDecorator
 ClipGeometryDecorator ()
 
virtual bool inside (Position bfr) const =0
 
double norm () const
 
void setupSelfAfter () override
 
- Protected Member Functions inherited from Geometry
 Geometry ()
 
Randomrandom () const
 
void setupSelfBefore () override
 
- 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 = ClipGeometryDecorator
 
using ItemType = SphericalClipGeometryDecorator
 

Private Attributes

Position _center
 
double _centerX
 
double _centerY
 
double _centerZ
 
double _clipRadius
 
double _clipRadiusSquared
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Public Types inherited from ClipGeometryDecorator
enum class  Remove : int { Inside , Outside }
 

Detailed Description

The SphericalClipGeometryDecorator class is a decorator that adjusts another geometry by setting the density equal to zero inside or outside a sphere with given position and radius. The dimension of the geometry implemented by a SphericalClipGeometryDecorator object depends on the symmetries of the geometry being decorated and on the position of the clipping sphere.

Constructor & Destructor Documentation

◆ SphericalClipGeometryDecorator()

SphericalClipGeometryDecorator::SphericalClipGeometryDecorator ( )
inlineprotected

Default constructor for concrete Item subclass SphericalClipGeometryDecorator : "a decorator that clips another geometry using a sphere" .

Member Function Documentation

◆ centerX()

SphericalClipGeometryDecorator::centerX ( ) const
inline

This function returns the value of the discoverable double property centerX : "the x coordinate of the sphere's center" .

This property represents a physical quantity of type "length" .

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

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

When a value is entered for this property, the names provided by the conditional value expression "centerX:Dimension3" are inserted into the name sets used for evaluating Boolean expressions.

◆ centerY()

SphericalClipGeometryDecorator::centerY ( ) const
inline

This function returns the value of the discoverable double property centerY : "the y coordinate of the sphere's center" .

This property represents a physical quantity of type "length" .

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

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

When a value is entered for this property, the names provided by the conditional value expression "centerY:Dimension3" are inserted into the name sets used for evaluating Boolean expressions.

◆ centerZ()

SphericalClipGeometryDecorator::centerZ ( ) const
inline

This function returns the value of the discoverable double property centerZ : "the z coordinate of the sphere's center" .

This property represents a physical quantity of type "length" .

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

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

When a value is entered for this property, the names provided by the conditional value expression "centerZ:Dimension2" are inserted into the name sets used for evaluating Boolean expressions.

◆ clipRadius()

SphericalClipGeometryDecorator::clipRadius ( ) const
inline

This function returns the value of the discoverable double property clipRadius : "the radius of the clipping sphere" .

This property represents a physical quantity of type "length" .

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

◆ dimension()

int SphericalClipGeometryDecorator::dimension ( ) const
overridevirtual

This function returns the dimension of the geometry, which is the larger of two dimensions: the dimension of the geometry being decorated and the dimension of the clipping sphere. The dimension of the clipping sphere is 1 if its center is at the origin, 2 if the center is on the Z-axis, and 3 if the center is elsewhere.

Implements Geometry.

◆ inside()

bool SphericalClipGeometryDecorator::inside ( Position  bfr) const
overridevirtual

This function returns true if the specified position is inside the sphere defined by the properties of this class.

Implements ClipGeometryDecorator.

◆ setupSelfBefore()

void SphericalClipGeometryDecorator::setupSelfBefore ( )
overrideprotectedvirtual

This function calculates some frequently used values.

Reimplemented from Geometry.


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