AtPositionsForm Class Reference

#include <AtPositionsForm.hpp>

Inheritance diagram for AtPositionsForm:

Public Member Functions
string	filename () const
string	useColumns () const
void	writeQuantity (const ProbeFormBridge *bridge) const override
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
	AtPositionsForm ()
Protected Member Functions inherited from GenericForm
	GenericForm ()
Protected Member Functions inherited from Form
	Form ()
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
string	_filename
string	_useColumns

Friends
class	ItemRegistry

Detailed Description

AtPositionsForm represents a generic probe form. Refer to the ProbeFormBridge class for more information about probes and forms.

This particular form outputs a text column file listing the quantity being probed at the positions listed in a user-provided input file. This allows, for example, probing at the positions in a Particle or VoronoiMesh import file used for defining sources or media by configuring this probe with the same import file (any columns other than the position coordinates will be ignored).

The input text column file is expected to have three columns, respectively representing the x, y and z coordinates of a position in the spatial domain of the simulation. In case the input file has no unit specifications, the default units are parsec. Refer to the description of the TextInFile class for more information on overall formatting, on how to include header lines specifying the units for each column, and on how to use the useColumns property to address columns other than the first three.

The output file contains a line for each (non-empty and non-comment) line in the input file, in the same order. The first three columns repeat the x, y and z coordinates of the position (in the configured output units, which may differ from the input units). Subsequent column(s) list the quantity being probed.

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

AtPositionsForm()

AtPositionsForm::AtPositionsForm ( )

inlineprotected

Default constructor for concrete Item subclass AtPositionsForm: "a text column file with values for each imported position".

Member Function Documentation

filename()

string AtPositionsForm::filename ( ) const

inline

This function returns the value of the discoverable string property filename: "the name of the file listing the positions".

useColumns()

string AtPositionsForm::useColumns ( ) const

inline

This function returns the value of the discoverable string property useColumns: "a list of names corresponding to columns in the file to be imported".

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

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

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

writeQuantity()

void AtPositionsForm::writeQuantity ( const ProbeFormBridge * bridge ) const

overridevirtual

This function causes the form to output file(s) as described in the class header for the quantity being probed according to the information provided by the specified ProbeFormBridge instance.

Implements Form.

---

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

• AtPositionsForm.hpp