Fiber::FieldSelector Class Reference

An internal class that stores a couple of textual names. More...

#include <FieldSelector.hpp>

List of all members.

Public Types

• typedef std::pair
  < Fiber::Bundle::GridInfo_t,
  RefPtr< Fiber::Field > > FieldInfo_t

Public Member Functions

• FieldSelection & Selection ()

  Yield the currently selected fields.
  

• FieldSelector ()

  Constructor.
  

• FieldSelector (const GridSelector &GS, const Info< Grid > &FieldSource)

  Construct from grid selector and result of grid selection.
  

• FieldSelector (const FieldSelector &FS)

  Construct from an existing FieldSelector.
  

• FieldSelector (const BundlePtr &bpP, const double timeP, const string &gridNameP, const string &fieldNameP)
• FieldSelector (double &time, const BundlePtr &BP, const string &gridName, const string &fieldName)

  Construct a FieldSelector from the field found on the most recent Grid of the given bundle.
  

• ~FieldSelector ()

  Destructor.
  

• bool requires (const type_info &what) const

  Check if this field selector requires the field to be of the specified type.
  

• unsigned NumberOfAvailableFields () const

  Number of this fields provided here.
  

• TypeList_t & FieldTypes ()

  List of types that this field might provide or want.
  

• template<class T > void accept ()

  Define the types that this field accepts or provides.
  

• void selectField (const string &fieldname, const TypeList_t &FT=TypeList_t())

  Select a singular field.
  

• void selectField (const BundlePtr &BP, const double time, const string &gridName, const string &fieldName, const RefPtr< Grid > &G, const RefPtr< Slice > &S)

  Select a field with full context information.
  

• void clearSelection ()

  Remove all field selection stored here.
  

• RefPtr< Fiber::FieldID > createFieldID (Fiber::Representation &Rep) const
• bool setFieldSource (double time, const string &theFieldname)
• bool findFieldSource (double time, const string &Fieldname)

  Set the field information from the field found on the most recent Grid in the given bundle, as stored in the FieldSelector.
  

• bool findFieldSource (const BundlePtr &bpP, double timeP, const string &gridNameP, const string &fieldNameP)

  Set the field information from the field found on the most recent Grid in the given bundle.
  

• string getFieldName () const

  Return the name of the currently selected field.
  

• string getFieldname () const

  Return the name of the currently selected field.
  

• string operator() () const

  Return the currently selected field name.
  

• const RefPtr< Fiber::Grid > & GridSource () const

  The Grid object that was found to carry the selected field.
  

• const RefPtr< Fiber::Grid > & getGrid () const

  The Grid object that was found to carry the selected field.
  

• const RefPtr< Fiber::Slice > & getSlice () const

  Get the slice where the field selector refers to.
  

• double getTime () const

  The time when this field was found most recently.
  

• RefPtr< Field > getField (const string &theName) const

  Return a field of the given name in the Cartesian representation of the Vertices on the toplevel refinement level.
  

• RefPtr< Fiber::Field > getField () const

  Return a field of the currently selected in the Cartesian representation of the Vertices on the toplevel refinement level.
  

• RefPtr< Field > getCartesianPositions () const

  Return the position field on the Grid which carries the current field.
  

• RefPtr< Representation > getCartesianRepresentation () const

  Return the cartesian representation of the vertices that carries the current field.
  

Public Attributes

• Info< Grid > FieldSource

  Meta-Information - from where did we get the selected field? The base class, GridSelector, specifies information on how to find a certain Grid.
  

Friends

• BUNDLE_API bool operator== (const FieldSelector &L, const FieldSelector &R)

  Compare two field selectors.
  

• bool operator!= (const FieldSelector &L, const FieldSelector &R)

  Check if two field selectors differ.
  

---

Detailed Description

An internal class that stores a couple of textual names.

It is to be used for selecting a field out of a selection of fields.

Examples:

ColoredLines.cpp, PolychromeSurface.cpp, Sphere.cpp, and TransparentColoredSurface.cpp.

---

Constructor & Destructor Documentation

Fiber::FieldSelector::FieldSelector

(

const FieldSelector &

FS

)

Construct from an existing FieldSelector.

Note that the FieldSelection will be empty, not copied from the existing FieldSelector!

Fiber::FieldSelector::FieldSelector	(	double &	time,
		const BundlePtr &	BP,
		const string &	gridName,
		const string &	fieldName
	)

Construct a FieldSelector from the field found on the most recent Grid of the given bundle.

The respective time will be provided in the time argument.

---

Member Function Documentation

template<class T >

void Fiber::FieldSelector::accept

(

)

[inline]

Define the types that this field accepts or provides.

           FieldSelector F;
                F.accept<float>();
                F.accept<double>();

Referenced by Wizt::Fish< Fiber::Field >::acceptType(), Wizt::TypedSlot< Fiber::Field >::acceptType(), Wizt::FieldFunctor< Operation >::FieldOperation(), and Wizt::VOutput< Fiber::Field >::provides().

RefPtr< Field > Fiber::FieldSelector::getField

(

const string &

theName

)

const

Return a field of the given name in the Cartesian representation of the Vertices on the toplevel refinement level.

This general function is useful to retrieve a field on the current grid which is not identical with the selected one.

Referenced by Wizt::Fish< Fiber::Field >::getField(), and VectorArrows::update().

const RefPtr<Fiber::Grid>& Fiber::FieldSelector::getGrid

(

)

const [inline]

The Grid object that was found to carry the selected field.

Note that there is no requirement to query fields from just that grid where the field was found. It can as well be queried on another Grid as well, just then it's not ensured that such a field would exist there.

Referenced by Vector4ToVector3AndScalar::update().

const RefPtr<Fiber::Grid>& Fiber::FieldSelector::GridSource

(

)

const [inline]

The Grid object that was found to carry the selected field.

Note that there is no requirement to query fields from just that grid where the field was found. It can as well be queried on another Grid as well, just then it's not ensured that such a field would exist there.

Referenced by VectorArrows::update().

bool Fiber::FieldSelector::requires

(

const type_info &

what

)

const [inline]

Check if this field selector requires the field to be of the specified type.

Note that if no field selection has been specified, then all types will be "required" and this function returns true.

void Fiber::FieldSelector::selectField	(	const BundlePtr &	BP,
		const double	time,
		const string &	gridName,
		const string &	fieldName,
		const RefPtr< Grid > &	G,
		const RefPtr< Slice > &	S
	)			[inline]

Select a field with full context information.

Only property that is left to set is the accepted types, to be set with accept().

void Fiber::FieldSelector::selectField	(	const string &	fieldname,
		const TypeList_t &	FT = TypeList_t()
	)

Select a singular field.

Removes all others field, only one will remain here. More control and adding multiple fields requires using the SelectedFields() member function.

Examples:

Sphere.cpp.

Referenced by LinearRescale::FieldOperation(), and Wizt::FieldFunctor< Operation >::FieldOperation().

---

Member Data Documentation

Info<Grid> Fiber::FieldSelector::FieldSource

Meta-Information - from where did we get the selected field? The base class, GridSelector, specifies information on how to find a certain Grid.

The FieldSource now actually provides the result of such a search process, and tells concretely which Grid has been found using the parameters of the base class, the Grid Selector.

Referenced by Wizt::FieldObject::update().