UnidirectionalVectorField Class Reference

#include <UnidirectionalVectorField.hpp>

Inheritance diagram for UnidirectionalVectorField:

Public Member Functions
int	dimension () const override
double	fieldX () const
double	fieldY () const
double	fieldZ () const
Vec	vector (Position bfr) const override
virtual int	dimension () const =0
virtual Vec	vector (Position bfr) 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
	UnidirectionalVectorField ()
void	setupSelfBefore () override
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 = VectorField
using	ItemType = UnidirectionalVectorField

Private Attributes
Vec	_d
double	_fieldX
double	_fieldY
double	_fieldZ

Friends
class	ItemRegistry

Detailed Description

UnidirectionalVectorField represents a vector field with unit vectors that all point in the same direction. This direction is configured by the user; the components are automatically normalized to form a unit vector if needed.

Constructor & Destructor Documentation

UnidirectionalVectorField()

UnidirectionalVectorField::UnidirectionalVectorField ( )

inlineprotected

Default constructor for concrete Item subclass UnidirectionalVectorField : "a vector field uniformly pointing in a given direction" .

Member Function Documentation

dimension()

int UnidirectionalVectorField::dimension ( ) const

overridevirtual

This function returns the dimension of the vector field, which for this class is 2 if the configured direction is parallel to the z-axis (indicating axial symmetry), and 3 otherwise (no symmetry).

Implements VectorField.

fieldX()

UnidirectionalVectorField::fieldX ( ) const

inline

This function returns the value of the discoverable double property fieldX : "the field direction, x component" .

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

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

fieldY()

UnidirectionalVectorField::fieldY ( ) const

inline

This function returns the value of the discoverable double property fieldY : "the field direction, y component" .

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

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

fieldZ()

UnidirectionalVectorField::fieldZ ( ) const

inline

This function returns the value of the discoverable double property fieldZ : "the field direction, z component" .

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

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

setupSelfBefore()

void UnidirectionalVectorField::setupSelfBefore ( )

overrideprotectedvirtual

This function verifies that the configured direction is not the null vector, and it stores the normalized direction vector for later use.

Reimplemented from SimulationItem.

vector()

Vec UnidirectionalVectorField::vector ( Position  bfr ) const

overridevirtual

This function returns a unit vector corresponding to the direction configured by the user.

Implements VectorField.

---

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

• UnidirectionalVectorField.hpp