PerCellForm Class Reference

#include <PerCellForm.hpp>

Inheritance diagram for PerCellForm:

Public Member Functions
void	writeQuantity (const ProbeFormBridge *bridge) const override
virtual void	writeQuantity (const ProbeFormBridge *bridge) 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 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
	PerCellForm ()
Protected Member Functions inherited from SpatialGridForm
	SpatialGridForm ()
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 = SpatialGridForm
using	ItemType = PerCellForm

Friends
class	ItemRegistry

Detailed Description

PerCellForm represents a spatial grid-specific 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 for each cell in the spatial grid of the simulation. Specifically, the output file contains a line for each cell in the spatial grid of the simulation. The first column always specifies the cell index, and subsequent column(s) list the quantity being probed.

Constructor & Destructor Documentation

PerCellForm()

PerCellForm::PerCellForm ( )

inlineprotected

Default constructor for concrete Item subclass PerCellForm : "a text column file with values for each spatial cell" .

Member Function Documentation

writeQuantity()

void PerCellForm::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:

• PerCellForm.hpp