 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <HollowRadialVectorField.hpp>
Public Member Functions | |
| int | dimension () const override |
| double | exponent () const |
| Vec | vector (Position bfr) const override |
| double | zeroRadius () 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 Item * | getItemProperty (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) |
| Item & | operator= (const Item &)=delete |
| Item * | parent () 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 | |
| HollowRadialVectorField () | |
| Protected Member Functions inherited from VectorField | |
| VectorField () | |
| 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 |
| using | ItemType |
Private Attributes | |
| double | _exponent |
| double | _zeroRadius |
Friends | |
| class | ItemRegistry |
HollowRadialVectorField represents a vector field with vectors pointing away from the origin and with a magnitude that varies with radial distance from the origin. The vector magnitudes increase from zero at a given radius to unity at infinity. Within the given radius, all vector magnitudes are zero, creating a magnitude cavity to which this class owes its name.
The class has two configuration properties: the distance \(r_0\ge 0\) at which the vector magnitude starts increasing and a power law exponent \(\alpha\ge 0\). Both properties must be non-negative. Given these properties, the magnitude \(v(r)\) of the vectors as a function of radial distance \(r\) is given by
\[ v(r) = \begin{cases} 0 & \mathrm{for}\;r\le r_0 \\ \left(1-\frac{r_0}{r}\right)^\alpha & \mathrm{for}\;r>r_0 \end{cases} \]
With the default value of \(r_0=0\), there is no central cavity. The default value of \(\alpha=0\) specifies a step function from zero to unity at \(r=r_0\).
This radial magnitude dependence is inspired by Braibant et al. 2017 (A&A, 607, A32) and Murray et al. 1995 (ApJ, 451, 498). It is intended to serve as a velocity field for model geometries that have no mass within a given radius, such as the dusty torus of an active galactic nucleus.
When an item of this type is used, the names provided by the conditional value expression "Dimension3" are inserted into the name sets used for evaluating Boolean expressions.
|
inlineprotected |
Default constructor for concrete Item subclass HollowRadialVectorField: "a vector field pointing away from the origin with a central cavity".
|
overridevirtual |
This function returns the dimension of the vector field, which is 3 for this class, indicating no symmetries (the vectors point in a different direction at each position).
Implements VectorField.
|
inline |
This function returns the value of the discoverable double property exponent: "the power-law exponent governing the radial dependence of the magnitude".
The minimum value for this property is "[0".
The default value for this property is given by the conditional value expression "0".
This function returns a vector pointing away from the origin at the given position \(\bf{r}\) according to the definitions given in the class header.
Implements VectorField.
|
inline |
This function returns the value of the discoverable double property zeroRadius: "the radius within which the magnitude of the vectors is zero".
This property represents a physical quantity of type "length".
The minimum value for this property is "[0".
The default value for this property is given by the conditional value expression "0".