MagneticFieldProbe Class Reference

#include <MagneticFieldProbe.hpp>

Inheritance diagram for MagneticFieldProbe:

Public Member Functions
void	probe () override
Public Member Functions inherited from SpatialGridFormProbe
Form *	form () const
Public Member Functions inherited from Probe
string	itemName () const override
int	iter () const
string	probeName () const
void	probePrimary (int iter)
void	probeRun ()
void	probeSecondary (int iter)
void	probeSetup ()
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
	MagneticFieldProbe ()
Protected Member Functions inherited from SpatialGridFormProbe
	SpatialGridFormProbe ()
Protected Member Functions inherited from Probe
	Probe ()
virtual void	initialize ()
virtual void	probe ()=0
virtual When	when () const
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 = SpatialGridFormProbe
using	ItemType = MagneticFieldProbe

Friends
class	ItemRegistry

Additional Inherited Members
Protected Types inherited from Probe
enum class	When { Setup , Run , Primary , Secondary }

Detailed Description

MagneticFieldProbe probes the magnetic field associated with the medium as discretized on the spatial grid of the simulation. The probe can be used with any Form subclass. When associated with a form that projects the quantity along a path, the value is density-weighted.

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

Constructor & Destructor Documentation

MagneticFieldProbe()

MagneticFieldProbe::MagneticFieldProbe ( )

inlineprotected

Default constructor for concrete Item subclass MagneticFieldProbe : "internal spatial grid: magnetic field associated with the medium" .

Member Function Documentation

probe()

void MagneticFieldProbe::probe ( )

overridevirtual

This function performs probing.

Implements Probe.

---

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

• MagneticFieldProbe.hpp